district5/filters

District5 Filters Library

3.1.0 2024-09-03 13:23 UTC

This package is auto-updated.

Last update: 2024-11-03 15:05:39 UTC


README

codecov

PHP Filters

A collection of filters implementing the District5 Filter interface.

Installation

Install using composer:

composer require district5/filters

Usage

All filters in this library conform to the District5 Filter interface. All can be used in the same way:

$value = 'Hello';

$filter = new \District5\Filters\StringLower();
$filteredValue = $filter->filter($value);   // 'hello'

These filters do not guarantee consistent return filtered items if the input has not been validated first, for example ArrayOfStringToInt relies on the strings being a value that can be converted as intval is utilised.

You should validate input first; these filters can then be used to add business logic to the validated data. If for example you wanted to store hex colour codes but allow users the flexibility of either including or omitting the #, you would need to validate that the string is indeed a hex code, and then run it through the filter to make sure you always utilise / persist the codes consistently.

To make use of this combined functionality please see Validation Groups library.

Available Filters

  • Array of strings to lower case
  • Array of strings to upper case
  • Array of strings to integers
  • Array of strings to an array of the unique values
  • Array of strings with all strings trimmed
  • String to lower case
  • String to upper case
  • String trim
  • String to UCS Words

Issues

Log a bug report!