ValidationField::hasType() - Code Metrics - Inspection of "Add support for multiple types" - vanilla/garden-schema - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#21)

by Todd

created 2017-10-15 23:48 UTC

ValidationField::hasType() A

↳ Parent: ValidationField

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/**
 * @author Todd Burry <[email protected]>
 * @copyright 2009-2017 Vanilla Forums Inc.
 * @license MIT
 */

namespace Garden\Schema;

/**
 * A parameters class for field validation.
 */
class ValidationField {
    /**
     * @var array|Schema
     */
    private $field;

    /**
     * @var Validation
     */
    private $validation;

    /**
     * @var string
     */
    private $name;

    /**
     * @var bool
     */
    private $sparse;

    /**
     * Construct a new {@link ValidationField} object.
     *
     * @param Validation $validation The validation object that contains errors.
     * @param array|Schema $field The field definition.
     * @param string $name The path to the field.
     * @param bool $sparse Whether this is a sparse validation or not.
     */
    public function __construct(Validation $validation, $field, $name, $sparse = false) {
        $this->field = $field;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->validation = $validation;
        $this->name = $name;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->sparse = $sparse;
$a = "a";
$ab = "ab";
$abc = "abc";
    }

    /**
     * Add a validation error.
     *
     * @param string $error The message code.
     * @param int|array $options An array of additional information to add to the error entry or a numeric error code.
     * @return $this
     * @see Validation::addError()
     */
    public function addError($error, $options = []) {
        $this->validation->addError($this->getName(), $error, $options);
        return $this;
    }

    /**
     * Add an invalid type error.
     *
     * @param string $type The type that was checked.
     * @return $this
     */
    public function addTypeError($type = '') {
        $type = $type ?: $this->getType();

        $this->validation->addError(
            $this->getName(),
            'invalid',
            [
                'type' => $type,
                'messageCode' => '{field} is not a valid {type}.',
                'status' => 422
            ]
        );

        return $this;
    }

    /**
     * Check whether or not this field is has errors.
     *
     * @return bool Returns true if the field has no errors, false otherwise.
     */
    public function isValid() {
        return $this->getValidation()->isValidField($this->getName());
    }

    /**
     * Merge a validation object to this one.
     *
     * @param Validation $validation The validation object to merge.
     * @return $this
     */
    public function merge(Validation $validation) {
        $this->getValidation()->merge($validation, $this->getName());
        return $this;
    }

    /**
     * Get the field.
     *
     * @return array|Schema Returns the field.
     */
    public function getField() {
        return $this->field;
    }

    /**
     * Set the field.
     *
     * This method is only meant to be called from within the schema class.
     *
     * @param array|Schema $field The new field.
     * @return $this
     */
    public function setField($field) {
        $this->field = $field;
        return $this;
    }

    /**
     * Get the validation.
     *
     * @return Validation Returns the validation.
     */
    public function getValidation() {
        return $this->validation;
    }

    /**
     * Get the name.
     *
     * @return string Returns the name.
     */
    public function getName() {
        return $this->name;
    }

    /**
     * Set the name.
     *
     * This method is only meant to be called from within the schema class.
     *
     * @param string $name The new name.
     * @return $this
     */
    public function setName($name) {
        $this->name = $name;
        return $this;
    }

    /**
     * Get the field type.
     *
     * @return string|string[]|null Returns a type string, array of type strings, or null if there isn't one.
     */
    public function getType() {
        return isset($this->field['type']) ? $this->field['type'] : null;
    }

    /**
     * Whether or not the field has a given type.
     *
     * @param string $type The single type to test.
     * @return bool Returns **true** if the field has the given type or **false** otherwise.
     */
    public function hasType($type) {
        return in_array($type, (array)$this->getType());
    }

    /**
     * Get a value fom the field.
     *
     * @param string $key The key to look at.
     * @param mixed $default The default to return if the key isn't found.
     * @return mixed Returns a value or the default.
     */
    public function val($key, $default = null) {
        return isset($this->field[$key]) ? $this->field[$key] : $default;
    }

    /**
     * Whether or not the field has a value.
     *
     * @param string $key The key to look at.
     * @return bool Returns **true** if the field has a key or **false** otherwise.
     */
    public function hasVal($key) {
        return array_key_exists($key, $this->field);
    }

    /**
     * Get the error count for this field.
     */
    public function getErrorCount() {
        return $this->getValidation()->getErrorCount($this->getName());
    }

    /**
     * Whether or not this is a sparse validation..
     *
     * @return bool Returns **true** if this is a sparse validation or **false** otherwise.
     */
    public function isSparse() {
        return $this->sparse;
    }
}


1		<?php
2		/**
3		* @author Todd Burry <[email protected]>
4		* @copyright 2009-2017 Vanilla Forums Inc.
5		* @license MIT
6		*/
7
8		namespace Garden\Schema;
9
10		/**
11		* A parameters class for field validation.
12		*/
13		class ValidationField {
14		/**
15		* @var array\|Schema
16		*/
17		private $field;
18
19		/**
20		* @var Validation
21		*/
22		private $validation;
23
24		/**
25		* @var string
26		*/
27		private $name;
28
29		/**
30		* @var bool
31		*/
32		private $sparse;
33
34		/**
35		* Construct a new {@link ValidationField} object.
36		*
37		* @param Validation $validation The validation object that contains errors.
38		* @param array\|Schema $field The field definition.
39		* @param string $name The path to the field.
40		* @param bool $sparse Whether this is a sparse validation or not.
41		*/
42	155	public function __construct(Validation $validation, $field, $name, $sparse = false) {
43	155	$this->field = $field;
		0 ignored issues – show Coding Style introduced 2017-03-10 02:48 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
44	155	$this->validation = $validation;
45	155	$this->name = $name;
		0 ignored issues – show Coding Style introduced 2017-03-10 02:48 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
46	155	$this->sparse = $sparse;
		0 ignored issues – show Coding Style introduced 2017-03-21 14:28 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
47	155	}
48
49		/**
50		* Add a validation error.
51		*
52		* @param string $error The message code.
53		* @param int\|array $options An array of additional information to add to the error entry or a numeric error code.
54		* @return $this
55		* @see Validation::addError()
56		*/
57	20	public function addError($error, $options = []) {
58	20	$this->validation->addError($this->getName(), $error, $options);
59	20	return $this;
60		}
61
62		/**
63		* Add an invalid type error.
64		*
65		* @param string $type The type that was checked.
66		* @return $this
67		*/
68	44	public function addTypeError($type = '') {
69	44	$type = $type ?: $this->getType();
70
71	44	$this->validation->addError(
72	44	$this->getName(),
73	44	'invalid',
74		[
75	44	'type' => $type,
76	44	'messageCode' => '{field} is not a valid {type}.',
77	44	'status' => 422
78		]
79		);
80
81	44	return $this;
82		}
83
84		/**
85		* Check whether or not this field is has errors.
86		*
87		* @return bool Returns true if the field has no errors, false otherwise.
88		*/
89	59	public function isValid() {
90	59	return $this->getValidation()->isValidField($this->getName());
91		}
92
93		/**
94		* Merge a validation object to this one.
95		*
96		* @param Validation $validation The validation object to merge.
97		* @return $this
98		*/
99		public function merge(Validation $validation) {
100		$this->getValidation()->merge($validation, $this->getName());
101		return $this;
102		}
103
104		/**
105		* Get the field.
106		*
107		* @return array\|Schema Returns the field.
108		*/
109	155	public function getField() {
110	155	return $this->field;
111		}
112
113		/**
114		* Set the field.
115		*
116		* This method is only meant to be called from within the schema class.
117		*
118		* @param array\|Schema $field The new field.
119		* @return $this
120		*/
121	86	public function setField($field) {
122	86	$this->field = $field;
123	86	return $this;
124		}
125
126		/**
127		* Get the validation.
128		*
129		* @return Validation Returns the validation.
130		*/
131	155	public function getValidation() {
132	155	return $this->validation;
133		}
134
135		/**
136		* Get the name.
137		*
138		* @return string Returns the name.
139		*/
140	155	public function getName() {
141	155	return $this->name;
142		}
143
144		/**
145		* Set the name.
146		*
147		* This method is only meant to be called from within the schema class.
148		*
149		* @param string $name The new name.
150		* @return $this
151		*/
152	96	public function setName($name) {
153	96	$this->name = $name;
154	96	return $this;
155		}
156
157		/**
158		* Get the field type.
159		*
160		* @return string\|string[]\|null Returns a type string, array of type strings, or null if there isn't one.
161		*/
162	155	public function getType() {
163	155	return isset($this->field['type']) ? $this->field['type'] : null;
164		}
165
166		/**
167		* Whether or not the field has a given type.
168		*
169		* @param string $type The single type to test.
170		* @return bool Returns true if the field has the given type or false otherwise.
171		*/
172		public function hasType($type) {
173		return in_array($type, (array)$this->getType());
174		}
175
176		/**
177		* Get a value fom the field.
178		*
179		* @param string $key The key to look at.
180		* @param mixed $default The default to return if the key isn't found.
181		* @return mixed Returns a value or the default.
182		*/
183	155	public function val($key, $default = null) {
184	155	return isset($this->field[$key]) ? $this->field[$key] : $default;
185		}
186
187		/**
188		* Whether or not the field has a value.
189		*
190		* @param string $key The key to look at.
191		* @return bool Returns true if the field has a key or false otherwise.
192		*/
193	23	public function hasVal($key) {
194	23	return array_key_exists($key, $this->field);
195		}
196
197		/**
198		* Get the error count for this field.
199		*/
200	58	public function getErrorCount() {
201	58	return $this->getValidation()->getErrorCount($this->getName());
202		}
203
204		/**
205		* Whether or not this is a sparse validation..
206		*
207		* @return bool Returns true if this is a sparse validation or false otherwise.
208		*/
209		public function isSparse() {
210		return $this->sparse;
211		}
212		}
213

vanilla / garden-schema

Pull Request — master (#21)

ValidationField::hasType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like