DMS Filter Component
This library provides a service that can be used to filter object values based on annotations
Install
Use composer to add DMS\Filter to your app
composer require dms/dms-filter
Usage
Your Entity:
<?php
namespace App\Entity;
//Import Annotations
use DMS\Filter\Rules as Filter;
class User
{
/**
* @Filter\StripTags()
* @Filter\Trim()
* @Filter\StripNewlines()
*
* @var string
*/
public $name;
/**
* @Filter\StripTags()
* @Filter\Trim()
* @Filter\StripNewlines()
*
* @var string
*/
public $email;
}
?>
Filtering:
<?php
//Get Doctrine Reader
$reader = new Annotations\AnnotationReader();
$reader->setEnableParsePhpImports(true);
//Load AnnotationLoader
$loader = new Mapping\Loader\AnnotationLoader($reader);
$this->loader = $loader;
//Get a MetadataFactory
$metadataFactory = new Mapping\ClassMetadataFactory($loader);
//Get a Filter
$filter = new DMS\Filter\Filter($metadataFactory);
//Get your Entity
$user = new App\Entity\User();
$user->name = "My <b>name</b>";
$user->email = " [email protected]";
//Filter you entity
$filter->filter($user);
echo $user->name; //"My name"
echo $user->email; //"[email protected]"
?>
Full example: https://gist.github.com/1098352
Dependencies
This package relies on these external libraries:
- Doctrine Annotations
Contributing
Feel free to send pull requests, just follow these guides:
- Fork
- Code
- Test
- Just create FilterTestCase and run
phpunit
- Just create FilterTestCase and run
- Submit PR
Credits
This library is inspired by the Symfony 2 Validator component and is meant to work alongside it.
Symfony 2 Validator: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Validator
451 Dec 27, 2022
1 Mar 8, 2022
41 Dec 12, 2021
153 Jan 2, 2023
1.5k Dec 30, 2022
767 Jan 2, 2023
39 Oct 11, 2022
43 Sep 28, 2022
48 Apr 10, 2022
10 Aug 12, 2022
1 Oct 19, 2022
13 Apr 23, 2022
10.7k Jun 13, 2022
0 Jan 15, 2022
18 Dec 14, 2022
89 Nov 28, 2022
246 Jan 5, 2023
3 May 31, 2022
151 Jan 5, 2023