traderinteractive/filter-ints

A filtering implementation for verifying correct data and performing typical modifications to data

v4.0.0 2022-09-27 13:09 UTC

This package is auto-updated.

Last update: 2024-10-21 15:06:45 UTC


README

Build Status Scrutinizer Code Quality Coverage Status

Latest Stable Version Latest Unstable Version License

Total Downloads Daily Downloads Monthly Downloads

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-ints to your project's composer.json file such as:

composer require traderinteractive/filter-ints

Functionality

Ints/UnsignedInt::filter

These filters verify that the arguments are of the proper numeric type and allow for bounds checking. The second parameter to each of them can be set to true to allow null values through without an error (they will stay null and not get converted to false). The next two parameters are the min and max bounds and can be used to limit the domain of allowed numbers.

Non-numeric strings will fail validation, and numeric strings will be cast.

The following checks that $value is an integer between 1 and 100 inclusive, and returns the integer (after casting it if it was a string).

$value = \TraderInteractive\Filter\UnsignedInt::filter($value, false, 1, 100);

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.