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@mail.com";

    //Filter you entity
    $filter->filter($user);

    echo $user->name; //"My name"
    echo $user->email; //"email@mail.com"
?>

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
Submit PR

Credits

This library is inspired by the Symfony 2 Validator component and is meant to work alongside it.