WordPoints_Hook_Reactor

Complexity

Total Complexity

25

Size/Duplication

Total Lines	270
Duplicated Lines	13.7 %

Coupling/Cohesion

Components	1
Dependencies	6

10 Methods

Rating	Name	Duplication	Size	Complexity
D	__get()	0	37	9
A	get_slug()	0	3	1
A	get_arg_types()	0	3	1
A	get_settings_fields()	0	3	1
A	is_network_wide()	0	3	1
A	get_all_reactions_to_event()	20	20	3
A	get_all_reactions()	17	17	3
B	validate_settings()	0	27	5
A	update_settings()	0	3	1
	hit()	0	4	?

<?php

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

/**
 * Bootstrap for performing pre-scripted reactions when an event is fired.
 *
 * When a hook event fires, it is the job of the reactor to perform the action
 * specified for each reaction object. For most reactors this means that they must
 * "hit" a "target". For example, it might award points to a particular user.
 *
 * @since 1.0.0
 *
 * @property-read WordPoints_Hook_Reaction_StorageI|null $reactions
 *                Object for accessing hook reactions for this reactor based on the
 *                current network mode. If a reactor doesn't support network
 *                reactions and network mode is on, this property is not available.
 *
 * @property-read WordPoints_Hook_Reaction_StorageI|null $standard_reactions
 *                Object for accessing standard hook reactions for this reactor. Not
 *                available when network mode is on.
 *
 * @property-read WordPoints_Hook_Reaction_StorageI|null $network_reactions
 *                Object for accessing network hook reactions for this reactor. May
 *                not be available for all reactors.
 */
abstract class WordPoints_Hook_Reactor implements WordPoints_Hook_SettingsI {

	/**
	 * The unique slug identifying this hook reactor.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $slug;

	/**
	 * The types of args that this reactor can target.
	 *
	 * @since 1.0.0
	 *
	 * @var string|string[]
	 */
	protected $arg_types;

	/**
	 * The settings fields used by this reactor.
	 *
	 * @since 1.0.0
	 *
	 * @var array
	 */
	protected $settings_fields;

	/**
	 * The storage object for the standard reactions.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_Hook_Reaction_StorageI
	 */
	protected $standard_reactions;

	/**
	 * The storage object for the network-wide reactions.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_Hook_Reaction_StorageI
	 */
	protected $network_reactions;

	/**
	 * The reaction storage class this reactor uses.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $standard_reactions_class = 'WordPoints_Hook_Reaction_Storage_Options';

	/**
	 * The network reaction storage class this reactor uses.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $network_reactions_class = 'WordPoints_Hook_Reaction_Storage_Options_Network';

	/**
	 * @since 1.0.0
	 */
	public function __get( $var ) {

		if ( 'reactions' === $var ) {
			$mode = wordpoints_hooks()->get_current_mode();
			$var  = "{$mode}_reactions";
		} elseif ( '_reactions' !== substr( $var, -10 ) ) {
			return null;
		} else {
			$mode = substr( $var, 0, -10 /* _reactions */ );
		}

		if ( 'network_reactions' === $var && ! $this->is_network_wide() ) {
			return null;
		}

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

			if ( isset( $this->{"{$var}_class"} ) ) {
				$this->$var = new $this->{"{$var}_class"}( $mode, $this );
			} else {
				return null;
			}
		}

		$store = $this->$var;

		if ( ! $store instanceof WordPoints_Hook_Reaction_StorageI ) {
			return null;
		}

		// Allowing access to stores out-of-context would lead to strange behavior.
		if ( false === $store->get_context_id() ) {
			return null;
		}

		return $store;
	}

	/**
	 * Get the slug of this reactor.
	 *
	 * @since 1.0.0
	 *
	 * @return string The reactor's slug.
	 */
	public function get_slug() {
		return $this->slug;
	}

	/**
	 * Get a list of the slugs of each type of arg that this reactor supports.
	 *
	 * @since 1.0.0
	 *
	 * @return string[] The slugs of the arg types this reactor supports.
	 */
	public function get_arg_types() {
		return (array) $this->arg_types;
	}

	/**
	 * Get the settings fields used by the reactor.
	 *
	 * @since 1.0.0
	 *
	 * @return string[] The meta keys used to store this reactor's settings.
	 */
	public function get_settings_fields() {
		return $this->settings_fields;
	}

	/**
	 * Check whether this reactor is network-wide.
	 *
	 * When a reactor is not network-wide, network reactions are not supported. For
	 * example, the points reactor is not network-wide when WordPoints isn't network-
	 * active, because the points types are created per-site. We default all reactors
	 * to being network wide only when WordPoints is network-active, but some may
	 * need to override this.
	 *
	 * @since 1.0.0
	 *
	 * @return bool Whether this reactor is network-wide.
	 */
	public function is_network_wide() {
		return is_wordpoints_network_active();
	}

	/**
	 * Get all reactions to a particular event for this reactor.
	 *
	 * On multisite it will return all reactions for the current site, both standard
	 * ones and any network-wide ones (if this reactor offers a network storage
	 * class). Or, if network mode is on, it will return only the network-wide ones.
	 *
	 * @since 1.0.0
	 *
	 * @param string $event_slug The event slug.
	 *
	 * @return WordPoints_Hook_ReactionI[] All of the reaction objects.
	 */
	public function get_all_reactions_to_event( $event_slug ) {

This method seems to be duplicated in your project.

		$reactions = array();

		foreach ( array( 'standard', 'network' ) as $store ) {

			$storage = $this->{"{$store}_reactions"};

			if ( ! $storage instanceof WordPoints_Hook_Reaction_StorageI ) {
				continue;
			}

			$reactions = array_merge(
				$reactions
				, $storage->get_reactions_to_event( $event_slug )
			);
		}

		return $reactions;
	}

	/**
	 * Get all reactions for this reactor.
	 *
	 * On multisite it will return all reactions for the current site, both standard
	 * ones and any network-wide ones (if this reactor offers a network storage
	 * class). Or, if network mode is on, it will return only the network-wide ones.
	 *
	 * @since 1.0.0
	 *
	 * @return WordPoints_Hook_ReactionI[] All of the reaction objects.
	 */
	public function get_all_reactions() {

This method seems to be duplicated in your project.

		$reactions = array();

		foreach ( array( 'standard', 'network' ) as $store ) {

			$storage = $this->{"{$store}_reactions"};

			if ( ! $storage instanceof WordPoints_Hook_Reaction_StorageI ) {
				continue;
			}

			$reactions = array_merge( $reactions, $storage->get_reactions() );
		}

		return $reactions;
	}

	/**
	 * @since 1.0.0
	 */
	public function validate_settings(
		array $settings,
		WordPoints_Hook_Reaction_Validator $validator,
		WordPoints_Hook_Event_Args $event_args
	) {

		if (
			empty( $settings['target'] )
			|| ! is_array( $settings['target'] )
		) {

			$validator->add_error( __( 'Invalid target.', 'wordpoints' ), 'target' );

		} else {

			$target = $event_args->get_from_hierarchy( $settings['target'] );

			if (
				! $target instanceof WordPoints_Entity
				|| ! in_array( $target->get_slug(), (array) $this->arg_types )
			) {
				$validator->add_error( __( 'Invalid target.', 'wordpoints' ), 'target' );
			}
		}

		return $settings;
	}

	/**
	 * @since 1.0.0
	 */
	public function update_settings( WordPoints_Hook_ReactionI $reaction, array $settings ) {
		$reaction->update_meta( 'target', $settings['target'] );
	}

	/**
	 * Perform an action when the reactor is hit by an event being fired.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Hook_Event_Args $event_args The event args.
	 * @param WordPoints_Hook_ReactionI  $reaction   The reaction.
	 */
	abstract public function hit(
		WordPoints_Hook_Event_Args $event_args,
		WordPoints_Hook_ReactionI $reaction
	);
}

// EOF