Sanitizer::applyFilter() - Code Metrics - ARCANEDEV/Sanitizer - Measure and Improve Code Quality continuously with Scrutinizer

Sanitizer::applyFilter() A
last analyzed 2016-12-20 17:56 UTC

↳ Parent: Sanitizer

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	3
nop	3
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
ccs	8
cts	8
cp	1
crap	3

<?php namespace Arcanedev\Sanitizer;

use Arcanedev\Sanitizer\Contracts\Filterable;
use Arcanedev\Sanitizer\Contracts\Sanitizer as SanitizerContract;
use Closure;

/**
 * Class     Sanitizer
 *
 * @package  Arcanedev\Sanitizer
 * @author   ARCANEDEV <[email protected]>
 */
class Sanitizer implements SanitizerContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Available filters.
     *
     * @var array
     */
    protected $filters = [];

    /**
     * Rules to sanitize.
     *
     * @var Entities\Rules
     */
    protected $rules;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a new sanitizer instance.
     *
     * @param  array  $filters
     */
    public function __construct(array $filters = [])
    {
        $this->rules = new Entities\Rules;
        $this->setFilters($filters);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Set filters.
     *
     * @param  array  $filters
     *
     * @return self
     */
    public function setFilters(array $filters)
    {
        if (empty($this->filters)) {
            $this->filters = $this->getDefaultFilters();
        }

        $this->filters = array_merge(
            $this->filters, $filters
        );

        return $this;
    }

    /**
     * Set rules.
     *
     * @param  array  $rules
     *
     * @return self
     */
    public function setRules(array $rules)
    {
        $this->rules->set($rules);

        return $this;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Sanitize the given data.
     *
     * @param  array  $data
     * @param  array  $rules
     * @param  array  $filters
     *
     * @return array
     */
    public function sanitize(array $data, array $rules = [], array $filters = [])
    {
        $this->setRules($rules);
        $this->setFilters($filters);

        foreach ($data as $name => $value) {
            $data[$name] = $this->sanitizeAttribute($name, $value);
        }

        return $data;
    }

    /**
     * Sanitize the given attribute
     *
     * @param  string  $attribute
     * @param  mixed   $value
     *
     * @return mixed
     */
    protected function sanitizeAttribute($attribute, $value)
    {
        foreach ($this->rules->get($attribute) as $rule) {
            $value = $this->applyFilter($rule['name'], $value, $rule['options']);
        }

        return $value;
    }

    /**
     * Apply the given filter by its name.
     *
     * @param  string  $name
     * @param  mixed   $value
     * @param  array   $options
     *
     * @return mixed
     */
    protected function applyFilter($name, $value, $options = [])
    {
        $this->hasFilter($name);

        if (empty($value)) return $value;

        $filter = $this->filters[$name];

        if ($filter instanceof Closure) {
            return call_user_func_array($filter, compact('value', 'options'));
        }

        /** @var Filterable $filterable */
        $filterable = new $filter;

        return $filterable->filter($value, $options);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check has filter, if does not exist, throw an Exception.
     *
     * @param  string  $name
     *
     * @throws Exceptions\FilterNotFoundException
     */
    private function hasFilter($name)
    {
        if ( ! isset($this->filters[$name])) {
            throw new Exceptions\FilterNotFoundException(
                "No filter found by the name of $name"
            );
        }
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get default filters.
     *
     * @return array
     */
    private function getDefaultFilters()
    {
        return [
            'capitalize'  => Filters\CapitalizeFilter::class,
            'email'       => Filters\EmailFilter::class,
            'escape'      => Filters\EscapeFilter::class,
            'format_date' => Filters\FormatDateFilter::class,
            'lowercase'   => Filters\LowercaseFilter::class,
            'slug'        => Filters\SlugFilter::class,
            'trim'        => Filters\TrimFilter::class,
            'uppercase'   => Filters\UppercaseFilter::class,
            'url'         => Filters\UrlFilter::class,
        ];
    }
}


1		<?php namespace Arcanedev\Sanitizer;
2
3		use Arcanedev\Sanitizer\Contracts\Filterable;
4		use Arcanedev\Sanitizer\Contracts\Sanitizer as SanitizerContract;
5		use Closure;
6
7		/**
8		* Class Sanitizer
9		*
10		* @package Arcanedev\Sanitizer
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class Sanitizer implements SanitizerContract
14		{
15		/* ------------------------------------------------------------------------------------------------
16		\| Properties
17		\| ------------------------------------------------------------------------------------------------
18		*/
19		/**
20		* Available filters.
21		*
22		* @var array
23		*/
24		protected $filters = [];
25
26		/**
27		* Rules to sanitize.
28		*
29		* @var Entities\Rules
30		*/
31		protected $rules;
32
33		/* ------------------------------------------------------------------------------------------------
34		\| Constructor
35		\| ------------------------------------------------------------------------------------------------
36		*/
37		/**
38		* Create a new sanitizer instance.
39		*
40		* @param array $filters
41		*/
42	315	public function __construct(array $filters = [])
43		{
44	315	$this->rules = new Entities\Rules;
45	315	$this->setFilters($filters);
46	315	}
47
48		/* ------------------------------------------------------------------------------------------------
49		\| Getters & Setters
50		\| ------------------------------------------------------------------------------------------------
51		*/
52		/**
53		* Set filters.
54		*
55		* @param array $filters
56		*
57		* @return self
58		*/
59	315	public function setFilters(array $filters)
60		{
61	315	if (empty($this->filters)) {
62	315	$this->filters = $this->getDefaultFilters();
63	105	}
64
65	315	$this->filters = array_merge(
66	315	$this->filters, $filters
67	105	);
68
69	315	return $this;
70		}
71
72		/**
73		* Set rules.
74		*
75		* @param array $rules
76		*
77		* @return self
78		*/
79	225	public function setRules(array $rules)
80		{
81	225	$this->rules->set($rules);
82
83	216	return $this;
84		}
85
86		/* ------------------------------------------------------------------------------------------------
87		\| Main Functions
88		\| ------------------------------------------------------------------------------------------------
89		*/
90		/**
91		* Sanitize the given data.
92		*
93		* @param array $data
94		* @param array $rules
95		* @param array $filters
96		*
97		* @return array
98		*/
99	225	public function sanitize(array $data, array $rules = [], array $filters = [])
100		{
101	225	$this->setRules($rules);
102	216	$this->setFilters($filters);
103
104	216	foreach ($data as $name => $value) {
105	216	$data[$name] = $this->sanitizeAttribute($name, $value);
106	66	}
107
108	198	return $data;
109		}
110
111		/**
112		* Sanitize the given attribute
113		*
114		* @param string $attribute
115		* @param mixed $value
116		*
117		* @return mixed
118		*/
119	216	protected function sanitizeAttribute($attribute, $value)
120		{
121	216	foreach ($this->rules->get($attribute) as $rule) {
122	216	$value = $this->applyFilter($rule['name'], $value, $rule['options']);
123	66	}
124
125	198	return $value;
126		}
127
128		/**
129		* Apply the given filter by its name.
130		*
131		* @param string $name
132		* @param mixed $value
133		* @param array $options
134		*
135		* @return mixed
136		*/
137	216	protected function applyFilter($name, $value, $options = [])
138		{
139	216	$this->hasFilter($name);
140
141	207	if (empty($value)) return $value;
142
143	207	$filter = $this->filters[$name];
144
145	207	if ($filter instanceof Closure) {
146	27	return call_user_func_array($filter, compact('value', 'options'));
147		}
148
149		/** @var Filterable $filterable */
150	189	$filterable = new $filter;
151
152	189	return $filterable->filter($value, $options);
153		}
154
155		/* ------------------------------------------------------------------------------------------------
156		\| Check Functions
157		\| ------------------------------------------------------------------------------------------------
158		*/
159		/**
160		* Check has filter, if does not exist, throw an Exception.
161		*
162		* @param string $name
163		*
164		* @throws Exceptions\FilterNotFoundException
165		*/
166	216	private function hasFilter($name)
167		{
168	216	if ( ! isset($this->filters[$name])) {
169	9	throw new Exceptions\FilterNotFoundException(
170	9	"No filter found by the name of $name"
171	3	);
172		}
173	207	}
174
175		/* ------------------------------------------------------------------------------------------------
176		\| Other Functions
177		\| ------------------------------------------------------------------------------------------------
178		*/
179		/**
180		* Get default filters.
181		*
182		* @return array
183		*/
184	315	private function getDefaultFilters()
185		{
186		return [
187	315	'capitalize' => Filters\CapitalizeFilter::class,
188	105	'email' => Filters\EmailFilter::class,
189	105	'escape' => Filters\EscapeFilter::class,
190	105	'format_date' => Filters\FormatDateFilter::class,
191	105	'lowercase' => Filters\LowercaseFilter::class,
192	105	'slug' => Filters\SlugFilter::class,
193	105	'trim' => Filters\TrimFilter::class,
194	105	'uppercase' => Filters\UppercaseFilter::class,
195	105	'url' => Filters\UrlFilter::class,
196	105	];
197		}
198		}
199

ARCANEDEV / Sanitizer

Sanitizer::applyFilter() A last analyzed 2016-12-20 17:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Sanitizer::applyFilter() A
last analyzed 2016-12-20 17:56 UTC