eliasis-framework/complement

PHP library for adding addition of complements for Eliasis Framework.

1.1.1 2018-03-11 15:13 UTC

Requires

• php: ^5.6 || ^7.0
• eliasis-framework/eliasis: ^1.1.2
• josantonius/file: ^1.1.7
• josantonius/hook: ^1.1.0
• josantonius/json: ^1.1.7

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.3 || ^2.8
• josantonius/router: ^1.0.9
• phpmd/phpmd: ^2.6
• phpunit/phpunit: ^5.7 || ^6.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Josantonius

• framework
• php
• plugin
• module
• hmvc
• component
• Eliasis
• Module Handler
• Tenplate

README

Versión en español

• Requirements
• Installation
• Documentation
• Tests
• TODO
• Contribute
• License
• Copyright

Requirements

This framework is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

You can install Eliasis PHP Framework into your project using Composer. If you're starting a new project, we recommend using the basic app as a starting point. For existing applications you can run the following:

$ composer require eliasis-framework/complement

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require eliasis-framework/complement --prefer-source

Documentation

Documentation and examples of use.

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/eliasis-framework/complement.git

$ cd complement

$ bash bin/install-wp-tests.sh wordpress_test root '' localhost latest

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

☑ TODO

• Add new feature.
• Add tests for Vue.
• Improve PHP tests.
• Improve documentation.
• Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.
• Add documentation for component-load action hook.
• Add documentation for module-load action hook.
• Add documentation for plugin-load action hook.
• Add documentation for template-load action hook.
• Add documentation for after-loading-{complement_name}-{complement_type} action hook.
• Add documentation for the different types supported by Eliasis Complement and compatible with Composer Installers.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

• Fork and clone.
• Run the command composer install to install the dependencies. This will also install the dev dependencies.
• Run the command composer fix to excute code standard fixers.
• Run the tests.
• Create a branch, commit, push and send me a pull request.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 - 2018 Josantonius, josantonius.com

If you find it useful, let me know 😉

You can contact me on Twitter or through my email.