AbstractValidator::getMessages() - Code Metrics - Salah3id/address-domains - Measure and Improve Code Quality continuously with Scrutinizer

AbstractValidator::getMessages() A
last analyzed 2022-12-18 20:43 UTC

↳ Parent: AbstractValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php namespace Salah3id\Domains\Validator;

use Illuminate\Support\MessageBag;
use Salah3id\Domains\Validator\Contracts\ValidatorInterface;
use Salah3id\Domains\Validator\Exceptions\ValidatorException;

/**
 * Class AbstractValidator
 * @package Salah3id\Domains\Validator
 * @author Anderson Andrade <[email protected]>
 */
abstract class AbstractValidator implements ValidatorInterface
{
    /**
     * @var int
     */
    protected $id = null;

    /**
     * Validator
     *
     * @var object
     */
    protected $validator;

    /**
     * Data to be validated
     *
     * @var array
     */
    protected $data = array();

    /**
     * Validation Rules
     *
     * @var array
     */
    protected $rules = array();

    /**
     * Validation Custom Messages
     *
     * @var array
     */
    protected $messages = array();

    /**
     * Validation Custom Attributes
     *
     * @var array
     */
    protected $attributes = array();

    /**
     * Validation errors
     *
     * @var MessageBag
     */
    protected $errors = array();


    /**
     * Set Id
     *
     * @param $id
     * @return $this
     */
    public function setId($id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * Set data to validate
     *
     * @param array $data
     * @return $this
     */
    public function with(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Return errors
     *
     * @return array
     */
    public function errors()
    {
        return $this->errorsBag()->all();
    }

    /**
     * Errors
     *
     * @return MessageBag
     */
    public function errorsBag()
    {
        return $this->errors;
    }

    /**
     * Pass the data and the rules to the validator
     *
     * @param string $action
     * @return boolean
     */
    abstract public function passes($action = null);

    /**
     * Pass the data and the rules to the validator or throws ValidatorException
     *
     * @throws ValidatorException
     * @param string $action
     * @return boolean
     */
    public function passesOrFail($action = null)
    {
        if (!$this->passes($action)) {
            throw new ValidatorException($this->errorsBag());
        }

        return true;
    }

    /**
     * Get rule for validation by action ValidatorInterface::RULE_CREATE or ValidatorInterface::RULE_UPDATE
     *
     * Default rule: ValidatorInterface::RULE_CREATE
     *
     * @param null $action

     * @return array
     */
    public function getRules($action = null)
    {
        $rules = $this->rules;

        if (isset($this->rules[$action])) {
            $rules = $this->rules[$action];
        }

        return $this->parserValidationRules($rules, $this->id);
    }

    /**
     * Set Rules for Validation
     *
     * @param array $rules
     * @return $this
     */
    public function setRules(array $rules)
    {
        $this->rules = $rules;
        return $this;
    }

    /**
     * Get Custom error messages for validation
     *
     * @return array
     */
    public function getMessages()
    {
        return $this->messages;
    }

    /**
     * Set Custom error messages for Validation
     *
     * @param array $messages
     * @return $this
     */
    public function setMessages(array $messages)
    {
        $this->messages = $messages;
        return $this;
    }

    /**
     * Get Custom error attributes for validation
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Set Custom error attributes for Validation
     *
     * @param array $attributes
     * @return $this
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
        return $this;
    }

    /**
     * Parser Validation Rules
     *
     * @param $rules
     * @param null $id

     * @return array
     */
    protected function parserValidationRules($rules, $id = null)
    {
        if (null === $id) {

            return $rules;
        }

        array_walk($rules, function (&$rules, $field) use ($id) {
            if (!is_array($rules)) {
                $rules = explode("|", $rules);
            }

            foreach ($rules as $ruleIdx => $rule) {
                // get name and parameters
                @list($name, $params) = array_pad(explode(":", $rule), 2, null);

                // only do someting for the unique rule
                if (strtolower($name) != "unique") {
                    continue; // continue in foreach loop, nothing left to do here
                }

                $p = array_map("trim", explode(",", $params));

                // set field name to rules key ($field) (laravel convention)
                if (!isset($p[1])) {
                    $p[1] = $field;
                }

                // set 3rd parameter to id given to getValidationRules()
                $p[2] = $id;

                $params = implode(",", $p);
                $rules[$ruleIdx] = $name.":".$params;
            }
        });

        return $rules;
    }
}


1			<?php namespace Salah3id\Domains\Validator;
2
3			use Illuminate\Support\MessageBag;
4			use Salah3id\Domains\Validator\Contracts\ValidatorInterface;
5			use Salah3id\Domains\Validator\Exceptions\ValidatorException;
6
7			/**
8			* Class AbstractValidator
9			* @package Salah3id\Domains\Validator
10			* @author Anderson Andrade <[email protected]>
11			*/
12			abstract class AbstractValidator implements ValidatorInterface
13			{
14			/**
15			* @var int
16			*/
17			protected $id = null;
18
19			/**
20			* Validator
21			*
22			* @var object
23			*/
24			protected $validator;
25
26			/**
27			* Data to be validated
28			*
29			* @var array
30			*/
31			protected $data = array();
32
33			/**
34			* Validation Rules
35			*
36			* @var array
37			*/
38			protected $rules = array();
39
40			/**
41			* Validation Custom Messages
42			*
43			* @var array
44			*/
45			protected $messages = array();
46
47			/**
48			* Validation Custom Attributes
49			*
50			* @var array
51			*/
52			protected $attributes = array();
53
54			/**
55			* Validation errors
56			*
57			* @var MessageBag
58			*/
59			protected $errors = array();
60
61
62			/**
63			* Set Id
64			*
65			* @param $id
66			* @return $this
67			*/
68			public function setId($id)
69			{
70			$this->id = $id;
71			return $this;
72			}
73
74			/**
75			* Set data to validate
76			*
77			* @param array $data
78			* @return $this
79			*/
80			public function with(array $data)
81			{
82			$this->data = $data;
83
84			return $this;
85			}
86
87			/**
88			* Return errors
89			*
90			* @return array
91			*/
92			public function errors()
93			{
94			return $this->errorsBag()->all();
95			}
96
97			/**
98			* Errors
99			*
100			* @return MessageBag
101			*/
102			public function errorsBag()
103			{
104			return $this->errors;
105			}
106
107			/**
108			* Pass the data and the rules to the validator
109			*
110			* @param string $action
111			* @return boolean
112			*/
113			abstract public function passes($action = null);
114
115			/**
116			* Pass the data and the rules to the validator or throws ValidatorException
117			*
118			* @throws ValidatorException
119			* @param string $action
120			* @return boolean
121			*/
122			public function passesOrFail($action = null)
123			{
124			if (!$this->passes($action)) {
125			throw new ValidatorException($this->errorsBag());
126			}
127
128			return true;
129			}
130
131			/**
132			* Get rule for validation by action ValidatorInterface::RULE_CREATE or ValidatorInterface::RULE_UPDATE
133			*
134			* Default rule: ValidatorInterface::RULE_CREATE
135			*
136			* @param null $action
			0 ignored issues – show Documentation Bug introduced 2022-12-18 20:37 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$action` is correct as it would always require `null` to be passed? Loading history...
137			* @return array
138			*/
139			public function getRules($action = null)
140			{
141			$rules = $this->rules;
142
143			if (isset($this->rules[$action])) {
144			$rules = $this->rules[$action];
145			}
146
147			return $this->parserValidationRules($rules, $this->id);
148			}
149
150			/**
151			* Set Rules for Validation
152			*
153			* @param array $rules
154			* @return $this
155			*/
156			public function setRules(array $rules)
157			{
158			$this->rules = $rules;
159			return $this;
160			}
161
162			/**
163			* Get Custom error messages for validation
164			*
165			* @return array
166			*/
167			public function getMessages()
168			{
169			return $this->messages;
170			}
171
172			/**
173			* Set Custom error messages for Validation
174			*
175			* @param array $messages
176			* @return $this
177			*/
178			public function setMessages(array $messages)
179			{
180			$this->messages = $messages;
181			return $this;
182			}
183
184			/**
185			* Get Custom error attributes for validation
186			*
187			* @return array
188			*/
189			public function getAttributes()
190			{
191			return $this->attributes;
192			}
193
194			/**
195			* Set Custom error attributes for Validation
196			*
197			* @param array $attributes
198			* @return $this
199			*/
200			public function setAttributes(array $attributes)
201			{
202			$this->attributes = $attributes;
203			return $this;
204			}
205
206			/**
207			* Parser Validation Rules
208			*
209			* @param $rules
210			* @param null $id
			0 ignored issues – show Documentation Bug introduced 2022-12-18 20:37 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$id` is correct as it would always require `null` to be passed? Loading history...
211			* @return array
212			*/
213			protected function parserValidationRules($rules, $id = null)
214			{
215			if (null === $id) {
			0 ignored issues – show introduced 2022-12-18 20:37 UTC by Report Bug Copy Issue Report The condition `null === $id` is always `true`. Loading history...
216			return $rules;
217			}
218
219			array_walk($rules, function (&$rules, $field) use ($id) {
220			if (!is_array($rules)) {
221			$rules = explode("\|", $rules);
222			}
223
224			foreach ($rules as $ruleIdx => $rule) {
225			// get name and parameters
226			@list($name, $params) = array_pad(explode(":", $rule), 2, null);
227
228			// only do someting for the unique rule
229			if (strtolower($name) != "unique") {
230			continue; // continue in foreach loop, nothing left to do here
231			}
232
233			$p = array_map("trim", explode(",", $params));
234
235			// set field name to rules key ($field) (laravel convention)
236			if (!isset($p[1])) {
237			$p[1] = $field;
238			}
239
240			// set 3rd parameter to id given to getValidationRules()
241			$p[2] = $id;
242
243			$params = implode(",", $p);
244			$rules[$ruleIdx] = $name.":".$params;
245			}
246			});
247
248			return $rules;
249			}
250			}
251

Salah3id / address-domains

AbstractValidator::getMessages() A last analyzed 2022-12-18 20:43 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractValidator::getMessages() A
last analyzed 2022-12-18 20:43 UTC