Laminas Filter

https://github.com/laminas/laminas-filter
Admin
Laminas Filter provides a set of commonly needed data filters and a simple filter chaining mechanism...
Tokens:68,693
Snippets:526
Trust Score:9.7
License:BSD-3-Clause
Update:1 week ago
Show doc for...
Tokens:
Raw
### SeparatorToDash basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts spaces in a string to dashes. The example returns 'this-is-my-content'.

```php
$filter = new Laminas\Filter\Word\SeparatorToDash();

print $filter->filter('this is my content');
```

--------------------------------

### ToNull type configuration examples

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Shows various ways to configure the 'type' option for ToNull, using constants, bitwise OR, arrays, and strings to select which values are converted to null.

```php
// converts false to null
$filter = new Laminas\Filter\ToNull([
    'type' => Laminas\Filter\ToNull::BOOLEAN,
]);
```

```php
// converts false and 0 to null
$filter = new Laminas\Filter\ToNull([
    'type' => Laminas\Filter\ToNull::BOOLEAN | Laminas\Filter\ToNull::INTEGER
]);
```

```php
// converts false and 0 to null
$filter = new Laminas\Filter\ToNull([
    'type' => [
        Laminas\Filter\ToNull::BOOLEAN,
        Laminas\Filter\ToNull::INTEGER
    ],
]);
```

```php
// converts false and 0 to null
$filter = new Laminas\Filter\ToNull([
    'type' => [
        'boolean',
        'integer',
    ],
]);
```

```php
// converts only empty arrays to null
$filter = new Laminas\Filter\ToNull([
    'type' => 'array',
]);
```

--------------------------------

### StringTrim basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a StringTrim filter with default options and filters a string, removing whitespace from the beginning and end. The example outputs 'This is (my) content:'.

```php
$filter = new Laminas\Filter\StringTrim();

print $filter->filter(' This is (my) content: ');
```

--------------------------------

### PregReplace filter basic usage with pattern and replacement

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Performs a regular expression search and replace. Requires both 'pattern' and 'replacement' options. The example replaces 'bob' with 'john' in the input string, returning 'Hi john!'.

```php
$filter = new Laminas\Filter\PregReplace([
    'pattern'     => '/bob/',
    'replacement' => 'john',
]);
$input  = 'Hi bob!';

$filter->filter($input);
// returns 'Hi john!'
```

--------------------------------

### Boolean filter type configuration examples

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Shows multiple ways to configure the Boolean filter to convert specific types (e.g., integer 0 and zero string '0') to false. Includes using constants, an array of constants, and an array of string type names.

```php
// converts 0 to false
$filter = new Laminas\Filter\Boolean(Laminas\Filter\Boolean::TYPE_INTEGER);
```

```php
// converts 0 and '0' to false
$filter = new Laminas\Filter\Boolean(
    Laminas\Filter\Boolean::TYPE_INTEGER + Laminas\Filter\Boolean::TYPE_ZERO_STRING
);
```

```php
// converts 0 and '0' to false
$filter = new Laminas\Filter\Boolean([
    'type' => [
        Laminas\Filter\Boolean::TYPE_INTEGER,
        Laminas\Filter\Boolean::TYPE_ZERO_STRING,
    ],
]);
```

```php
// converts 0 and '0' to false
$filter = new Laminas\Filter\Boolean([
    'type' => [
        'integer',
        'zero',
    ],
]);
```

--------------------------------

### Configure multiple option sets for Rename filter

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/file.md

Shows the supported list of option sets for a single Rename filter instance, where each set matches a filename pattern and applies different options. The example matches '*.txt' and '*.pdf' files to move them to different target directories.

```php
[
  ['match' => '*.txt', 'target_directory' => '/tmp/text-files'],
  ['match' => '*.pdf', 'target_directory' => '/tmp/pdf-files'],
];
```

--------------------------------

### Retrieve filter by class name

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/plugin-manager.md

Use the get() method to fetch a filter instance by its fully qualified class name.

```php
$filter = $filterPluginManager->get(Laminas\Filter\StringTrim::class);
```

--------------------------------

### UnderscoreToDash basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts underscores in a string to dashes. The example transforms 'this_is_my_content' into 'this-is-my-content'. No additional options are supported.

```php
$filter = new Laminas\Filter\Word\UnderscoreToDash();

print $filter->filter('this_is_my_content');
```

--------------------------------

### DashToCamelCase basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts dash-separated words to CamelCase. The example returns 'ThisIsMyContent'.

```php
$filter = new Laminas\Filter\Word\DashToCamelCase();

print $filter->filter('this-is-my-content');
```

--------------------------------

### DashToUnderscore basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts dashes in a string to underscores. The example returns 'this_is_my_content'.

```php
$filter = new Laminas\Filter\Word\DashToUnderscore();

print $filter->filter('this-is-my-content');
```

--------------------------------

### Dir filter returning directory from '/etc/passwd'

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Returns the directory part of a file path. The example outputs '/etc' for the input '/etc/passwd'.

```php
$filter = new Laminas\Filter\Dir();

print $filter->filter('/etc/passwd');
```

--------------------------------

### Allow specific tags with specific attributes

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Passes the tag allow list as a set of tag/attribute values. Each key is an allowed tag pointing to a list of allowed attributes for that tag. The example allows 'img' with 'src' and 'width', and 'a' with 'href'.

```php
$filter = new Laminas\Filter\StripTags([
    'allowTags' => [
        'img' => [
            'src',
            'width'
        ],
        'a' => [
            'href'
        ]
    ]
]);

$input = "A text with <br/> a <img src='picture.com' width='100'>picture</img> click "
    . "<a href='http://picture.com/laminas' id='hereId'>here</a>!";
print $filter->filter($input);
```

--------------------------------

### Configure different options for several possible source files

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/file.md

Shows a Rename filter with multiple option sets, each matching different file patterns and applying distinct rename, overwrite, and randomize settings. The example demonstrates filtering 'fileA.txt' and 'fileB.txt' with different outcomes.

```php
$filter = new \Laminas\Filter\File\Rename([
    [
        'match'    => '*.pdf'
        'target_directory' => '/pdf-files/',
        'rename_to'    => 'newfileA.pdf',
        'overwrite' => true,
    ],
    [
        'match'    => '*.txt'
        'target_directory' => '/text-files/',
        'rename_to'    => 'newfileB.txt',
        'randomize' => true,
    ],
]);
echo $filter->filter('fileA.txt');
// File has been renamed to '/dest1/newfileA.txt'
echo $filter->filter('fileB.txt');
// File has been renamed to '/dest2/newfileB_4b3403665fea6.txt'
```

--------------------------------

### Dir filter returning directory from 'C:/Temp/x'

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Returns the directory part of a file path. The example outputs 'C:/Temp' for the input 'C:/Temp/x'.

```php
$filter = new Laminas\Filter\Dir();

print $filter->filter('C:/Temp/x');
```

--------------------------------

### SeparatorToCamelCase basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts a string with spaces to CamelCase, capitalizing each word. The example returns 'ThisIsMyContent'.

```php
$filter = new Laminas\Filter\Word\SeparatorToCamelCase();

print $filter->filter('this is my content');
```

--------------------------------

### DashToSeparator basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts dash-separated words to words separated by a space by default. The example returns 'this is my content'.

```php
$filter = new Laminas\Filter\Word\DashToSeparator();

print $filter->filter('this-is-my-content');
```

--------------------------------

### Allowing defined attributes with allowAttribs option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Strips all tags except allowed ones and all attributes except allowed ones. The example allows 'img' tags with only 'src' attribute, removing 'width'.

```php
$filter = new Laminas\Filter\StripTags([
    'allowTags' => ['img'],
    'allowAttribs' => ['src'],
]);

$input  = "A text with <br/> a <img src='picture.com' width='100'>picture</img>";
print $filter->filter($input);
```

--------------------------------

### Allowing defined tags with allowTags option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Uses the 'allowTags' option to strip all tags except the allowed ones. The example allows only 'a' tags, returning the link while removing other markup. Warning: do not use this feature to secure content.

```php
$filter = new Laminas\Filter\StripTags(['allowTags' => ['a']]);

$input  = "A text with <br/> a <a href='link.com'>link</a>";
print $filter->filter($input);
```

--------------------------------

### SeparatorToDash with custom separator

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Uses the 'separator' option to convert colons to dashes. The example returns 'this-is-my-content'.

```php
$filter = new Laminas\Filter\Word\SeparatorToDash(['separator' => ':']);

print $filter->filter('this:is:my:content');
```

--------------------------------

### Pass additional callback parameters with callback_params

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Shows how to pass extra arguments to a callback using the callback_params option. The first argument is the filtered value. The example uses an invokable class and returns 'bing,baz,bat' when filtering 'bing'.

```php
class MyClass {
    public function __invoke(mixed $input, string $a, string $b): string
    {
        if (is_string($input)) {
            return implode(', ', [$input, $a, $b]);
        }
        
        return 'Foo';
    }
}

$filter = new Laminas\Filter\Callback([
    'callback' => new MyClass(),
    'callback_params' => [
        'a' => 'baz',
        'b' => 'bat',
    ],
]);
$filter->filter('bing'); // returns 'bing,baz,bat'
```

--------------------------------

### BaseName filter basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Filters a file path to return its base name. The first example returns 'filename', the second returns 'filename.txt'.

```php
$filter = new Laminas\Filter\BaseName();

print $filter->filter('/vol/tmp/filename');
```

```php
$filter = new Laminas\Filter\BaseName();

print $filter->filter('/vol/tmp/filename.txt');
```

--------------------------------

### CamelCaseToSeparator with custom separator option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Uses the 'separator' option to specify a custom separator character. The example sets ':' as the separator and returns 'This:Is:My:Content'.

```php
$filter = new Laminas\Filter\Word\CamelCaseToSeparator(['separator' => ':']);

print $filter->filter('ThisIsMyContent');
```

--------------------------------

### StripNewlines basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a StripNewlines filter and removes all newline characters from the string. The example outputs 'This is (my) content:'.

```php
$filter = new Laminas\Filter\StripNewlines();

print $filter->filter(' This is (my)``\n\r``content: ');
```

--------------------------------

### DashToSeparator with custom separator option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Uses the 'separator' option to replace dashes with a custom character. The example returns 'this+is+my+content'.

```php
$filter = new Laminas\Filter\Word\DashToSeparator(['separator' => '+']);

print $filter->filter('this-is-my-content');
```

--------------------------------

### UnderscoreToStudlyCase basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts underscores in a string to studly caps (camelCase). The example transforms 'this_is_my_content' into 'thisIsMyContent'. No additional options are supported.

```php
$filter = new Laminas\Filter\Word\UnderscoreToStudlyCase();

print $filter->filter('this_is_my_content');
```

--------------------------------

### Using StringToLower as invokable via __invoke()

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/basic-usage.md

Shows how Laminas\Filter\FilterInterface's magic method `__invoke()` allows a filter to be used as an invokable. The example uses Laminas\Filter\StringToLower to convert a string to lowercase.

```php
$strtolower = new Laminas\Filter\StringToLower;

echo $strtolower('I LOVE Laminas!'); // i love laminas!
$laminaslove = $strtolower('I LOVE Laminas!');
```

--------------------------------

### DateTimeSelect basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a DateTimeSelect filter and filters an array of date/time parts into a 'Y-m-d H:i:s' string. The input array keys are second, minute, hour, day, month, and year; second defaults to 0 if absent. The example output is '2012-05-04 03:02:01'.

```php
$filter = new Laminas\Filter\DateTimeSelect();

print $filter->filter(['second' => '1', 'month' => '2', 'hour' => '3', 'day' => '4', 'month' => '5', 'year' => '2012']);
```

--------------------------------

### Archive arbitrary strings with CompressToArchive and fileName option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Filters arbitrary string content by first placing it in a file named by the required 'fileName' option, then archiving it. The example filters the string 'Kermit the Frog'.

```php
$filter = new Laminas\Filter\CompressToArchive([
    'archive' => '/path/to/archive.zip',
    'fileName' => 'Content.txt',
]);

$filter->filter('Kermit the Frog');
```

--------------------------------

### Inflector with throwTargetExceptionsOn Default (Exception)

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

By default, throwTargetExceptionsOn is true, so an un-processed placeholder causes a RuntimeException. This example filters ['wrong-key' => 'SomeValue'] and throws Laminas\Filter\Exception\RuntimeException.

```php
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$inflector = new Laminas\Filter\Inflector($pluginManager, [
    'target' => ':script.:suffix',
    'rules' => [
        ':script' => [
            Laminas\Filter\Word\CamelCaseToDash::class,
            Laminas\Filter\StringToLower::class,
        ],
        'suffix' => 'php',
    ],
]);

$inflector->filter(['wrong-key' => 'SomeValue']); // Laminas\Filter\Exception\RuntimeException
```

--------------------------------

### Check that filters are not shared

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/plugin-manager.md

Demonstrates that the filter plugin manager does not share filter instances, unlike other plugin managers. Each call to get() returns a new instance.

```php
$filterPluginManager->get(ExampleFilter::class) !== $filterPluginManager->get(ExampleFilter::class);
```

--------------------------------

### Getting a Filter Chain Instance

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/filter-chains.md

Shows how to obtain a FilterChain instance either manually or via the FilterPluginManager. The plugin manager is retrieved from a PSR-11 container. The build method accepts a configuration array for a ready-to-use chain.

```php
assert($container instanceof Psr\Container\ContainerInterface);
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);

// Create a Filter Chain instance manually:
$chain = new Laminas\Filter\FilterChain($pluginManager);

// Fetch an empty filter chain from the plugin manager
$chain = $pluginManager->get(Laminas\Filter\FilterChain::class);

// Build a ready-to-use filter chain via the plugin manager
$chain = $pluginManager->build(Laminas\Filter\FilterChain::class, [
    // ...(Filter Chain Configuration))
]);
```

--------------------------------

### Digits filter removing non-digits from 'HTML 5 for Dummies'

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Filters a string to keep only digits. The example outputs '5' for the input 'HTML 5 for Dummies'.

```php
$filter = new Laminas\Filter\Digits();

print $filter->filter('HTML 5 for Dummies');
```

--------------------------------

### Implement FilterInterface with __invoke() in PHP

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/migration/v2-to-v3.md

Required for laminas-filter v3: all filters must implement both filter() and __invoke(). The example shows a minimal implementation where __invoke() delegates to filter(). Note that both methods now use mixed parameter and return types.

```php
final class MyFilter implements Laminas\Filter\FilterInterface {
    public function filter(mixed $value): mixed
    {
        // Filter things…
    }
    
    public function __invoke(mixed $value) : mixed
    {
        return $this->filter($value); 
    }
}
```

--------------------------------

### DecompressArchive returns input when unrecognized

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

When the input is not a supported archive type or cannot be filtered, the filter returns the input unaltered. This example shows passing a non-archive string and asserting the result equals the original input.

```php
$filter = new Laminas\Filter\DecompressArchive([
    'target' => '/path/to/writable/directory',
]);

$directory = $filter->filter('Fozzy Bear');
assert($result === 'Fozzy Bear');
```

--------------------------------

### PHP: Setting filter chain order with priorities

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/filter-chains.md

Attach filters to a FilterChain with priorities; higher values execute first, default priority is 1000. In this example, StringToLower with priority 500 runs before StringPrefix (default 1000), producing 'FOO: bar'.

```php
// Create a filter chain and add filters to the chain
$filterChain = $pluginManager->get(Laminas\Filter\FilterChain::class);
$filterChain->attach(new Laminas\Filter\StringPrefix(['prefix' => 'FOO: ']));
$filterChain->attach(new Laminas\Filter\StringToLower(), 500);

print $filterChain->filter('BAR'); // 'FOO: bar'
```

--------------------------------

### Convert uploaded file contents to uppercase with Laminas\Filter\File\UpperCase

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/file.md

Use this filter to convert file contents to uppercase. The example creates an UpperCase filter and applies it to an uploaded file from a request. The optional 'encoding' option sets the encoding used during conversion.

```php
use Laminas\Filter\File\UpperCase;
use Laminas\Http\PhpEnvironment\Request;

$request = new Request();
$files   = $request->getFiles();
// i.e. $files['my-upload']['tmp_name'] === '/tmp/php5Wx0aJ'

$filter = new UpperCase();
$filter->filter($files['my-upload']);
```

--------------------------------

### DashToCamelCase::filter

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts dash-separated words to CamelCase. For example, 'this-is-my-content' becomes 'ThisIsMyContent'.

```APIDOC
## DashToCamelCase::filter

### Description
Converts dash-separated words to CamelCase. For example, 'this-is-my-content' becomes 'ThisIsMyContent'.

### Method
filter

### Parameters
- **value** (string) - Required - The input string with dashes.

### Return Value
- **string** - The converted CamelCase string.

### Example
```php
$filter = new Laminas\Filter\Word\DashToCamelCase();
print $filter->filter('this-is-my-content'); // ThisIsMyContent
```
```

--------------------------------

### CompressString with bz2 adapter

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Sets the adapter option to 'bz2' for BZ2 compression.

```php
$filter = new Laminas\Filter\CompressString([
    'adapter' => 'bz2',
]);

$compressed = $filter->filter('Some Content');
```

--------------------------------

### Replace StaticFilter with direct instantiation

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/migration/v2-to-v3.md

Shows how to achieve similar behavior to the removed Laminas\Filter\StaticFilter by directly instantiating a filter and invoking it as a callable.

```php
$filtered = (new \Laminas\Filter\HtmlEntities())('Nuts & Bolts');
```

--------------------------------

### SeparatorToCamelCase with custom separator

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Uses the 'separator' option to convert a string with colons to CamelCase. The example returns 'ThisIsMyContent'.

```php
$filter = new Laminas\Filter\Word\SeparatorToCamelCase(['separator' => ':']);

print $filter->filter('this:is:my:content');
```

--------------------------------

### Default Gzip compression and decompression

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Uses default GZ compression. Non-string input passes through unchanged; failures throw an exception.

```php
$compressFilter = new Laminas\Filter\CompressString();
$compressed = $filter->filter('String Content');

$decompressFilter = new Laminas\Filter\DecompressString();
$value = $filter->filter($compressed); // "String Content"
```

--------------------------------

### Use a different adapter with CompressToArchive

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Specifies the 'tar' adapter via the 'adapter' option to archive a file. The adapter can also be 'zip' or any object implementing Laminas\Filter\Compress\ArchiveAdapterInterface.

```php
$filter = new Laminas\Filter\CompressToArchive([
    'archive' => '/path/to/archive.tar',
    'adapter' => 'tar',
]);

$archiveLocation = $filter->filter('/path/to/file.txt');
```

--------------------------------

### CompressString with bz2 adapter and level 9

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Sets adapter to 'bz2' and level to 9 for maximum compression. Level must be an integer between 1 and 9.

```php
$filter = new Laminas\Filter\CompressString([
    'adapter' => 'bz2',
    'level' => 9,
]);

$compressed = $filter->filter('Some Content');
```

--------------------------------

### Constructor: __construct()

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

Initializes the Inflector with a plugin manager and configuration options. The plugin manager is used to resolve filter classes referenced in the rules.

```APIDOC
## Constructor: __construct()

### Description
Initializes the Inflector with a plugin manager and configuration options. The plugin manager is used to resolve filter classes referenced in the rules.

### Method
__construct

### Parameters
#### pluginManager (Laminas\Filter\FilterPluginManager) - Required - The plugin manager used to resolve filter classes.
#### options (array) - Required - Configuration options including 'target' and 'rules'.

### Options
- **target** (string) - Required - The target string containing placeholders to replace.
- **rules** (array) - Required - An array of inflection rules.
- **targetReplacementIdentifier** (string) - Optional - Overrides the default placeholder delimiter of ':'.
- **throwTargetExceptionsOn** (bool) - Optional - Whether to throw an exception for un-processed placeholders (true by default).

### Example
```php
$inflector = new Laminas\Filter\Inflector($pluginManager, [
    'target' => 'pages/:page.:suffix',
    'rules'  => [
        ':page'  => [
            Laminas\Filter\Word\CamelCaseToDash::class,
            Laminas\Filter\StringToLower::class,
        ],
        'suffix' => 'html',
    ],
]);
```
```

--------------------------------

### StringTrim with charlist option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a StringTrim filter with a charlist of ':' to remove only colons from the string ends. The example outputs ' This is (my) content'.

```php
$filter = new Laminas\Filter\StringTrim(['charlist' => ':']);

print $filter->filter(' This is (my) content:');
```

--------------------------------

### Changing the Target Placeholder Delimiter with targetReplacementIdentifier

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

Uses '?' as the placeholder delimiter to avoid conflicts when the target contains colons. Defines static rules for host, port, page, and suffix, then filters an array to produce the output 'example.com:80/index.html'.

```php
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$inflector = new Laminas\Filter\Inflector($pluginManager, [
    'target' => '?host:?port/?page.?suffix',
    'targetReplacementIdentifier' => '?',
    'rules' => [
        'host' => 'example.com',
        'port' => '80',
        'page' => 'anything',
        'suffix' => 'html',
    ],
]);
$inflector->filter(['page' => 'index']); // example.com:80/index.html
```

--------------------------------

### Digits filter removing non-digits from 'October 2012'

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Filters a string to keep only digits. The example outputs '2012' for the input 'October 2012'.

```php
$filter = new Laminas\Filter\Digits();

print $filter->filter('October 2012');
```

--------------------------------

### Implement FilterInterface with filter() and __invoke()

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/writing-filters.md

Create a custom filter by implementing Laminas\Filter\FilterInterface, which requires the filter() and __invoke() methods. The filter() method performs the transformation and __invoke() delegates to it.

```php
namespace Application\Filter;

use Laminas\Filter\FilterInterface;

final class MyFilter implements FilterInterface
{
    public function filter(mixed $value): mixed
    {
        // perform some transformation upon $value to arrive at $valueFiltered

        return $valueFiltered;
    }
    
    public function __invoke(mixed $value): mixed {
        return $this->filter($value);    
    }
}
```

--------------------------------

### CamelCaseToDash basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts CamelCaseWords to Camel-Case-Words. Since version 3, numbers are treated as word boundaries, so 'ThisHas4Words' becomes 'This-Has-4-Words'. The example returns 'This-Is-My-Content'.

```php
$filter = new Laminas\Filter\Word\CamelCaseToDash();

print $filter->filter('ThisIsMyContent');
```

--------------------------------

### Building the Chain with Array Configuration

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/filter-chains.md

Uses the plugin manager's build method with a 'filters' and 'callbacks' configuration array to create a chain that trims, lowercases, and reverses a string. Output is 'foo' for input ' OOF '.

```php
use Laminas\Filter\FilterChain;
use Laminas\Filter\StringToLower;
use Laminas\Filter\StringTrim;

$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$chain = $pluginManager->build(FilterChain::class, [
    'filters' => [
        ['name' => StringTrim::class],
        ['name' => StringToLower::class],
    ],
    'callbacks' => [
        ['callback' => static fn (string $value): string => strrev($value)],
    ],
]);

print $chain->filter(' OOF '); // 'foo'
```

--------------------------------

### ToString filter with non-scalar or null input

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Non-scalar or null input is returned un-filtered. The example shows null and a stdClass object passing through unchanged.

```php
$filter = new \Laminas\Filter\ToString();

$filter->filter(null); // null
$filter->filter(new \stdClass()); // \stdClass object
```

--------------------------------

### DecompressArchive with custom matcher

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Configures a DecompressArchive filter with a custom matcher instance to support additional archive formats. The matcher must implement Laminas\Compress\ArchiveAdapterResolverInterface to map mime-type or filename extensions to custom adapters.

```php
$filter = new Laminas\Filter\DecompressArchive([
    'target' => '/path/to/extract/to',
    'matcher' => new MyCustomArchiveAdapterResolver(),
]);
```

--------------------------------

### Setting the Inflector Target with Placeholders

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

Creates an Inflector with a target string containing placeholders like :page and :suffix. The target is required and uses a colon delimiter by default.

```php
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$inflector = new Laminas\Filter\Inflector($pluginManager, [
    'target' => 'pages/:page.:suffix',
    // ... Other Options
]);
```

--------------------------------

### Build a custom filter with options

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/plugin-manager.md

Uses the build() method to instantiate a custom filter while passing an associative array of options to its constructor. The manager uses Laminas\ServiceManager\Factory\InvokableFactory for instantiation.

```php
$filter = $filterPluginManager->build(
    ExampleFilter::class,
    [
        // Options for the filter as an associative array
    ]
);
```

--------------------------------

### StringToUpper

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Converts string input to uppercase. Optionally set the expected character encoding via the 'encoding' option.

```APIDOC
## StringToUpper

### Description
Converts string input to uppercase.

### Method
filter

### Parameters
#### Options
- **encoding** (string) - Optional - The expected character encoding of the input.

### Request Example
```php
$filter = new Laminas\Filter\StringToUpper();
```

### Response
#### Success Response
Returns the uppercase version of the input string.

#### Response Example
```php
print $filter->filter('Sample');
// returns "SAMPLE"
```
```

--------------------------------

### StripTags with broken tags

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

When content contains broken or partial tags, any content following the opening tag is completely removed. The example returns 'This contains'.

```php
$filter = new Laminas\Filter\StripTags();

print $filter->filter('This contains <a href="http://example.com">no ending tag');
```

--------------------------------

### new Laminas\Filter\CompressToArchive(options)

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a new CompressToArchive filter instance. The filter compresses files, strings, directories, and uploads to a pre-configured archive location using either zip or tar archive formats.

```APIDOC
## Constructor

### Description
Creates a new CompressToArchive filter instance. The filter compresses files, strings, directories, and uploads to a pre-configured archive location using either zip or tar archive formats.

### Method
Constructor

### Parameters
#### Options Array
- **archive** (string) - Required - Destination archive path. Must be a path to a target archive in a directory that exists and is writable by PHP.
- **adapter** (string|Laminas\Filter\Compress\ArchiveAdapterInterface) - Optional - Archive adapter: 'zip', 'tar', or an instance of ArchiveAdapterInterface. Default is 'zip'.
- **fileName** (string) - Optional - When archiving arbitrary strings, the string will be placed in a file with this name prior to archiving.

### Example
```php
$filter = new Laminas\Filter\CompressToArchive([
    'archive' => '/path/to/archive.zip',
]);
```
```

--------------------------------

### CamelCaseToUnderscore basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts CamelCase words to underscore-separated words. Since version 3, numbers are treated as word boundaries, so 'ThisHas4Words' becomes 'This_Has_4_Words'. The example returns 'This_Is_My_Content'.

```php
$filter = new Laminas\Filter\Word\CamelCaseToUnderscore();

print $filter->filter('ThisIsMyContent');
```

--------------------------------

### Archive a file path with CompressToArchive

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a CompressToArchive filter with a required 'archive' option and filters a file path, returning the archive location. The default archive format is Zip.

```php
$filter = new Laminas\Filter\CompressToArchive([
    'archive' => '/path/to/archive.zip',
]);

$archiveLocation = $filter->filter('/path/to/any-file.txt');
```

--------------------------------

### Configure custom filters via the constructor

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/plugin-manager.md

Passes the same configuration array to the filter plugin manager constructor as an alternative to the configure method. The constructor accepts the same options for factories, aliases, abstract factories, and delegators.

```php
$filterPluginManager = new Laminas\Filter\FilterPluginManager(
    new Laminas\ServiceManager\ServiceManager(),
    [
        'factories' => [
            Album\Filter\ExampleFilter::class => Album\Filter\ExampleFilterFactory::class,
        ],
        'aliases' => [
            'examplefilter' => Album\Filter\ExampleFilter::class,
        ],
        'abstract_factories' => [],
        'delegators'         => [],
        // …
    ]
);
```

--------------------------------

### Filtering ampersand and double quote with HtmlEntities

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/basic-usage.md

Basic example of using Laminas\Filter\HtmlEntities to filter the ampersand (`&`) and double quote (`"`) characters. The output shows `&amp;` and `&quot;` respectively.

```php
$htmlEntities = new Laminas\Filter\HtmlEntities();

echo $htmlEntities->filter('&'); // &amp;
echo $htmlEntities->filter('"'); // &quot;
```

--------------------------------

### HtmlEntities with ENT_NOQUOTES quotestyle

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Uses the quotestyle option set to ENT_NOQUOTES, which leaves both single and double quotes unaltered. The example output is 'A 'single' and "double"'.

```php
$filter = new Laminas\Filter\HtmlEntities(['quotestyle' => ENT_NOQUOTES]);

$input = "A 'single' and " . '"double"';
print $filter->filter($input);
```

--------------------------------

### DecompressArchive basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Decompresses an archive file to a configured target directory and returns the target path. The target directory must already exist and be writable; the filter does not create intermediate directories. Requires the zip extension or Archive_Tar package depending on the adapter.

```php
$filter = new Laminas\Filter\DecompressArchive([
    'target' => '/path/to/writable/directory',
]);

$result = $filter->filter('/path/to/an-archive.tar.gz');
assert($result === '/path/to/writable/directory');
```

--------------------------------

### StringToUpper basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Converts string input to uppercase. By default, only characters from the server's locale are handled; characters from other charsets are ignored.

```php
$filter = new Laminas\Filter\StringToUpper();

print $filter->filter('Sample');
// returns "SAMPLE"
```

--------------------------------

### HtmlEntities with ENT_QUOTES quotestyle

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Uses the quotestyle option set to ENT_QUOTES, which filters both single and double quotes. The example output is 'A &#039;single&#039; and &quot;double&quot;'.

```php
$filter = new Laminas\Filter\HtmlEntities(['quotestyle' => ENT_QUOTES]);

$input = "A 'single' and " . '"double"';
print $filter->filter($input);
```

--------------------------------

### Filtering a string with Inflector returns it as-is

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

The inflector only processes arrays or objects; other types such as strings are returned unchanged. The example shows a string being passed to filter() and returned as-is.

```php
$inflector->filter('string'); // 'string
```

--------------------------------

### StringPrefix filter basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Adds a specified prefix to scalar values or scalar array members. The 'prefix' option defines the string to prepend. Works on both single values and arrays, applying the prefix to each element.

```php
$filter = new Laminas\Filter\StringPrefix([
    'prefix' => 'PHP-',
]);

echo $filter->filter('MidCentral'); // "PHP-MidCentral"

$array = $filter->filter(['East', 'West']); // ['PHP-East', 'PHP-West']
```

--------------------------------

### HtmlEntities with ENT_COMPAT quotestyle

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Uses the quotestyle option set to ENT_COMPAT, which filters double quotes but leaves single quotes unaltered. The example output is 'A 'single' and &quot;double&quot;'.

```php
$filter = new Laminas\Filter\HtmlEntities(['quotestyle' => ENT_COMPAT]);

$input = "A 'single' and " . '"double"';
print $filter->filter($input);
```

--------------------------------

### MonthSelect basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a MonthSelect filter and applies it to an array with 'month' and 'year' keys, returning '2012-02'. Options null_on_empty and null_on_all_empty default to false.

```php
$filter = new Laminas\Filter\MonthSelect();

print $filter->filter(['month' => '2', 'year' => '2012']);
```

--------------------------------

### DenyList basic usage with list option

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a DenyList filter that returns null for forbidden values and the original value otherwise. The 'list' option specifies forbidden values; 'strict' option controls strict comparison via in_array().

```php
$denyList = new \Laminas\Filter\DenyList([
    'list' => ['forbidden-1', 'forbidden-2']
]);
echo $denyList->filter('forbidden-1'); // => null
echo $denyList->filter('allowed');     // => 'allowed'
```

--------------------------------

### Move to a new path and randomize file names

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/file.md

Combines 'match' and 'randomize' options to move files matching a pattern and append a random postfix. The random postfix is generated with uniqid('_') after the file name and before the extension, e.g., 'file.txt' becomes 'file_4b3403665fea6.txt'.

```php
$filter = new \Laminas\Filter\File\Rename([
    'match'    => '/tmp/*.txt',
    'randomize' => true,
]);
echo $filter->filter('./myfile.txt');
// File has been renamed to '/tmp/newfile_4b3403665fea6.txt'
```

--------------------------------

### Archive a directory with CompressToArchive

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Filters a directory path to archive its contents into the configured archive file. The filter returns the archive path on success.

```php
$filter = new Laminas\Filter\CompressToArchive([
    'archive' => '/path/to/archive.zip',
]);

$archiveLocation = $filter->filter('/path/to/directory');
```

--------------------------------

### ToFloat basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a ToFloat filter and applies it to the string '-4.4', returning the float -4.4. No additional options are supported.

```php
$filter = new Laminas\Filter\ToFloat();

print $filter->filter('-4.4');
```

--------------------------------

### CamelCaseToSeparator basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/word.md

Converts CamelCaseWords to Camel Case Words using the default separator (space). Since version 3, numbers are treated as word boundaries, so 'ThisHas4Words' becomes 'This Has 4 Words'. The example returns 'This Is My Content'.

```php
$filter = new Laminas\Filter\Word\CamelCaseToSeparator();

print $filter->filter('ThisIsMyContent');
```

--------------------------------

### CompressString::filter

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Compresses a string using the configured adapter (defaults to GZ). Non-string input passes through unchanged; throws an exception on failure.

```APIDOC
## [FILTER] CompressString::filter

### Description
Compresses a string using the configured adapter (defaults to GZ). Non-string input passes through unchanged; throws an exception on failure.

### Method
filter

### Parameters
#### Constructor Options
- **adapter** (string|Laminas\Filter\Compress\StringCompressionAdapterInterface) - Optional - Compression adapter: 'gz' (default), 'bz2', or custom adapter instance.
- **level** (int) - Optional - Compression level between 1 and 9 (9 = highest compression). Defaults to extension default.

### Request Example
```php
$filter = new Laminas\Filter\CompressString([
    'adapter' => 'bz2',
    'level' => 9,
]);
$compressed = $filter->filter('Some Content');
```

### Response
#### Success Response
- **string** - The compressed string.

#### Response Example
```php
$compressed = $filter->filter('String Content');
```

### Error Handling
- Throws an exception if compression fails or required PHP extension is missing.
```

--------------------------------

### PregReplace::filter

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Performs a search using regular expressions and replaces all found elements. Requires both 'pattern' and 'replacement' options to be set.

```APIDOC
## PregReplace::filter

### Description
Performs a search using regular expressions and replaces all found elements. Requires both `pattern` and `replacement` options to be set.

### Method
filter

### Parameters
#### Constructor Options
- **pattern** (string|array) - Required - The pattern to search for. Can be a string for a single pattern, or an array of strings for multiple patterns.
- **replacement** (string|array) - Required - The string to replace matches with. Can contain placeholders for matched groups from the search pattern. Can be a string or an array of string replacements.

#### Input
- **value** (string) - Required - The input string to apply the regular expression replacement to.

### Return Value
- **string** - The input string with all matches replaced.

### Example
```php
$filter = new Laminas\Filter\PregReplace([
    'pattern'     => '/bob/',
    'replacement' => 'john',
]);
$input  = 'Hi bob!';

$filter->filter($input);
// returns 'Hi john!'
```
```

--------------------------------

### Transform Mixed Case and Camel Cased Text with Laminas\Filter\Inflector

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

Creates an Inflector with a target pattern and rules to replace placeholders. The example transforms 'camelCasedWords' to 'camel-cased-words' and leaves non-camel-cased input unchanged. Requires a FilterPluginManager instance from the container.

```php
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$inflector = new Laminas\Filter\Inflector($pluginManager, [
    'target' => 'pages/:page.:suffix',
    'rules'  => [
        ':page'  => [
            Laminas\Filter\Word\CamelCaseToDash::class,
            Laminas\Filter\StringToLower::class,
        ],
        'suffix' => 'html',
    ],
]);

$filtered = $inflector->filter(['page' => 'camelCasedWords']);
// pages/camel-cased-words.html

$filtered = $inflector->filter(['page' => 'this_is_not_camel_cased']);
// pages/this_is_not_camel_cased.html
```

--------------------------------

### AllowList filter basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates an AllowList filter with allowed values and filters a value. Returns the value if present in the list, otherwise returns null.

```php
$allowList = new \Laminas\Filter\AllowList([
    'list' => ['allowed-1', 'allowed-2']
]);
echo $allowList->filter('allowed-2');   // => 'allowed-2'
echo $allowList->filter('not-allowed'); // => null
```

--------------------------------

### Building an Inflector standalone with FilterPluginManager::build()

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/inflector.md

When using the inflector outside of an input filter or form specification, create it via Laminas\Filter\FilterPluginManager::build() by providing only options. The target and rules options configure the inflection behavior, including a CamelCaseToDash and StringToLower filter chain for the ':script' rule and a static 'suffix' rule.

```php
$pluginManager = $container->get(Laminas\Filter\FilterPluginManager::class);
$inflector = $pluginManager->build(
    Laminas\Filter\Inflector::class,
    [
        'target' => ':script.:suffix',
        'rules' => [
            ':script' => [
                Laminas\Filter\Word\CamelCaseToDash::class,
                Laminas\Filter\StringToLower::class,
            ],
            'suffix' => 'php',
        ],
    ],
);
```

--------------------------------

### Disable casting in Laminas\Filter\Boolean with 'casting' => false

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Sets the 'casting' option to false so only recognized boolean values are converted; all other values are returned unchanged. The example shows that 0 becomes false, 1 becomes true, and 2 is returned as-is.

```php
$filter = new Laminas\Filter\Boolean([
    'type'    => Laminas\Filter\Boolean::TYPE_ALL,
    'casting' => false,
]);

// returns false
$result = $filter->filter(0);

// returns true
$result = $filter->filter(1);

// returns the value
$result = $filter->filter(2);
```

--------------------------------

### Create FilterPluginManager with ServiceManager

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/plugin-manager.md

Instantiate Laminas\Filter\FilterPluginManager using a PSR-11 container, here a Laminas ServiceManager instance.

```php
$filterPluginManager = new Laminas\Filter\FilterPluginManager(
    new Laminas\ServiceManager\ServiceManager()
);
```

--------------------------------

### Use strrev as callback with Laminas\Filter\Callback

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a Callback filter using PHP's built-in strrev function. Calling filter('Hello!') returns '!olleH'.

```php
$filter = new Laminas\Filter\Callback('strrev');

print $filter->filter('Hello!');
// returns "!olleH"
```

--------------------------------

### ToInt basic usage

Source: https://github.com/laminas/laminas-filter/blob/3.5.x/docs/book/v3/standard-filters.md

Creates a ToInt filter and applies it to a string, returning the integer -4.

```php
$filter = new Laminas\Filter\ToInt();

print $filter->filter('-4 is less than 0');
```
Tokens:
Raw