traderinteractive / filter-bools
A collection of boolean filters.
Installs: 79 896
Dependents: 2
Suggesters: 0
Security: 0
Stars: 1
Watchers: 8
Forks: 1
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- traderinteractive/exceptions: ^2.0
Requires (Dev)
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.2
This package is auto-updated.
Last update: 2024-10-27 17:53:56 UTC
README
A filtering implementation for verifying correct data and performing typical modifications to data.
Requirements
Requires PHP 7.0 or newer and uses composer to install further PHP dependencies. See the composer specification for more details.
Composer
To add the library as a local, per-project dependency use Composer! Simply add a dependency on
traderinteractive/filter-bools
to your project's composer.json
file such as:
composer require traderinteractive/filter-bools
Functionality
Booleans::filter
This filter verifies that the argument is a boolean value or a string that maps to one. The second parameter
can be set to true
to allow null values through without an error (they will stay null and not get converted to false). The last parameters
are lists of strings for true values and false values. By default, the strings "true" and "false" map to their boolean counterparts.
The following example converts $value
to a boolean allowing the strings "on" and "of".
$enabled = \TraderInteractive\Filter\Booleans::filter($value, false, ['on'], ['off']);
Booleans::convert
This filter will convert a given boolean value into the provided true or false conditions. By default the return values are the strings 'true' and 'false'
The following converts the boolean $value
to either 'yes' or 'no'
$answer = \TraderInteractive\Filter\Booleans::convert($value, 'yes', 'no');
Contact
Developers may be contacted at:
Project Build
With a checkout of the code get Composer in your PATH and run:
composer install ./vendor/bin/phpcs ./vendor/bin/phpunit
For more information on our build process, read through out our Contribution Guidelines.