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

Completed

Pull Request — master (#4)

by Todd

created 2017-03-12 02:15 UTC

ValidationField::hasVal() A

↳ Parent: ValidationField

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

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

namespace Garden\Schema;

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

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

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

    /**
     * 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.
     */
    public function __construct(Validation $validation, $field, $name) {
        $this->field = $field;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->validation = $validation;
        $this->name = $name;
$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|null Returns a type string or null if there isn't one.
     */
    public function getType() {
        return isset($this->field['type']) ? $this->field['type'] : null;
    }

    /**
     * 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());
    }
}


1		<?php
2		/**
3		* @author Todd Burry <[email protected]>
4		* @copyright 2009-2017 Vanilla Forums Inc.
5		* @license Proprietary
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		* Construct a new {@link ValidationField} object.
31		*
32		* @param Validation $validation The validation object that contains errors.
33		* @param array\|Schema $field The field definition.
34		* @param string $name The path to the field.
35		*/
36	116	public function __construct(Validation $validation, $field, $name) {
37	116	$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...
38	116	$this->validation = $validation;
39	116	$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...
40	116	}
41
42		/**
43		* Add a validation error.
44		*
45		* @param string $error The message code.
46		* @param int\|array $options An array of additional information to add to the error entry or a numeric error code.
47		* @return $this
48		* @see Validation::addError()
49		*/
50	18	public function addError($error, $options = []) {
51	18	$this->validation->addError($this->getName(), $error, $options);
52	18	return $this;
53		}
54
55		/**
56		* Add an invalid type error.
57		*
58		* @param string $type The type that was checked.
59		* @return $this
60		*/
61	52	public function addTypeError($type = '') {
62	52	$type = $type ?: $this->getType();
63
64	52	$this->validation->addError(
65	52	$this->getName(),
66	52	'invalid',
67		[
68	52	'type' => $type,
69	52	'messageCode' => '{field} is not a valid {type}.',
70	52	'status' => 422
71		]
72		);
73
74	52	return $this;
75		}
76
77		/**
78		* Check whether or not this field is has errors.
79		*
80		* @return bool Returns true if the field has no errors, false otherwise.
81		*/
82	49	public function isValid() {
83	49	return $this->getValidation()->isValidField($this->getName());
84		}
85
86		/**
87		* Merge a validation object to this one.
88		*
89		* @param Validation $validation The validation object to merge.
90		* @return $this
91		*/
92		public function merge(Validation $validation) {
93		$this->getValidation()->merge($validation, $this->getName());
94		return $this;
95		}
96
97		/**
98		* Get the field.
99		*
100		* @return array\|Schema Returns the field.
101		*/
102	116	public function getField() {
103	116	return $this->field;
104		}
105
106		/**
107		* Set the field.
108		*
109		* This method is only meant to be called from within the schema class.
110		*
111		* @param array\|Schema $field The new field.
112		* @return $this
113		*/
114	75	public function setField($field) {
115	75	$this->field = $field;
116	75	return $this;
117		}
118
119		/**
120		* Get the validation.
121		*
122		* @return Validation Returns the validation.
123		*/
124	116	public function getValidation() {
125	116	return $this->validation;
126		}
127
128		/**
129		* Get the name.
130		*
131		* @return string Returns the name.
132		*/
133	116	public function getName() {
134	116	return $this->name;
135		}
136
137		/**
138		* Set the name.
139		*
140		* This method is only meant to be called from within the schema class.
141		*
142		* @param string $name The new name.
143		* @return $this
144		*/
145	75	public function setName($name) {
146	75	$this->name = $name;
147	75	return $this;
148		}
149
150		/**
151		* Get the field type.
152		*
153		* @return string\|null Returns a type string or null if there isn't one.
154		*/
155	116	public function getType() {
156	116	return isset($this->field['type']) ? $this->field['type'] : null;
157		}
158
159		/**
160		* Get a value fom the field.
161		*
162		* @param string $key The key to look at.
163		* @param mixed $default The default to return if the key isn't found.
164		* @return mixed Returns a value or the default.
165		*/
166	115	public function val($key, $default = null) {
167	115	return isset($this->field[$key]) ? $this->field[$key] : $default;
168		}
169
170		/**
171		* Whether or not the field has a value.
172		*
173		* @param string $key The key to look at.
174		* @return bool Returns true if the field has a key or false otherwise.
175		*/
176	20	public function hasVal($key) {
177	20	return array_key_exists($key, $this->field);
178		}
179
180		/**
181		* Get the error count for this field.
182		*/
183	48	public function getErrorCount() {
184	48	return $this->getValidation()->getErrorCount($this->getName());
185		}
186		}
187

vanilla / garden-schema

Pull Request — master (#4)

ValidationField::hasVal() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like