rdohms / dms-filter Goto Github PK

View Code? Open in Web Editor NEW

94.0 6.0 19.0 1.38 MB

Library that offers Input Filtering based on Annotations for use with Objects. Check out 2.dev for 2.0 pre-release.

Home Page: http://doh.ms/project/list

License: MIT License

PHP 100.00%

annotations filtering security hacktoberfest

dms-filter's Introduction

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

Annotation way

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

Attribute way

Your Entity:

<?php

namespace App\Entity;

//Import Attributes
use DMS\Filter\Rules as Filter;

class User
{
    #[Filter\StripTags]
    #[Filter\Trim]
    #[Filter\StripNewlines]
    public string $name;

    #[Filter\StripTags]
    #[Filter\Trim]
    #[Filter\StripNewlines]
    public string $email;
}
?>

Filtering:

<?php
    //Load AttributeLoader
    $loader = new Mapping\Loader\AttributeLoader();
    $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]"
?>

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

dms-filter's People

Contributors

Stargazers

Watchers

Forkers

activeingredient fronteras alganet ustrugany gfreeau brandonlamb dantoncancella iuyes electrolutz paulinevos lgsgbr raphaeldealmeida kdadler maxmilash tobias-trozowski progmancod cergey-obr

dms-filter's Issues

Filter: Callback

Callback Filter should be applied on a property of an object.

Inputs

string: a method on the object itself
array: a method on a class in the format {'Class', 'method'}
closure: a closure

The return value will replace the current value of the property.
Not all possibilities above may be available when using the filter from an annotation.

Structural impact:
This filter must receive the object itself, especially for the string input, as it needs to call a method on that object. This is not currently supported by the library and needs to be implemented.

Class Level Filters

Moved here from rdohms/DMS#42.

Offer possibility to add filters that are applied on the class, not the properties.

XML/YML support

The README states this is only configured with annotations, it seems the config could also be loaded from yml/xml as well to make it more inline with other components such as validator or doctrine.

What are the chances of this?

The current loader seems to be similar to how the symfony validation component does it for annotations.

Composer fails to clone this repo

Composer tries to get this repo as a requirement of dms-filter-bundle v1.1.1, but it fails to clone it:

"require": {
    "dms/dms-filter-bundle":               "1.1.*",
}

[RuntimeException]                                                                           
  Failed to clone https://github.com/rdohms/DMS-Filter.git via git, https protocols, aborting. 

  - git://github.com/rdohms/DMS-Filter.git                                                     
    fatal: remote error:                                                                       
      Repository not found.                                                                    

  - https://github.com/rdohms/DMS-Filter.git                                                   
    fatal: Authentication failed

I am running composer install with the --prefer-source option on.

I noticed that the repo name that is trying to clone is different from the one you can get directly from main page, so probably it's a typo somewhere, the problem is that I don't know where :P

Filters can be references by either FQN or Shortname