WordPoints_Hook_Extension::after_reverse() - Code Metrics - Inspection of "More leeway in the periods extension tests" - WordPoints/hooks-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b488c9...33372a )

by J.D.

created 2016-01-23 16:18 UTC

WordPoints_Hook_Extension::after_reverse() A

↳ Parent: WordPoints_Hook_Extension

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	5
rs	9.4285
cc	1
eloc	4
nc	1
nop	3

<?php

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

/**
 * Represents a hook extension.
 *
 * Hook extensions extend the basic hooks API, and can modify whether a particular
 * hook firing should hit the target. Each extension makes this decision based on
 * custom settings it offers for each reaction.
 *
 * @since 1.0.0
 */
abstract class WordPoints_Hook_Extension implements WordPoints_Hook_SettingsI {

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

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

	/**
	 * The args for the current event.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_Hook_Event_Args
	 */
	protected $event_args;

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

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

		if ( ! isset( $settings[ $this->slug ] ) ) {
			return $settings;
		}

		$this->validator = $validator;
		$this->event_args = $event_args;

		$this->validator->push_field( $this->slug );
		$settings[ $this->slug ] = $this->{"validate_{$this->slug}"}( $settings[ $this->slug ] );
		$this->validator->pop_field();

		return $settings;
	}

	/**
	 * @since 1.0.0
	 */
	public function update_settings( WordPoints_Hook_ReactionI $reaction, array $settings ) {

		if ( isset( $settings[ $this->slug ] ) ) {
			$reaction->update_meta( $this->slug, $settings[ $this->slug ] );
		} else {
			$reaction->delete_meta( $this->slug );
		}
	}

	/**
	 * Check whether this hook firing should hit the target.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Hook_ReactionI  $reaction   The reaction.
	 * @param WordPoints_Hook_Event_Args $event_args The event args.
	 *
	 * @return bool Whether the target should be hit by this hook firing.
	 */
	abstract public function should_hit(
		WordPoints_Hook_ReactionI $reaction,
		WordPoints_Hook_Event_Args $event_args
	);

	/**
	 * After a reaction has hit the target.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Hook_ReactionI  $reaction   The reaction.
	 * @param WordPoints_Hook_Event_Args $event_args The event args.
	 */
	public function after_hit(
		WordPoints_Hook_ReactionI $reaction,
		WordPoints_Hook_Event_Args $event_args
	) {}

	/**
	 * Called after a reverse action is called.
	 *
	 * @since 1.0.0
	 *
	 * @param string                     $event_slug The event slug.
	 * @param WordPoints_Hook_Event_Args $event_args The event args.
	 * @param WordPoints_Hook_Reactor    $reactor    The reactor object.
	 */
	public function after_reverse(
		$event_slug,

		WordPoints_Hook_Event_Args $event_args,

		WordPoints_Hook_Reactor $reactor

	) {}

	/**
	 * Get the data the scripts need for the UI.
	 *
	 * @since 1.0.0
	 *
	 * @return array Any data that needs to be present for the scripts in the UI.
	 */
	public function get_ui_script_data() {
		return array();
	}
}

// EOF


1			<?php
2
3			/**
4			* Hook extension class.
5			*
6			* @package wordpoints-hooks-api
7			* @since 1.0.0
8			*/
9
10			/**
11			* Represents a hook extension.
12			*
13			* Hook extensions extend the basic hooks API, and can modify whether a particular
14			* hook firing should hit the target. Each extension makes this decision based on
15			* custom settings it offers for each reaction.
16			*
17			* @since 1.0.0
18			*/
19			abstract class WordPoints_Hook_Extension implements WordPoints_Hook_SettingsI {
20
21			/**
22			* The unique slug for identifying this extension.
23			*
24			* @since 1.0.0
25			*
26			* @var string
27			*/
28			protected $slug;
29
30			/**
31			* The validator for the current reaction.
32			*
33			* @since 1.0.0
34			*
35			* @var WordPoints_Hook_Reaction_Validator
36			*/
37			protected $validator;
38
39			/**
40			* The args for the current event.
41			*
42			* @since 1.0.0
43			*
44			* @var WordPoints_Hook_Event_Args
45			*/
46			protected $event_args;
47
48			/**
49			* Get the slug of this extension.
50			*
51			* @since 1.0.0
52			*
53			* @return string The extension's slug.
54			*/
55			public function get_slug() {
56			return $this->slug;
57			}
58
59			/**
60			* @since 1.0.0
61			*/
62			public function validate_settings(
63			array $settings,
64			WordPoints_Hook_Reaction_Validator $validator,
65			WordPoints_Hook_Event_Args $event_args
66			) {
67
68			if ( ! isset( $settings[ $this->slug ] ) ) {
69			return $settings;
70			}
71
72			$this->validator = $validator;
73			$this->event_args = $event_args;
74
75			$this->validator->push_field( $this->slug );
76			$settings[ $this->slug ] = $this->{"validate_{$this->slug}"}( $settings[ $this->slug ] );
77			$this->validator->pop_field();
78
79			return $settings;
80			}
81
82			/**
83			* @since 1.0.0
84			*/
85			public function update_settings( WordPoints_Hook_ReactionI $reaction, array $settings ) {
86
87			if ( isset( $settings[ $this->slug ] ) ) {
88			$reaction->update_meta( $this->slug, $settings[ $this->slug ] );
89			} else {
90			$reaction->delete_meta( $this->slug );
91			}
92			}
93
94			/**
95			* Check whether this hook firing should hit the target.
96			*
97			* @since 1.0.0
98			*
99			* @param WordPoints_Hook_ReactionI $reaction The reaction.
100			* @param WordPoints_Hook_Event_Args $event_args The event args.
101			*
102			* @return bool Whether the target should be hit by this hook firing.
103			*/
104			abstract public function should_hit(
105			WordPoints_Hook_ReactionI $reaction,
106			WordPoints_Hook_Event_Args $event_args
107			);
108
109			/**
110			* After a reaction has hit the target.
111			*
112			* @since 1.0.0
113			*
114			* @param WordPoints_Hook_ReactionI $reaction The reaction.
115			* @param WordPoints_Hook_Event_Args $event_args The event args.
116			*/
117			public function after_hit(
118			WordPoints_Hook_ReactionI $reaction,
119			WordPoints_Hook_Event_Args $event_args
120			) {}
121
122			/**
123			* Called after a reverse action is called.
124			*
125			* @since 1.0.0
126			*
127			* @param string $event_slug The event slug.
128			* @param WordPoints_Hook_Event_Args $event_args The event args.
129			* @param WordPoints_Hook_Reactor $reactor The reactor object.
130			*/
131			public function after_reverse(
132			$event_slug,
			1 ignored issue – show Unused Code introduced 2016-01-23 16:21 UTC by Report Bug Copy Issue Report The parameter `$event_slug` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
133			WordPoints_Hook_Event_Args $event_args,
			1 ignored issue – show Unused Code introduced 2016-01-23 16:21 UTC by Report Bug Copy Issue Report The parameter `$event_args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
134			WordPoints_Hook_Reactor $reactor
			1 ignored issue – show Unused Code introduced 2016-01-23 16:21 UTC by Report Bug Copy Issue Report The parameter `$reactor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
135			) {}
136
137			/**
138			* Get the data the scripts need for the UI.
139			*
140			* @since 1.0.0
141			*
142			* @return array Any data that needs to be present for the scripts in the UI.
143			*/
144			public function get_ui_script_data() {
145			return array();
146			}
147			}
148
149			// EOF
150

WordPoints / hooks-api

Push — master ( b488c9...33372a )

WordPoints_Hook_Extension::after_reverse() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like