WordPoints_Hook_Event_Args

Complexity

Total Complexity

22

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

8 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	22	4
A	is_event_repeatable()	0	3	1
A	get_stateful_args()	0	10	2
A	get_primary_arg()	0	8	2
A	set_validator()	0	3	1
C	descend()	0	45	8
A	ascend()	0	10	3
A	get_from_hierarchy()	0	8	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 ) {

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.

			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 ) {

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.

			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