Popularity
2.2
Growing
Activity
0.0
Stable
86
3
17

Description

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

Code Quality Rank: L5
Monthly Downloads: 5,006
Programming language: PHP
License: MIT License
Tags: Filtering And Validation     Filter     Dms    
Latest version: v3.0.0

DMS Filter alternatives and similar libraries

Based on the "Filtering and Validation" category

Do you think we are missing an alternative of DMS Filter or a related project?

Add another 'Filtering and Validation' Library

README

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


*Note that all licence references and agreements mentioned in the DMS Filter README section above are relevant to that project's source code only.