Download the PHP package popphp/pop-filter without Composer
On this page you can find all versions of the php package popphp/pop-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download popphp/pop-filter
More information about popphp/pop-filter
Files in popphp/pop-filter
Package pop-filter
Short Description Pop Filter Component for Pop PHP Framework
License BSD-3-Clause
Homepage http://www.popphp.org/
Informations about the package pop-filter
pop-filter
- Overview
- Install
- Quickstart
- Extending
- Excludes
Overview
pop-filter
is a component for applying filtering callbacks to values that need to be
consumed by other areas of an application. It can be used for input security as well
general input scrubbing as well.
pop-filter
is a component of the Pop PHP Framework.
Top
Install
Install pop-filter
using Composer.
composer require popphp/pop-filter
Or, require it in your composer.json file
"require": {
"popphp/pop-filter" : "^4.0.0"
}
Top
Quickstart
Simple Filter
If you want to create a simple, single filter and use it to filter some values, you can do this:
The values above have been filtered and had the tags stripped:
Top
Extending
The Filterable Trait
The component comes with a trait called Pop\Filter\FilterableTrait
. If you wish to have the filter
component and its features included in your application, you can create a class that uses this trait.
With it, your class will be able to add filters and call the methods to filter the necessary values.
These filters can either be an instance of Pop\Filter\FilterInterface
(e.g., Pop\Filter\Filter
)
or a basic callable.
With the above code, you can create a user model, add filters to it and filter values with it:
The values are now filtered and look like:
The tags have been stripped and the entities have been converted to HTML. Notice the
first filter added was the callable strip_tags
and the second filter added was an
instance of Pop\Filter\Filter
with parameters.
Top
Excludes
Fine-Grained Control
Two properties are available to the filter
method within the Pop\Filter\AbstractFilter
class.
They are excludeByName
and excludeByType
. With them, you can have fine-tuned control over
what values actually get filtered. For example, if you don't want to filter any values named
username
, you can do this:
Because of the third parameter in the above constructor, the username
is excluded from being
filtered and the values look like this:
The fourth parameter of the filter constructor is $excludeByType
and that is useful for
excluding a number of values at once that are all of the same type, for example, textareas
within a form object.
Top