Validable::gatherRules() - Code Metrics - Inspection of "support query alias for the mapped attribute" - jarektkaczyk/eloquence - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 5.1 ( c7eca6...1f8916 )

by Jarek

created 2016-06-17 09:47 UTC

Validable::gatherRules() C

↳ Parent: Validable

Complexity

Conditions	7
Paths	9

Size

Total Lines	35
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	35
rs	6.7272
cc	7
eloc	17
nc	9
nop	0

<?php

namespace Sofa\Eloquence;

use Sofa\Eloquence\Validable\Observer;
use Illuminate\Contracts\Validation\Factory;

/**
 * @method integer getKey()
 * @method string getKeyName()
 */
trait Validable
{
    /**
     * Validation switch.
     *
     * @var boolean
     */
    protected $skipValidation = false;

    /**
     * Validator instance.
     *
     * @var \Illuminate\Contracts\Validation\Validator
     */
    protected $validator;

    /**
     * Validator factory instance.
     *
     * @var \Illuminate\Contracts\Validation\Factory
     */
    protected static $validatorFactory;

    /**
     * All the validation rules for this model.
     *
     * @var array
     */
    protected static $rulesMerged;

    /**
     * Register hooks for the trait.
     *
     * @codeCoverageIgnore
     *
     * @return void
     */
    public static function bootValidable()
    {
        static::observe(new Observer);

        if (!static::$validatorFactory) {
            if (function_exists('app') && isset(app()['validator'])) {
                static::setValidatorFactory(app('validator'));
            }
        }
    }

    /**
     * Determine whether all the attributes on this instance pass validation.
     *
     * @return boolean
     */
    public function isValid()
    {
        $this->getValidator()->setData($this->getAttributes());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this->getValidator()->passes();

    }

    /**
     * Skip validation on the next saving attempt.
     *
     * @return $this
     */
    public function skipValidation()
    {
        return $this->disableValidation($once = true);
    }

    /**
     * Disable validation for this instance.
     *
     * @return $this
     */
    public function disableValidation($once = false)
    {
        $this->skipValidation = ($once) ? Observer::SKIP_ONCE : Observer::SKIP_ALWAYS;

        return $this;
    }

    /**
     * Enable validation for this instance.
     *
     * @return $this
     */
    public function enableValidation()
    {
        $this->skipValidation = false;

        return $this;
    }

    /**
     * Get current validation flag.
     *
     * @return integer|false
     */
    public function skipsValidation()
    {
        return $this->skipValidation;
    }

    /**
     * Determine whether validation is enabled for this instance.
     *
     * @return boolean
     */
    public function validationEnabled()
    {
        return !$this->skipsValidation();
    }

    /**
     * Retrieve validation error messages.
     *
     * @return \Illuminate\Support\MessageBag
     */
    public function getValidationErrors()
    {
        return $this->getMessageBag();
    }

    /**
     * Retrieve validation error messages.
     *
     * @return \Illuminate\Support\MessageBag
     */
    public function getMessageBag()
    {
        return $this->getValidator()->getMessageBag();
    }

    /**
     * Get names of the attributes that didn't pass validation.
     *
     * @return array
     */
    public function getInvalidAttributes()
    {
        return array_keys($this->getValidationErrors()->toArray());
    }

    /**
     * Get the validator instance.
     *
     * @return \Illuminate\Contracts\Validation\Validator
     */
    public function getValidator()
    {
        if (!$this->validator) {
            $this->validator = static::$validatorFactory->make(
                [],
                static::getCreateRules(),
                static::getValidationMessages(),
                static::getValidationAttributes()
            );
        }

        return $this->validator;
    }

    /**
     * Get custom validation messages.
     *
     * @return array
     */
    public static function getValidationMessages()
    {
        return (property_exists(get_called_class(), 'validationMessages'))
            ? static::$validationMessages
            : [];
    }

    /**
     * Get custom validation attribute names.
     *
     * @return array
     */
    public static function getValidationAttributes()
    {
        return (property_exists(get_called_class(), 'validationAttributes'))
            ? static::$validationAttributes
            : [];
    }

    /**
     * Get all the validation rules for this model.
     *
     * @return array
     */
    public static function getCreateRules()
    {
        if (!static::$rulesMerged) {
            static::$rulesMerged = static::gatherRules();
        }

        return static::$rulesMerged;
    }

    /**
     * Gather all the rules for the model and store it for easier use.
     *
     * @return array
     */
    protected static function gatherRules()
    {
        // This rather gnarly looking logic is just for developer convenience
        // so he can define multiple rule groups on the model for clarity
        // and now we simply gather all rules and merge them together.
        $keys = static::getValidatedFields();

        $result = array_fill_keys($keys, []);

        foreach ($keys as $key) {
            foreach (static::getRulesGroups() as $groupName) {
                $group = static::getRulesGroup($groupName);

                if (isset($group[$key])) {
                    $rules = is_array($group[$key])
                            ? $group[$key]
                            : explode('|', $group[$key]);

                    foreach ($rules as &$rule) {
                        if ($rule === 'unique') {
                            $table = (new static)->getTable();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                            $rule .= ":{$table}";
                        }
                    }

                    unset($rule);

                    $result[$key] = array_unique(array_merge($result[$key], $rules));
                }
            }
        }

        return $result;
    }

    /**
     * Get all validation rules for update on this model.
     *
     * @return array
     */
    public function getUpdateRules()
    {
        return ($this->getKey()) ? static::getUpdateRulesForId($this) : static::getCreateRules();
    }

    /**
     * Get all validation rules for update for given id.
     *
     * @param  \Illuminate\Database\Eloquent\Model|integer|string $id
     * @return array
     */
    public static function getUpdateRulesForId($id)
    {
        return rules_for_update(static::getCreateRules(), $id, (new static)->getKeyName());
    }

    /**
     * Get array of attributes that have validation rules defined.
     *
     * @return array
     */
    public static function getValidatedFields()
    {
        $fields = [];

        foreach (static::getRulesGroups() as $groupName) {
            $fields = array_merge($fields, array_keys(static::getRulesGroup($groupName)));
        }

        return array_values(array_unique($fields));
    }

    /**
     * Get all the rules groups defined on this model.
     *
     * @return array
     */
    protected static function getRulesGroups()
    {
        $groups = [];

        foreach (get_class_vars(get_called_class()) as $property => $val) {
            if (preg_match('/^.*rules$/i', $property)) {
                $groups[] = $property;
            }
        }

        return $groups;
    }

    /**
     * Get rules from given group.
     *
     * @param  string $group
     * @return array
     */
    protected static function getRulesGroup($group)
    {
        return static::$$group;
    }

    /**
     * Set validation factory instance for this model.
     *
     * @param  \Illuminate\Contracts\Validation\Factory
     * @return void
     */
    public static function setValidatorFactory(Factory $factory)
    {
        static::$validatorFactory = $factory;
    }
}


1			<?php
2
3			namespace Sofa\Eloquence;
4
5			use Sofa\Eloquence\Validable\Observer;
6			use Illuminate\Contracts\Validation\Factory;
7
8			/**
9			* @method integer getKey()
10			* @method string getKeyName()
11			*/
12			trait Validable
13			{
14			/**
15			* Validation switch.
16			*
17			* @var boolean
18			*/
19			protected $skipValidation = false;
20
21			/**
22			* Validator instance.
23			*
24			* @var \Illuminate\Contracts\Validation\Validator
25			*/
26			protected $validator;
27
28			/**
29			* Validator factory instance.
30			*
31			* @var \Illuminate\Contracts\Validation\Factory
32			*/
33			protected static $validatorFactory;
34
35			/**
36			* All the validation rules for this model.
37			*
38			* @var array
39			*/
40			protected static $rulesMerged;
41
42			/**
43			* Register hooks for the trait.
44			*
45			* @codeCoverageIgnore
46			*
47			* @return void
48			*/
49			public static function bootValidable()
50			{
51			static::observe(new Observer);
52
53			if (!static::$validatorFactory) {
54			if (function_exists('app') && isset(app()['validator'])) {
55			static::setValidatorFactory(app('validator'));
56			}
57			}
58			}
59
60			/**
61			* Determine whether all the attributes on this instance pass validation.
62			*
63			* @return boolean
64			*/
65			public function isValid()
66			{
67			$this->getValidator()->setData($this->getAttributes());
			0 ignored issues – show Bug introduced 2015-11-21 12:13 UTC by Report Bug Copy Issue Report It seems like `getAttributes()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history... Bug introduced 2015-11-21 12:13 UTC by Report Bug Copy Issue Report The method `setData()` does not seem to exist on `object<Illuminate\Contracts\Validation\Validator>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
68
69			return $this->getValidator()->passes();
			0 ignored issues – show Bug introduced 2015-11-21 12:13 UTC by Report Bug Copy Issue Report The method `passes()` does not seem to exist on `object<Illuminate\Contracts\Validation\Validator>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
70			}
71
72			/**
73			* Skip validation on the next saving attempt.
74			*
75			* @return $this
76			*/
77			public function skipValidation()
78			{
79			return $this->disableValidation($once = true);
80			}
81
82			/**
83			* Disable validation for this instance.
84			*
85			* @return $this
86			*/
87			public function disableValidation($once = false)
88			{
89			$this->skipValidation = ($once) ? Observer::SKIP_ONCE : Observer::SKIP_ALWAYS;
90
91			return $this;
92			}
93
94			/**
95			* Enable validation for this instance.
96			*
97			* @return $this
98			*/
99			public function enableValidation()
100			{
101			$this->skipValidation = false;
102
103			return $this;
104			}
105
106			/**
107			* Get current validation flag.
108			*
109			* @return integer\|false
110			*/
111			public function skipsValidation()
112			{
113			return $this->skipValidation;
114			}
115
116			/**
117			* Determine whether validation is enabled for this instance.
118			*
119			* @return boolean
120			*/
121			public function validationEnabled()
122			{
123			return !$this->skipsValidation();
124			}
125
126			/**
127			* Retrieve validation error messages.
128			*
129			* @return \Illuminate\Support\MessageBag
130			*/
131			public function getValidationErrors()
132			{
133			return $this->getMessageBag();
134			}
135
136			/**
137			* Retrieve validation error messages.
138			*
139			* @return \Illuminate\Support\MessageBag
140			*/
141			public function getMessageBag()
142			{
143			return $this->getValidator()->getMessageBag();
144			}
145
146			/**
147			* Get names of the attributes that didn't pass validation.
148			*
149			* @return array
150			*/
151			public function getInvalidAttributes()
152			{
153			return array_keys($this->getValidationErrors()->toArray());
154			}
155
156			/**
157			* Get the validator instance.
158			*
159			* @return \Illuminate\Contracts\Validation\Validator
160			*/
161			public function getValidator()
162			{
163			if (!$this->validator) {
164			$this->validator = static::$validatorFactory->make(
165			[],
166			static::getCreateRules(),
167			static::getValidationMessages(),
168			static::getValidationAttributes()
169			);
170			}
171
172			return $this->validator;
173			}
174
175			/**
176			* Get custom validation messages.
177			*
178			* @return array
179			*/
180			public static function getValidationMessages()
181			{
182			return (property_exists(get_called_class(), 'validationMessages'))
183			? static::$validationMessages
184			: [];
185			}
186
187			/**
188			* Get custom validation attribute names.
189			*
190			* @return array
191			*/
192			public static function getValidationAttributes()
193			{
194			return (property_exists(get_called_class(), 'validationAttributes'))
195			? static::$validationAttributes
196			: [];
197			}
198
199			/**
200			* Get all the validation rules for this model.
201			*
202			* @return array
203			*/
204			public static function getCreateRules()
205			{
206			if (!static::$rulesMerged) {
207			static::$rulesMerged = static::gatherRules();
208			}
209
210			return static::$rulesMerged;
211			}
212
213			/**
214			* Gather all the rules for the model and store it for easier use.
215			*
216			* @return array
217			*/
218			protected static function gatherRules()
219			{
220			// This rather gnarly looking logic is just for developer convenience
221			// so he can define multiple rule groups on the model for clarity
222			// and now we simply gather all rules and merge them together.
223			$keys = static::getValidatedFields();
224
225			$result = array_fill_keys($keys, []);
226
227			foreach ($keys as $key) {
228			foreach (static::getRulesGroups() as $groupName) {
229			$group = static::getRulesGroup($groupName);
230
231			if (isset($group[$key])) {
232			$rules = is_array($group[$key])
233			? $group[$key]
234			: explode('\|', $group[$key]);
235
236			foreach ($rules as &$rule) {
237			if ($rule === 'unique') {
238			$table = (new static)->getTable();
			0 ignored issues – show Bug introduced 2015-11-21 12:13 UTC by Report Bug Copy Issue Report It seems like `getTable()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
239
240			$rule .= ":{$table}";
241			}
242			}
243
244			unset($rule);
245
246			$result[$key] = array_unique(array_merge($result[$key], $rules));
247			}
248			}
249			}
250
251			return $result;
252			}
253
254			/**
255			* Get all validation rules for update on this model.
256			*
257			* @return array
258			*/
259			public function getUpdateRules()
260			{
261			return ($this->getKey()) ? static::getUpdateRulesForId($this) : static::getCreateRules();
262			}
263
264			/**
265			* Get all validation rules for update for given id.
266			*
267			* @param \Illuminate\Database\Eloquent\Model\|integer\|string $id
268			* @return array
269			*/
270			public static function getUpdateRulesForId($id)
271			{
272			return rules_for_update(static::getCreateRules(), $id, (new static)->getKeyName());
273			}
274
275			/**
276			* Get array of attributes that have validation rules defined.
277			*
278			* @return array
279			*/
280			public static function getValidatedFields()
281			{
282			$fields = [];
283
284			foreach (static::getRulesGroups() as $groupName) {
285			$fields = array_merge($fields, array_keys(static::getRulesGroup($groupName)));
286			}
287
288			return array_values(array_unique($fields));
289			}
290
291			/**
292			* Get all the rules groups defined on this model.
293			*
294			* @return array
295			*/
296			protected static function getRulesGroups()
297			{
298			$groups = [];
299
300			foreach (get_class_vars(get_called_class()) as $property => $val) {
301			if (preg_match('/^.*rules$/i', $property)) {
302			$groups[] = $property;
303			}
304			}
305
306			return $groups;
307			}
308
309			/**
310			* Get rules from given group.
311			*
312			* @param string $group
313			* @return array
314			*/
315			protected static function getRulesGroup($group)
316			{
317			return static::$$group;
318			}
319
320			/**
321			* Set validation factory instance for this model.
322			*
323			* @param \Illuminate\Contracts\Validation\Factory
324			* @return void
325			*/
326			public static function setValidatorFactory(Factory $factory)
327			{
328			static::$validatorFactory = $factory;
329			}
330			}
331

jarektkaczyk / eloquence

Push — 5.1 ( c7eca6...1f8916 )

Validable::gatherRules() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like