Download the PHP package locomotivemtl/charcoal-contrib-property-filter without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-property-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-property-filter
More information about locomotivemtl/charcoal-contrib-property-filter
Files in locomotivemtl/charcoal-contrib-property-filter
Package charcoal-contrib-property-filter
Short Description Charcoal service provider for a collection filtering widget that uses model properties as filters.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-property-filter/
Informations about the package charcoal-contrib-property-filter
Charcoal PropertyFilter
A Charcoal service provider my cool feature.
Table of Contents
- Installation
- Dependencies
- Configuration
- Usage
- Options
- Development
- Assets
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
- PHP 5.6+: PHP 7 is recommended.
- charcoal-admin ^0.14.2.
Configuration
Include the property-filter module in the projects's config file. This will provide everything needed for charcoal-contrib-property-filter to work properly. No need for metadata/views/action/routes path etc.
Usage
charcoal-contrib-property-filter can be used as a dashboard widget to filter all the filterable widgets included in the template. Define a structure like this one :point_down: in a dashboard widget to create filters.
Options
Key | Values | Default | Description |
---|---|---|---|
properties |
Array | n/a | Defines which of the model's properties to use as filters. |
properties_options |
Array | n/a | Defines property customizations for the filter inputs |
layout |
Array | n/a | Arrange the filters in a layout using structures |
Development
To install the development environment:
To run the scripts (phplint, phpcs, and phpunit):
Assets
To install assets build environment:
To run the build scripts:
or
API Documentation
- The auto-generated
phpDocumentor
API documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-property-filter/docs/master/ - The auto-generated
apigen
API documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-property-filter/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-property-filter module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs
. An auto-fixer is also available withcomposer phpcbf
.
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details.