WordPoints_Hook_Event_Args::__construct() - Code Metrics - Inspection of "PHPUnit: new entity factory" - WordPoints/hooks-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 637b3c...faeb69 )

by J.D.

created 2016-01-14 15:24 UTC

WordPoints_Hook_Event_Args::__construct() B

↳ Parent: WordPoints_Hook_Event_Args

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	22
rs	8.9197
cc	4
eloc	11
nc	4
nop	1

<?php

/**
 * Hook event args class.
 *
 * @package wordpoints-hooks-api
 * @since   1.0.0
 */

/**
 * Represents the args associated with a hook event.
 *
 * This is similar to the regular entity hierarchy, except that it handles errors
 * with the reaction validators, and accepts an array of hook args instead of
 * requiring entity objects to be passed directly.
 *
 * @since 1.0.0
 */
class WordPoints_Hook_Event_Args extends WordPoints_Entity_Hierarchy {

	/**
	 * Whether the event is repeatable.
	 *
	 * @since 1.0.0
	 *
	 * @var bool
	 */
	protected $is_repeatable = true;

	/**
	 * The slug of the primary arg for this event, if it has one.
	 *
	 * @since 1.0.0
	 *
	 * @var string|false
	 */
	protected $primary_arg_slug = false;

	/**
	 * The validator associated with the current hook reaction.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_Hook_Reaction_Validator
	 */
	protected $validator;

	/**
	 * Whether to push fields onto the validator when we descend into the hierarchy.
	 *
	 * This will usually be true, however, when we are getting a value from the
	 * hierarchy, we aren't actually descending into a sub-field, but descending
	 * down the arg hierarchy stored within a field.
	 *
	 * @since 1.0.0
	 *
	 * @var bool
	 */
	protected $push_on_descend = true;

	/**
	 * Construct the object with the arg objects.
	 *
	 * @param WordPoints_Hook_Arg[] $args The hook args.
	 */
	public function __construct( array $args ) {

		parent::__construct();

		foreach ( $args as $arg ) {

			$entity = $arg->get_entity();
			$slug = $arg->get_slug();

			if ( ! $entity instanceof WordPoints_Entity ) {
				continue;
			}

			$this->entities[ $slug ] = $entity;

			if ( ! $arg->is_stateful() ) {
				// If any of the args aren't stateful the event isn't repeatable.
				$this->is_repeatable = false;
				$this->primary_arg_slug = $slug;
			}
		}
	}

	/**
	 * Whether the event is repeatable.
	 *
	 * An event is repeatable if none of its args have their status toggled by the
	 * event. In that case, it is possible for the event to occur with those same args
	 * multiple times in a row without being reversed in between.
	 *
	 * An arg that has its status modified is called a signature arg. One that does
	 * not is called a stateful arg. An event is repeatable if it has no signature
	 * args, only stateful ones.
	 *
	 * @since 1.0.0
	 *
	 * @return bool Whether the event is repeatable.
	 */
	public function is_event_repeatable() {
		return $this->is_repeatable;
	}

	/**
	 * Get the stateful args for this event.
	 *
	 * @since 1.0.0
	 *
	 * @return WordPoints_Entity[] The entity objects for the stateful args.
	 */
	public function get_stateful_args() {

		$stateful = $this->entities;

		if ( $this->primary_arg_slug ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			unset( $stateful[ $this->primary_arg_slug ] );
		}

		return $stateful;
	}

	/**
	 * Get the primary arg for this event.
	 *
	 * @since 1.0.0
	 *
	 * @return WordPoints_Entity|false The entity objects for the primary arg, or
	 *                                 false if this entity has none.
	 */
	public function get_primary_arg() {

		if ( ! $this->primary_arg_slug ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			return false;
		}

		return $this->entities[ $this->primary_arg_slug ];
	}

	/**
	 * Set the validator for the current reaction.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Hook_Reaction_Validator $validator The validator.
	 */
	public function set_validator( WordPoints_Hook_Reaction_Validator $validator ) {
		$this->validator = $validator;
	}

	/**
	 * @since 1.0.0
	 */
	public function descend( $child_slug ) {

		$result = parent::descend( $child_slug );

		// Just in case no validator has been set.
		if ( ! $this->validator ) {
			return $result;
		}

		if ( ! $result ) {

			if ( ! isset( $this->current ) ) {

				$this->validator->add_error(
					sprintf(
						__( 'The %s arg is not registered for this event.', 'wordpoints' ) // TODO message
						, $child_slug
					)
				);

			} elseif ( ! ( $this->current instanceof WordPoints_Entity_ParentI ) ) {

				$this->validator->add_error(
					__( 'Cannot get descendant of %s: not a parent.', 'wordpoints' ) // TODO message
				);

			} else {

				$child_arg = $this->current->get_child( $child_slug );

				if ( ! $child_arg ) {
					$this->validator->add_error(
						__( '%s does not have a child "%s".', 'wordpoints' ) // TODO message
						, $this->push_on_descend ? $child_slug : null
					);
				}
			}

		} elseif ( $this->push_on_descend ) {

			$this->validator->push_field( $child_slug );
		}

		return $result;
	}

	/**
	 * @since 1.0.0
	 */
	public function ascend() {

		$ascended = parent::ascend();

		if ( $ascended && $this->validator ) {
			$this->validator->pop_field();
		}

		return $ascended;
	}

	/**
	 * @since 1.0.0
	 */
	public function get_from_hierarchy( array $hierarchy ) {

		$this->push_on_descend = false;
		$entityish = parent::get_from_hierarchy( $hierarchy );
		$this->push_on_descend = true;

		return $entityish;
	}
}

// EOF


1			<?php
2
3			/**
4			* Hook event args class.
5			*
6			* @package wordpoints-hooks-api
7			* @since 1.0.0
8			*/
9
10			/**
11			* Represents the args associated with a hook event.
12			*
13			* This is similar to the regular entity hierarchy, except that it handles errors
14			* with the reaction validators, and accepts an array of hook args instead of
15			* requiring entity objects to be passed directly.
16			*
17			* @since 1.0.0
18			*/
19			class WordPoints_Hook_Event_Args extends WordPoints_Entity_Hierarchy {
20
21			/**
22			* Whether the event is repeatable.
23			*
24			* @since 1.0.0
25			*
26			* @var bool
27			*/
28			protected $is_repeatable = true;
29
30			/**
31			* The slug of the primary arg for this event, if it has one.
32			*
33			* @since 1.0.0
34			*
35			* @var string\|false
36			*/
37			protected $primary_arg_slug = false;
38
39			/**
40			* The validator associated with the current hook reaction.
41			*
42			* @since 1.0.0
43			*
44			* @var WordPoints_Hook_Reaction_Validator
45			*/
46			protected $validator;
47
48			/**
49			* Whether to push fields onto the validator when we descend into the hierarchy.
50			*
51			* This will usually be true, however, when we are getting a value from the
52			* hierarchy, we aren't actually descending into a sub-field, but descending
53			* down the arg hierarchy stored within a field.
54			*
55			* @since 1.0.0
56			*
57			* @var bool
58			*/
59			protected $push_on_descend = true;
60
61			/**
62			* Construct the object with the arg objects.
63			*
64			* @param WordPoints_Hook_Arg[] $args The hook args.
65			*/
66			public function __construct( array $args ) {
67
68			parent::__construct();
69
70			foreach ( $args as $arg ) {
71
72			$entity = $arg->get_entity();
73			$slug = $arg->get_slug();
74
75			if ( ! $entity instanceof WordPoints_Entity ) {
76			continue;
77			}
78
79			$this->entities[ $slug ] = $entity;
80
81			if ( ! $arg->is_stateful() ) {
82			// If any of the args aren't stateful the event isn't repeatable.
83			$this->is_repeatable = false;
84			$this->primary_arg_slug = $slug;
85			}
86			}
87			}
88
89			/**
90			* Whether the event is repeatable.
91			*
92			* An event is repeatable if none of its args have their status toggled by the
93			* event. In that case, it is possible for the event to occur with those same args
94			* multiple times in a row without being reversed in between.
95			*
96			* An arg that has its status modified is called a signature arg. One that does
97			* not is called a stateful arg. An event is repeatable if it has no signature
98			* args, only stateful ones.
99			*
100			* @since 1.0.0
101			*
102			* @return bool Whether the event is repeatable.
103			*/
104			public function is_event_repeatable() {
105			return $this->is_repeatable;
106			}
107
108			/**
109			* Get the stateful args for this event.
110			*
111			* @since 1.0.0
112			*
113			* @return WordPoints_Entity[] The entity objects for the stateful args.
114			*/
115			public function get_stateful_args() {
116
117			$stateful = $this->entities;
118
119			if ( $this->primary_arg_slug ) {
			1 ignored issue – show Bug Best Practice introduced 2016-01-14 15:27 UTC by Report Bug Copy Issue Report The expression `$this->primary_arg_slug` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
120			unset( $stateful[ $this->primary_arg_slug ] );
121			}
122
123			return $stateful;
124			}
125
126			/**
127			* Get the primary arg for this event.
128			*
129			* @since 1.0.0
130			*
131			* @return WordPoints_Entity\|false The entity objects for the primary arg, or
132			* false if this entity has none.
133			*/
134			public function get_primary_arg() {
135
136			if ( ! $this->primary_arg_slug ) {
			1 ignored issue – show Bug Best Practice introduced 2016-01-14 15:27 UTC by Report Bug Copy Issue Report The expression `$this->primary_arg_slug` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
137			return false;
138			}
139
140			return $this->entities[ $this->primary_arg_slug ];
141			}
142
143			/**
144			* Set the validator for the current reaction.
145			*
146			* @since 1.0.0
147			*
148			* @param WordPoints_Hook_Reaction_Validator $validator The validator.
149			*/
150			public function set_validator( WordPoints_Hook_Reaction_Validator $validator ) {
151			$this->validator = $validator;
152			}
153
154			/**
155			* @since 1.0.0
156			*/
157			public function descend( $child_slug ) {
158
159			$result = parent::descend( $child_slug );
160
161			// Just in case no validator has been set.
162			if ( ! $this->validator ) {
163			return $result;
164			}
165
166			if ( ! $result ) {
167
168			if ( ! isset( $this->current ) ) {
169
170			$this->validator->add_error(
171			sprintf(
172			__( 'The %s arg is not registered for this event.', 'wordpoints' ) // TODO message
173			, $child_slug
174			)
175			);
176
177			} elseif ( ! ( $this->current instanceof WordPoints_Entity_ParentI ) ) {
178
179			$this->validator->add_error(
180			__( 'Cannot get descendant of %s: not a parent.', 'wordpoints' ) // TODO message
181			);
182
183			} else {
184
185			$child_arg = $this->current->get_child( $child_slug );
186
187			if ( ! $child_arg ) {
188			$this->validator->add_error(
189			__( '%s does not have a child "%s".', 'wordpoints' ) // TODO message
190			, $this->push_on_descend ? $child_slug : null
191			);
192			}
193			}
194
195			} elseif ( $this->push_on_descend ) {
196
197			$this->validator->push_field( $child_slug );
198			}
199
200			return $result;
201			}
202
203			/**
204			* @since 1.0.0
205			*/
206			public function ascend() {
207
208			$ascended = parent::ascend();
209
210			if ( $ascended && $this->validator ) {
211			$this->validator->pop_field();
212			}
213
214			return $ascended;
215			}
216
217			/**
218			* @since 1.0.0
219			*/
220			public function get_from_hierarchy( array $hierarchy ) {
221
222			$this->push_on_descend = false;
223			$entityish = parent::get_from_hierarchy( $hierarchy );
224			$this->push_on_descend = true;
225
226			return $entityish;
227			}
228			}
229
230			// EOF
231

WordPoints / hooks-api

Push — master ( 637b3c...faeb69 )

WordPoints_Hook_Event_Args::__construct() B

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like