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 string $name;
/**
* @Filter\StripTags()
* @Filter\Trim()
* @Filter\StripNewlines()
*
* @var string
*/
public string $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
720 Jan 3, 2023
18 Apr 2, 2022
111 Jan 3, 2023
19 Dec 14, 2022
162 Oct 30, 2022
165 Sep 16, 2022
1.5k Dec 29, 2022
1 Jun 21, 2022
44 Jul 19, 2022
17 Nov 29, 2022
45 Nov 30, 2022
3 Oct 5, 2022
7 Dec 10, 2022
622 Jan 2, 2023
201 Dec 23, 2022
1 May 3, 2022
4 Dec 17, 2022
17.7k Jan 1, 2023
378 Jan 3, 2023