WordPoints / hooks-api

src/includes/classes/hook/firer.php

Spacing +10 added lines, -10 removed lines

@@ -17,14 +17,14 @@ 
 	/**
 	 * @since 1.0.0
 	 */
-	public function do_event( $event_slug, WordPoints_Hook_Event_Args $event_args ) {
+	public function do_event($event_slug, WordPoints_Hook_Event_Args $event_args) {
 
 		$hooks = wordpoints_hooks();
 
 		/** @var WordPoints_Hook_Reactor $reactor */
-		foreach ( $hooks->reactors->get_all() as $reactor ) {
+		foreach ($hooks->reactors->get_all() as $reactor) {
 
-			foreach ( $reactor->get_all_reactions_to_event( $event_slug ) as $reaction ) {
+			foreach ($reactor->get_all_reactions_to_event($event_slug) as $reaction) {
 
 				$validator = new WordPoints_Hook_Reaction_Validator(
 					$reaction
@@ -34,26 +34,26 @@ 
 
 				$validator->validate();
 
-				if ( $validator->had_errors() ) {
+				if ($validator->had_errors()) {
 					continue;
 				}
 
-				$event_args->set_validator( $validator );
+				$event_args->set_validator($validator);
 				$reaction = $validator;
 
 				/** @var WordPoints_Hook_Extension[] $extensions */
 				$extensions = $hooks->extensions->get_all();
 
-				foreach ( $extensions as $extension ) {
-					if ( ! $extension->should_hit( $reaction, $event_args ) ) {
+				foreach ($extensions as $extension) {
+					if ( ! $extension->should_hit($reaction, $event_args)) {
 						continue 2;
 					}
 				}
 
-				$reactor->hit( $event_args, $reaction );
+				$reactor->hit($event_args, $reaction);
 
-				foreach ( $extensions as $extension ) {
-					$extension->after_hit( $reaction, $event_args );
+				foreach ($extensions as $extension) {
+					$extension->after_hit($reaction, $event_args);
 				}
 			}
 		}

src/includes/classes/hook/extension/periods.php

Spacing +69 added lines, -69 removed lines

@@ -25,18 +25,18 @@ 
 	public function get_ui_script_data() {
 
 		$periods = array(
-			MINUTE_IN_SECONDS   => __( 'Minute', 'wordpoints' ),
-			HOUR_IN_SECONDS     => __( 'Hour',   'wordpoints' ),
-			DAY_IN_SECONDS      => __( 'Day',    'wordpoints' ),
-			WEEK_IN_SECONDS     => __( 'Week',   'wordpoints' ),
-			30 * DAY_IN_SECONDS => __( 'Month',  'wordpoints' ),
+			MINUTE_IN_SECONDS   => __('Minute', 'wordpoints'),
+			HOUR_IN_SECONDS     => __('Hour', 'wordpoints'),
+			DAY_IN_SECONDS      => __('Day', 'wordpoints'),
+			WEEK_IN_SECONDS     => __('Week', 'wordpoints'),
+			30 * DAY_IN_SECONDS => __('Month', 'wordpoints'),
 		);
 
 		return array(
 			'periods' => $periods,
 			'l10n' => array(
 				// TODO this should be supplied per-reactor
-				'label' => __( 'Award each user no more than once per:', 'wordpoints' ),
+				'label' => __('Award each user no more than once per:', 'wordpoints'),
 			),
 		);
 	}
@@ -50,25 +50,25 @@ 
 	 *
 	 * @return array The validated periods.
 	 */
-	protected function validate_periods( $periods ) {
+	protected function validate_periods($periods) {
 
-		if ( ! is_array( $periods ) ) {
+		if ( ! is_array($periods)) {
 
 			$this->validator->add_error(
-				__( 'Periods do not match expected format.', 'wordpoints' )
+				__('Periods do not match expected format.', 'wordpoints')
 			);
 
 			return array();
 		}
 
-		foreach ( $periods as $index => $period ) {
+		foreach ($periods as $index => $period) {
 
-			$this->validator->push_field( $index );
+			$this->validator->push_field($index);
 
-			$period = $this->validate_period( $period );
+			$period = $this->validate_period($period);
 
-			if ( $period ) {
-				$periods[ $index ] = $period;
+			if ($period) {
+				$periods[$index] = $period;
 			}
 
 			$this->validator->pop_field();
@@ -86,30 +86,30 @@ 
 	 *
 	 * @return array|false The validated period, or false if invalid.
 	 */
-	protected function validate_period( $period ) {
+	protected function validate_period($period) {
 
-		if ( ! is_array( $period ) ) {
+		if ( ! is_array($period)) {
 			$this->validator->add_error(
-				__( 'Period does not match expected format.', 'wordpoints' )
+				__('Period does not match expected format.', 'wordpoints')
 			);
 
 			return false;
 		}
 
-		if ( isset( $period['args'] ) ) {
-			$this->validate_period_args( $period['args'] );
+		if (isset($period['args'])) {
+			$this->validate_period_args($period['args']);
 		}
 
-		if ( ! isset( $period['length'] ) ) {
+		if ( ! isset($period['length'])) {
 
 			$this->validator->add_error(
-				__( 'Period length setting is missing.', 'wordpoints' )
+				__('Period length setting is missing.', 'wordpoints')
 			);
 
-		} elseif ( false === wordpoints_posint( $period['length'] ) ) {
+		} elseif (false === wordpoints_posint($period['length'])) {
 
 			$this->validator->add_error(
-				__( 'Period length must be a positive integer.', 'wordpoints' )
+				__('Period length must be a positive integer.', 'wordpoints')
 				, 'length'
 			);
 
@@ -126,34 +126,34 @@ 
 	 *
 	 * @param mixed $args The args the period is related to.
 	 */
-	protected function validate_period_args( $args ) {
+	protected function validate_period_args($args) {
 
-		if ( ! is_array( $args ) ) {
+		if ( ! is_array($args)) {
 
 			$this->validator->add_error(
-				__( 'Period does not match expected format.', 'wordpoints' )
+				__('Period does not match expected format.', 'wordpoints')
 				, 'args'
 			);
 
 			return;
 		}
 
-		$this->validator->push_field( 'args' );
+		$this->validator->push_field('args');
 
-		foreach ( $args as $index => $hierarchy ) {
+		foreach ($args as $index => $hierarchy) {
 
-			$this->validator->push_field( $index );
+			$this->validator->push_field($index);
 
-			if ( ! is_array( $hierarchy ) ) {
+			if ( ! is_array($hierarchy)) {
 
 				$this->validator->add_error(
-					__( 'Period does not match expected format.', 'wordpoints' )
+					__('Period does not match expected format.', 'wordpoints')
 				);
 
-			} elseif ( ! $this->event_args->get_from_hierarchy( $hierarchy ) ) {
+			} elseif ( ! $this->event_args->get_from_hierarchy($hierarchy)) {
 
 				$this->validator->add_error(
-					__( 'Invalid period.', 'wordpoints' ) // TODO better error message
+					__('Invalid period.', 'wordpoints') // TODO better error message
 				);
 			}
 
@@ -171,16 +171,16 @@ 
 		WordPoints_Hook_Event_Args $event_args
 	) {
 
-		$periods = $reaction->get_meta( 'periods' );
+		$periods = $reaction->get_meta('periods');
 
-		if ( empty( $periods ) ) {
+		if (empty($periods)) {
 			return true;
 		}
 
 		$this->event_args = $event_args;
 
-		foreach ( $periods as $period ) {
-			if ( ! $this->has_period_ended( $period, $reaction ) ) {
+		foreach ($periods as $period) {
+			if ( ! $this->has_period_ended($period, $reaction)) {
 				return false;
 			}
 		}
@@ -204,23 +204,23 @@ 
 	) {
 
 		$period = $this->get_period_by_reaction(
-			$this->get_period_signature( $settings, $reaction )
+			$this->get_period_signature($settings, $reaction)
 			, $reaction
 		);
 
 		// If the period isn't found, we know that we can still fire.
-		if ( ! $period ) {
+		if ( ! $period) {
 			return true;
 		}
 
-		$now = current_time( 'timestamp' );
+		$now = current_time('timestamp');
 
-		if ( ! empty( $settings['relative'] ) ) {
-			return ( $period->hit_time < $now - $settings['length'] );
+		if ( ! empty($settings['relative'])) {
+			return ($period->hit_time < $now - $settings['length']);
 		} else {
 			return (
-				(int) ( $period->hit_time / $settings['length'] )
-				< (int) ( $now / $settings['length'] )
+				(int) ($period->hit_time / $settings['length'])
+				< (int) ($now / $settings['length'])
 			);
 		}
 	}
@@ -234,21 +234,21 @@ 
 	 *
 	 * @return array The arg values.
 	 */
-	protected function get_arg_values( array $period_args ) {
+	protected function get_arg_values(array $period_args) {
 
 		$values = array();
 
-		foreach ( $period_args as $arg_hierarchy ) {
+		foreach ($period_args as $arg_hierarchy) {
 
 			$arg = $this->event_args->get_from_hierarchy(
 				$arg_hierarchy
 			);
 
-			if ( ! $arg instanceof WordPoints_EntityishI ) {
+			if ( ! $arg instanceof WordPoints_EntityishI) {
 				continue;
 			}
 
-			$values[ implode( '.', $arg_hierarchy ) ] = $arg->get_the_value();
+			$values[implode('.', $arg_hierarchy)] = $arg->get_the_value();
 		}
 
 		return $values;
@@ -263,11 +263,11 @@ 
 	 *
 	 * @return object|false The period data, or false if not found.
 	 */
-	protected function get_period( $period_id ) {
+	protected function get_period($period_id) {
 
-		$period = wp_cache_get( $period_id, 'wordpoints_hook_period' );
+		$period = wp_cache_get($period_id, 'wordpoints_hook_period');
 
-		if ( ! $period ) {
+		if ( ! $period) {
 
 			global $wpdb;
 
@@ -282,7 +282,7 @@ 
 				)
 			);
 
-			if ( ! $period ) {
+			if ( ! $period) {
 				return false;
 			}
 
@@ -292,7 +292,7 @@ 
 				, 'wordpoints_hook_period_ids'
 			);
 
-			wp_cache_set( $period->id, $period, 'wordpoints_hook_periods' );
+			wp_cache_set($period->id, $period, 'wordpoints_hook_periods');
 		}
 
 		return $period;
@@ -319,11 +319,11 @@ 
 		$cache_key = "{$reaction_id}-{$signature}";
 
 		// Before we run the query, we try to lookup the ID in the cache.
-		$period_id = wp_cache_get( $cache_key, 'wordpoints_hook_period_ids' );
+		$period_id = wp_cache_get($cache_key, 'wordpoints_hook_period_ids');
 
 		// If we found it, we can retrieve the period by ID instead.
-		if ( $period_id ) {
-			return $this->get_period( $period_id );
+		if ($period_id) {
+			return $this->get_period($period_id);
 		}
 
 		global $wpdb;
@@ -342,12 +342,12 @@ 
 			)
 		);
 
-		if ( ! $period ) {
+		if ( ! $period) {
 			return false;
 		}
 
-		wp_cache_set( $cache_key, $period->id, 'wordpoints_hook_period_ids' );
-		wp_cache_set( $period->id, $period, 'wordpoints_hook_periods' );
+		wp_cache_set($cache_key, $period->id, 'wordpoints_hook_period_ids');
+		wp_cache_set($period->id, $period, 'wordpoints_hook_periods');
 
 		return $period;
 	}
@@ -360,18 +360,18 @@ 
 		WordPoints_Hook_Event_Args $event_args
 	) {
 
-		$periods = $reaction->get_meta( 'periods' );
+		$periods = $reaction->get_meta('periods');
 
-		if ( empty( $periods ) ) {
+		if (empty($periods)) {
 			return;
 		}
 
 		$this->event_args = $event_args;
 
-		foreach ( $periods as $settings ) {
+		foreach ($periods as $settings) {
 
 			$this->add_period(
-				$this->get_period_signature( $settings, $reaction )
+				$this->get_period_signature($settings, $reaction)
 				, $reaction
 			);
 		}
@@ -396,14 +396,14 @@ 
 		WordPoints_Hook_Reaction_Validator $reaction
 	) {
 
-		if ( isset( $settings['args'] ) ) {
+		if (isset($settings['args'])) {
 			$period_args = $settings['args'];
 		} else {
-			$period_args = array( $reaction->get_meta( 'target' ) );
+			$period_args = array($reaction->get_meta('target'));
 		}
 
 		return wordpoints_hash(
-			wp_json_encode( $this->get_arg_values( $period_args ) )
+			wp_json_encode($this->get_arg_values($period_args))
 		);
 	}
 
@@ -431,12 +431,12 @@ 
 			, array(
 				'reaction_id' => $reaction_id,
 				'signature'   => $signature,
-				'hit_time'    => current_time( 'timestamp' ),
+				'hit_time'    => current_time('timestamp'),
 			)
-			, array( '%d', '%s', '%d' )
+			, array('%d', '%s', '%d')
 		);
 
-		if ( ! $inserted ) {
+		if ( ! $inserted) {
 			return false;
 		}
 

src/includes/classes/hook/reaction/validator.php

Spacing +26 added lines, -26 removed lines

@@ -104,13 +104,13 @@ 
 	 * @param bool                            $fail_fast Whether to fail as soon as
 	 *                                                   the first error is found.
 	 */
-	public function __construct( $settings, WordPoints_Hook_Reactor $reactor, $fail_fast = false ) {
+	public function __construct($settings, WordPoints_Hook_Reactor $reactor, $fail_fast = false) {
 
 		$this->reactor = $reactor;
 		$this->fail_fast = $fail_fast;
 		$this->hooks = wordpoints_hooks();
 
-		if ( $settings instanceof WordPoints_Hook_ReactionI ) {
+		if ($settings instanceof WordPoints_Hook_ReactionI) {
 
 			$this->reaction   = $settings;
 			$this->settings   = $this->reaction->get_all_meta();
@@ -120,7 +120,7 @@ 
 
 			$this->settings = $settings;
 
-			if ( isset( $this->settings['event'] ) ) {
+			if (isset($this->settings['event'])) {
 				$this->event_slug = $this->settings['event'];
 			}
 		}
@@ -144,10 +144,10 @@ 
 			$fail_fast = $this->fail_fast;
 			$this->fail_fast = true;
 
-			if ( ! isset( $this->event_slug ) ) {
-				$this->add_error( __( 'Event is missing.', 'wordpoints' ), 'event' );
-			} elseif ( ! $this->hooks->events->is_registered( $this->event_slug ) ) {
-				$this->add_error( __( 'Event is invalid.', 'wordpoints' ), 'event' );
+			if ( ! isset($this->event_slug)) {
+				$this->add_error(__('Event is missing.', 'wordpoints'), 'event');
+			} elseif ( ! $this->hooks->events->is_registered($this->event_slug)) {
+				$this->add_error(__('Event is invalid.', 'wordpoints'), 'event');
 			}
 
 			// From here on out we can collect errors as they come (unless we are
@@ -158,14 +158,14 @@ 
 				$this->event_slug
 			);
 
-			$this->event_args = new WordPoints_Hook_Event_Args( $event_args );
-			$this->event_args->set_validator( $this );
+			$this->event_args = new WordPoints_Hook_Event_Args($event_args);
+			$this->event_args->set_validator($this);
 
-			$this->settings = $this->reactor->validate_settings( $this->settings, $this, $this->event_args );
+			$this->settings = $this->reactor->validate_settings($this->settings, $this, $this->event_args);
 
 			/** @var WordPoints_Hook_Extension $extension */
-			foreach ( $this->hooks->extensions->get_all() as $extension ) {
-				$this->settings = $extension->validate_settings( $this->settings, $this, $this->event_args );
+			foreach ($this->hooks->extensions->get_all() as $extension) {
+				$this->settings = $extension->validate_settings($this->settings, $this, $this->event_args);
 			}
 
 			/**
@@ -175,12 +175,12 @@ 
 			 * @param WordPoints_Hook_Reaction_Validator $validator The validator object.
 			 * @param WordPoints_Hook_Event_Args         $args      The event args object.
 			 */
-			$this->settings = apply_filters( 'wordpoints_hook_reaction_validate', $this->settings, $this, $this->event_args );
+			$this->settings = apply_filters('wordpoints_hook_reaction_validate', $this->settings, $this, $this->event_args);
 
-		} catch ( WordPoints_Hook_Validator_Exception $e ) {
+		} catch (WordPoints_Hook_Validator_Exception $e) {
 
 			// Do nothing.
-			unset( $e );
+			unset($e);
 		}
 
 		return $this->settings;
@@ -208,17 +208,17 @@ 
 	 * @throws WordPoints_Hook_Validator_Exception If the validator is configured to
 	 *                                             fail as soon as an error is found.
 	 */
-	public function add_error( $message, $field = null ) {
+	public function add_error($message, $field = null) {
 
 		$field_stack = $this->field_stack;
 
-		if ( null !== $field ) {
+		if (null !== $field) {
 			$field_stack[] = $field;
 		}
 
-		$this->errors[] = array( 'message' => $message, 'field' => $field_stack );
+		$this->errors[] = array('message' => $message, 'field' => $field_stack);
 
-		if ( $this->fail_fast ) {
+		if ($this->fail_fast) {
 			throw new WordPoints_Hook_Validator_Exception;
 		}
 	}
@@ -231,7 +231,7 @@ 
 	 * @return bool Whether the validator found any errors.
 	 */
 	public function had_errors() {
-		return ! empty( $this->errors );
+		return ! empty($this->errors);
 	}
 
 	/**
@@ -252,7 +252,7 @@ 
 	 *
 	 * @param string $field The field.
 	 */
-	public function push_field( $field ) {
+	public function push_field($field) {
 		$this->field_stack[] = $field;
 	}
 
@@ -262,7 +262,7 @@ 
 	 * @since 1.0.0
 	 */
 	public function pop_field() {
-		array_pop( $this->field_stack );
+		array_pop($this->field_stack);
 	}
 
 	/**
@@ -307,7 +307,7 @@ 
 	 */
 	public function get_id() {
 
-		if ( ! $this->reaction ) {
+		if ( ! $this->reaction) {
 			return false;
 		}
 
@@ -345,13 +345,13 @@ 
 	 *
 	 * @return mixed The meta value.
 	 */
-	public function get_meta( $key ) {
+	public function get_meta($key) {
 
-		if ( ! isset( $this->settings[ $key ] ) ) {
+		if ( ! isset($this->settings[$key])) {
 			return null;
 		}
 
-		return $this->settings[ $key ];
+		return $this->settings[$key];
 	}
 
 	/**

src/includes/classes/hooks.php

Spacing +13 added lines, -13 removed lines

@@ -46,13 +46,13 @@ 
 	protected function init() {
 
 		$sub_apps = $this->sub_apps;
-		$sub_apps->register( 'router', 'WordPoints_Hook_Router' );
-		$sub_apps->register( 'actions', 'WordPoints_Hook_Actions' );
-		$sub_apps->register( 'events', 'WordPoints_Hook_Events' );
-		$sub_apps->register( 'firers', 'WordPoints_Class_Registry_Persistent' );
-		$sub_apps->register( 'reactors', 'WordPoints_Class_Registry_Persistent' );
-		$sub_apps->register( 'extensions', 'WordPoints_Class_Registry_Persistent' );
-		$sub_apps->register( 'conditions', 'WordPoints_Class_Registry_Children' );
+		$sub_apps->register('router', 'WordPoints_Hook_Router');
+		$sub_apps->register('actions', 'WordPoints_Hook_Actions');
+		$sub_apps->register('events', 'WordPoints_Hook_Events');
+		$sub_apps->register('firers', 'WordPoints_Class_Registry_Persistent');
+		$sub_apps->register('reactors', 'WordPoints_Class_Registry_Persistent');
+		$sub_apps->register('extensions', 'WordPoints_Class_Registry_Persistent');
+		$sub_apps->register('conditions', 'WordPoints_Class_Registry_Children');
 
 		parent::init();
 	}
@@ -66,18 +66,18 @@ 
 	 */
 	public function get_network_mode() {
 
-		if ( ! isset( $this->network_mode ) ) {
+		if ( ! isset($this->network_mode)) {
 			$this->network_mode = is_network_admin();
 
 			// See https://core.trac.wordpress.org/ticket/22589
 			if (
-				defined( 'DOING_AJAX' )
+				defined('DOING_AJAX')
 				&& DOING_AJAX
 				&& is_multisite()
-				&& isset( $_SERVER['HTTP_REFERER'] )
+				&& isset($_SERVER['HTTP_REFERER'])
 				&& preg_match(
-					'#^' . preg_quote( network_admin_url(), '#' ) . '#i'
-					, esc_url_raw( wp_unslash( $_SERVER['HTTP_REFERER'] ) )
+					'#^'.preg_quote(network_admin_url(), '#').'#i'
+					, esc_url_raw(wp_unslash($_SERVER['HTTP_REFERER']))
 				)
 			) {
 				$this->network_mode = true;
@@ -121,7 +121,7 @@ 
 	 *
 	 * @param bool $on Whether network-wide mode should be on (or off).
 	 */
-	public function _set_network_mode( $on = true ) {
+	public function _set_network_mode($on = true) {
 		$this->network_mode = (bool) $on;
 	}
 }