traderinteractive / filter-dates
A filtering implementation for verifying dates
Installs: 80 187
Dependents: 2
Suggesters: 0
Security: 0
Stars: 1
Watchers: 8
Forks: 3
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- traderinteractive/exceptions: ^2.0
Requires (Dev)
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.2
Suggests
- ext-timezonedb: The latest version of the timezone database
This package is auto-updated.
Last update: 2024-10-27 17:30:56 UTC
README
A filtering implementation for verifying correct data and performing typical modifications to common date objects.
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-dates
to your project's composer.json
file such as:
composer require traderinteractive/filter-dates
Functionality
DateTime::filter
This will filter the value as a \DateTime
object. The value can be any string that conforms to PHP's valid date/time formats
The following checks that $value
is a date/time.
$dateTime = \TraderInteractive\Filter\DateTime::filter('2014-02-04T11:55:00-0500');
DateTime::format
This will filter a given `\DateTime' value to a string based on the given format.
The following returns formatted string for a given \DateTime
$value
$formatted = \TraderInteractive\Filter\DateTime::format($value, 'Y-m-d H:i:s');
DateTimeZone::filter
This will filter the value as a \DateTimeZone
object. The value can be any supported timezone name
The following checks that $value
is a timezone
$timezone = \TraderInteractive\Filter\DateTimeZone::filter('America/New_York');
TimeOfDayFilter::filter
This will filter values as a time-of-day string in the format of HH:MM:SS
The following checks that $value
is a valid time-of-day string
$timeOfDay = \TraderInteractive\Filter\TimeOfDayFilter::filter('12:00:59');
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.