Skip to content
Library that offers Input Filtering based on Annotations for use with Objects. Check out 2.dev for 2.0 pre-release.
PHP
Latest commit 3eb0942 Mar 1, 2016 @rdohms Update README.md
Failed to load latest commit information.
src/DMS/Filter Merge branch 'php7-compat' of github.com:rdohms/dms-filter into php7-… Feb 28, 2016
tests/DMS Applied fixes from StyleCI Feb 28, 2016
.gitignore
.travis.yml Speeding up travis. Feb 28, 2016
CHANGELOG.md Tweaks and Changelog Feb 28, 2016
LICENSE Replicating LICENSE files into each sub-tree split Oct 25, 2012
README.md Update README.md Mar 1, 2016
composer.json Avoiding bad versions of ZF stdlib Feb 28, 2016
composer.lock Avoiding bad versions of ZF stdlib Feb 28, 2016
phpunit.xml Fixed directory structure Jan 14, 2014

README.md

DMS Filter Component

This library provides a service that can be used to filter object values based on annotations

Latest Stable Version Total Downloads Latest Unstable Version License SensioLabsInsight Build Status

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@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.

Symfony 2 Validator: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Validator

Something went wrong with that request. Please try again.