FilterResource::defaults() - Code Metrics - Inspection of "Merge pull request #37 from RickvdStaaij/feature/c..." - particle-php/Filter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b133bf...737a42 )

by Rick

created 2015-12-10 09:52 UTC

FilterResource::defaults() A

↳ Parent: FilterResource

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * Particle.
 *
 * @link      http://github.com/particle-php for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Particle (http://particle-php.com)
 * @license   https://github.com/particle-php/Filter/blob/master/LICENSE New BSD License
 */
namespace Particle\Filter;

/**
 * Class FilterResource
 * @package Particle\Filter
 */
class FilterResource
{
    /**
     * @var Filter
     */
    protected $filter;

    /**
     * @var null|string|string[]
     */
    protected $keys;

    /**
     * @param Filter $filter
     * @param null|string|string[] $keys
     */
    public function __construct(Filter $filter, $keys = null)
    {
        $this->filter = $filter;
        $this->keys = $keys;
    }

    /**
     * Results rule that returns alphabetic numeric characters from the value
     *
     * @return $this
     */
    public function alnum()
    {
        return $this->addRule(new FilterRule\Alnum);
    }

    /**
     * Results rule that returns the value appended with a given value
     *
     * @param string $append
     * @return Chain
     */
    public function append($append)
    {
        return $this->addRule(new FilterRule\Append($append));
    }

    /**
     * Results rule that returns a casted boolean
     *
     * @return $this
     */
    public function bool()
    {
        return $this->addRule(new FilterRule\CastBool);
    }

    /**
     * Returns rule that returns a value modified by a callable closure
     *
     * @param callable $callable
     * @param bool $allowNotSet
     * @return $this
     */
    public function callback(callable $callable, $allowNotSet = false)
    {
        return $this->addRule(new FilterRule\Callback($callable, $allowNotSet));
    }

    /**
     * Returns rule that defaults a given value if the data key was not provided
     *
     * @param mixed $defaultValue
     * @return $this
     */
    public function defaults($defaultValue)
    {
        return $this->addRule(new FilterRule\Defaults($defaultValue));
    }

    /**
     * Returns rule that returns an value in a specific encoding format
     *
     * @param string|null $toEncodingFormat
     * @param string|null $fromEncodingFormat
     * @return FilterResource
     */
    public function encode($toEncodingFormat = null, $fromEncodingFormat = null)
    {
        return $this->addRule(new FilterRule\Encode($toEncodingFormat, $fromEncodingFormat));
    }

    /**
     * Returns rule that results a casted float
     *
     * @return $this
     */
    public function float()
    {
        return $this->addRule(new FilterRule\CastFloat);
    }

    /**
     * Returns rule that results a casted int
     *
     * @return $this
     */
    public function int()
    {
        return $this->addRule(new FilterRule\CastInt);
    }

    /**
     * Returns rule that results all letters of a value
     *
     * @return $this
     */
    public function letters()
    {
        return $this->addRule(new FilterRule\Letters);
    }

    /**
     * Returns rule that results a lower-cased value
     *
     * @return $this
     */
    public function lower()
    {
        return $this->addRule(new FilterRule\Lower);
    }

    /**
     * Returns rule that formats numbers
     *
     * @param int $decimals
     * @param string $decimalPoint
     * @param string $thousandSeparator
     * @return $this
     */
    public function numberFormat($decimals, $decimalPoint, $thousandSeparator)
    {
        return $this->addRule(new FilterRule\NumberFormat($decimals, $decimalPoint, $thousandSeparator));
    }

    /**
     * Returns rule that results all numbers of a value
     *
     * @return $this
     */
    public function numbers()
    {
        return $this->addRule(new FilterRule\Numbers);
    }

    /**
     * Results rule that returns the value prepended with a given value
     *
     * @param string $prepend
     * @return Chain
     */
    public function prepend($prepend)
    {
        return $this->addRule(new FilterRule\Prepend($prepend));
    }

    /**
     * Results rule that returns a value with replacements by a regex
     *
     * @param string $searchRegex
     * @param string $replace
     * @return $this
     */
    public function regexReplace($searchRegex, $replace)
    {
        return $this->addRule(new FilterRule\RegexReplace($searchRegex, $replace));
    }

    /**
     * Results rule that returns a value with replacements
     *
     * @param mixed $search
     * @param mixed $replace
     * @return $this
     */
    public function replace($search, $replace)
    {
        return $this->addRule(new FilterRule\Replace($search, $replace));
    }

    /**
     * Returns rule that results a casted string
     *
     * @return $this
     */
    public function string()
    {
        return $this->addRule(new FilterRule\CastString);
    }

    /**
     * Results rule that results a html-stripped value
     *
     * @param null|string $excludeTags
     * @return $this
     */
    public function stripHtml($excludeTags = null)
    {
        return $this->addRule(new FilterRule\StripHtml($excludeTags));
    }

    /**
     * Returns rule that results a trimmed value
     *
     * @param string|null $characters
     * @return $this
     */
    public function trim($characters = null)
    {
        return $this->addRule(new FilterRule\Trim($characters));
    }

    /**
     * Results rule that returns an upper-cased value
     *
     * @return $this
     */
    public function upper()
    {
        return $this->addRule(new FilterRule\Upper);
    }

    /**
     * Returns rule that results a value starting with a upper-cased character
     *
     * @return $this
     */
    public function upperFirst()
    {
        return $this->addRule(new FilterRule\UpperFirst);
    }

    /**
     * Add a new rule to the chain
     *
     * @param FilterRule $rule
     * @return $this
     */
    protected function addRule(FilterRule $rule)
    {
        if ($this->keys === null) {
            $this->filter->addFilterRule($rule);
        }

        if (is_array($this->keys)) {
            foreach ($this->keys as $key) {
                $this->filter->addFilterRule($rule, $key);
            }
        } else {
            $this->filter->addFilterRule($rule, $this->keys);
        }

        return $this;
    }
}


1		<?php
2		/**
3		* Particle.
4		*
5		* @link http://github.com/particle-php for the canonical source repository
6		* @copyright Copyright (c) 2005-2015 Particle (http://particle-php.com)
7		* @license https://github.com/particle-php/Filter/blob/master/LICENSE New BSD License
8		*/
9		namespace Particle\Filter;
10
11		/**
12		* Class FilterResource
13		* @package Particle\Filter
14		*/
15		class FilterResource
16		{
17		/**
18		* @var Filter
19		*/
20		protected $filter;
21
22		/**
23		* @var null\|string\|string[]
24		*/
25		protected $keys;
26
27		/**
28		* @param Filter $filter
29		* @param null\|string\|string[] $keys
30		*/
31	148	public function __construct(Filter $filter, $keys = null)
32		{
33	148	$this->filter = $filter;
34	148	$this->keys = $keys;
35	148	}
36
37		/**
38		* Results rule that returns alphabetic numeric characters from the value
39		*
40		* @return $this
41		*/
42	4	public function alnum()
43		{
44	4	return $this->addRule(new FilterRule\Alnum);
45		}
46
47		/**
48		* Results rule that returns the value appended with a given value
49		*
50		* @param string $append
51		* @return Chain
52		*/
53	4	public function append($append)
54		{
55	4	return $this->addRule(new FilterRule\Append($append));
56		}
57
58		/**
59		* Results rule that returns a casted boolean
60		*
61		* @return $this
62		*/
63	16	public function bool()
64		{
65	16	return $this->addRule(new FilterRule\CastBool);
66		}
67
68		/**
69		* Returns rule that returns a value modified by a callable closure
70		*
71		* @param callable $callable
72		* @param bool $allowNotSet
73		* @return $this
74		*/
75	4	public function callback(callable $callable, $allowNotSet = false)
76		{
77	4	return $this->addRule(new FilterRule\Callback($callable, $allowNotSet));
78		}
79
80		/**
81		* Returns rule that defaults a given value if the data key was not provided
82		*
83		* @param mixed $defaultValue
84		* @return $this
85		*/
86	13	public function defaults($defaultValue)
87		{
88	13	return $this->addRule(new FilterRule\Defaults($defaultValue));
89		}
90
91		/**
92		* Returns rule that returns an value in a specific encoding format
93		*
94		* @param string\|null $toEncodingFormat
95		* @param string\|null $fromEncodingFormat
96		* @return FilterResource
97		*/
98	5	public function encode($toEncodingFormat = null, $fromEncodingFormat = null)
99		{
100	5	return $this->addRule(new FilterRule\Encode($toEncodingFormat, $fromEncodingFormat));
101		}
102
103		/**
104		* Returns rule that results a casted float
105		*
106		* @return $this
107		*/
108	12	public function float()
109		{
110	12	return $this->addRule(new FilterRule\CastFloat);
111		}
112
113		/**
114		* Returns rule that results a casted int
115		*
116		* @return $this
117		*/
118	11	public function int()
119		{
120	11	return $this->addRule(new FilterRule\CastInt);
121		}
122
123		/**
124		* Returns rule that results all letters of a value
125		*
126		* @return $this
127		*/
128	3	public function letters()
129		{
130	3	return $this->addRule(new FilterRule\Letters);
131		}
132
133		/**
134		* Returns rule that results a lower-cased value
135		*
136		* @return $this
137		*/
138	16	public function lower()
139		{
140	16	return $this->addRule(new FilterRule\Lower);
141		}
142
143		/**
144		* Returns rule that formats numbers
145		*
146		* @param int $decimals
147		* @param string $decimalPoint
148		* @param string $thousandSeparator
149		* @return $this
150		*/
151	12	public function numberFormat($decimals, $decimalPoint, $thousandSeparator)
152		{
153	12	return $this->addRule(new FilterRule\NumberFormat($decimals, $decimalPoint, $thousandSeparator));
154		}
155
156		/**
157		* Returns rule that results all numbers of a value
158		*
159		* @return $this
160		*/
161	3	public function numbers()
162		{
163	3	return $this->addRule(new FilterRule\Numbers);
164		}
165
166		/**
167		* Results rule that returns the value prepended with a given value
168		*
169		* @param string $prepend
170		* @return Chain
171		*/
172	4	public function prepend($prepend)
173		{
174	4	return $this->addRule(new FilterRule\Prepend($prepend));
175		}
176
177		/**
178		* Results rule that returns a value with replacements by a regex
179		*
180		* @param string $searchRegex
181		* @param string $replace
182		* @return $this
183		*/
184	2	public function regexReplace($searchRegex, $replace)
185		{
186	2	return $this->addRule(new FilterRule\RegexReplace($searchRegex, $replace));
187		}
188
189		/**
190		* Results rule that returns a value with replacements
191		*
192		* @param mixed $search
193		* @param mixed $replace
194		* @return $this
195		*/
196	5	public function replace($search, $replace)
197		{
198	5	return $this->addRule(new FilterRule\Replace($search, $replace));
199		}
200
201		/**
202		* Returns rule that results a casted string
203		*
204		* @return $this
205		*/
206	7	public function string()
207		{
208	7	return $this->addRule(new FilterRule\CastString);
209		}
210
211		/**
212		* Results rule that results a html-stripped value
213		*
214		* @param null\|string $excludeTags
215		* @return $this
216		*/
217	4	public function stripHtml($excludeTags = null)
218		{
219	4	return $this->addRule(new FilterRule\StripHtml($excludeTags));
220		}
221
222		/**
223		* Returns rule that results a trimmed value
224		*
225		* @param string\|null $characters
226		* @return $this
227		*/
228	21	public function trim($characters = null)
229		{
230	21	return $this->addRule(new FilterRule\Trim($characters));
231		}
232
233		/**
234		* Results rule that returns an upper-cased value
235		*
236		* @return $this
237		*/
238	6	public function upper()
239		{
240	6	return $this->addRule(new FilterRule\Upper);
241		}
242
243		/**
244		* Returns rule that results a value starting with a upper-cased character
245		*
246		* @return $this
247		*/
248	14	public function upperFirst()
249		{
250	14	return $this->addRule(new FilterRule\UpperFirst);
251		}
252
253		/**
254		* Add a new rule to the chain
255		*
256		* @param FilterRule $rule
257		* @return $this
258		*/
259	147	protected function addRule(FilterRule $rule)
260		{
261	147	if ($this->keys === null) {
262	2	$this->filter->addFilterRule($rule);
263	2	}
264
265	147	if (is_array($this->keys)) {
266	5	foreach ($this->keys as $key) {
267	5	$this->filter->addFilterRule($rule, $key);
268	5	}
269	5	} else {
270	143	$this->filter->addFilterRule($rule, $this->keys);
271		}
272
273	147	return $this;
274		}
275		}
276

particle-php / Filter

Push — master ( b133bf...737a42 )

FilterResource::defaults() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like