DependencyManager::init_handlers() - Code Metrics - Inspection of "Separate paths for `register` & `enqueue`. Resolve..." - brightnucleus/dependencies - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3447e3...3ca089 )

by Alain

created 2016-02-25 07:20 UTC

DependencyManager::init_handlers() A

↳ Parent: DependencyManager

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	0
cts	6
cp	0
rs	9.4285
cc	3
eloc	5
nc	3
nop	0
crap	12

<?php
/**
 * DependencyManager Class.
 *
 * @package   BrightNucleus\Dependency
 * @author    Alain Schlesser <[email protected]>
 * @license   GPL-2.0+
 * @link      http://www.brightnucleus.com/
 * @copyright 2015 Alain Schlesser, Bright NucleusInterface
 */

namespace BrightNucleus\Dependency;

use BrightNucleus\Config\ConfigInterface;
use BrightNucleus\Config\ConfigTrait;
use BrightNucleus\Exception\InvalidArgumentException;
use BrightNucleus\Exception\RuntimeException;

/**
 * Register and enqueue dependencies that are listed in the config file.
 *
 * @since   0.1.0
 *
 * @package BrightNucleus\Dependency
 * @author  Alain Schlesser <[email protected]>
 */
class DependencyManager implements DependencyManagerInterface {

	use ConfigTrait;

	/*
	 * Default dependency handler implementations.
	 */
	const DEFAULT_SCRIPT_HANDLER = '\BrightNucleus\Dependency\ScriptHandler';
	const DEFAULT_STYLE_HANDLER  = '\BrightNucleus\Dependency\StyleHandler';

	/*
	 * Names of the configuration keys.
	 */
	const KEY_HANDLERS = 'handlers';
	const KEY_SCRIPTS  = 'scripts';
	const KEY_STYLES   = 'styles';

	/**
	 * Hold the dependencies, grouped by type.
	 *
	 * @since 0.1.0
	 *
	 * @var array;
	 */
	protected $dependencies = [ ];

	/**
	 * Hold the handlers.
	 *
	 * @since 0.1.0
	 *
	 * @var array
	 */
	protected $handlers = [ ];

	/**
	 * Whether to enqueue immediately upon registration.
	 *
	 * @since 0.2.2
	 *
	 * @var bool
	 */
	protected $enqueue_immediately;

	/**
	 * Instantiate DependencyManager object.
	 *
	 * @since 0.1.0
	 *
	 * @param ConfigInterface $config   ConfigInterface object that contains
	 *                                  dependency settings.
	 * @param bool            $enqueue  Optional. Whether to enqueue
	 *                                  immediately. Defaults to true.
	 * @throws RuntimeException If the config could not be processed.
	 * @throws InvalidArgumentException If no dependency handlers were
	 *                                  specified.
	 */
	public function __construct( ConfigInterface $config, $enqueue = true ) {
		$this->processConfig( $config );
		$this->enqueue_immediately = $enqueue;
		$this->init_handlers();
		$this->init_dependencies();
	}

	/**
	 * Initialize the dependency handlers.
	 *
	 * @since 0.1.0
	 */
	protected function init_handlers() {
		$keys = [ self::KEY_SCRIPTS, self::KEY_STYLES ];
		foreach ( $keys as $key ) {
			if ( $this->hasConfigKey( $key ) ) {
				$this->add_handler( $key );
			}
		}
	}

	/**
	 * Add a single dependency handler.
	 *
	 * @since 0.1.0
	 *
	 * @param string $dependency The dependency type for which to add a handler.
	 */
	protected function add_handler( $dependency ) {
		if ( $this->hasConfigKey( $dependency ) ) {
			$handler = $this->hasConfigKey( self::KEY_HANDLERS, $dependency )
				? $this->getConfigKey( self::KEY_HANDLERS, $dependency )
				: $this->get_default_handler( $dependency );
			if ( $handler ) {
				$this->handlers[ $dependency ] = $handler;
			}
		}
	}

	/**
	 * Get the default handler class for a given type of dependency.
	 *
	 * @since 0.1.0
	 *
	 * @param string $dependency The dependency that needs a handler.
	 * @return string|null Class name of the handler. Null if none.
	 */
	protected function get_default_handler( $dependency ) {
		switch ( $dependency ) {
			case self::KEY_STYLES:
				return self::DEFAULT_STYLE_HANDLER;
			case self::KEY_SCRIPTS:
				return self::DEFAULT_SCRIPT_HANDLER;
			default:
				return null;
		}
	}

	/**
	 * Initialize the actual dependencies.
	 *
	 * @since 0.1.0
	 */
	protected function init_dependencies() {
		array_walk( $this->handlers,
			function ( $handler, $dependency_type ) {
				if ( $this->hasConfigKey( $dependency_type ) ) {
					$this->dependencies[ $dependency_type ] = $this->getConfigKey( $dependency_type );
				}
			} );
	}

	/**
	 * Register all dependencies.
	 *
	 * @since 0.1.0
	 *
	 * @param mixed $context Optional. The context to pass to the dependencies.
	 */
	public function register( $context = null ) {
		$context = $this->validate_context( $context );
		array_walk( $this->dependencies,
			[ $this, 'register_dependency_type' ], $context );
	}

	/**
	 * Validate the context to make sure it is an array.
	 *
	 * @since 0.2.1
	 *
	 * @param mixed $context The context as passed in by WordPress.
	 * @return array Validated context.
	 */
	protected function validate_context( $context ) {
		if ( is_string( $context ) ) {
			return [ 'wp_context' => $context ];
		}
		return (array) $context;
	}

	/**
	 * Enqueue all dependencies.
	 *
	 * @since 0.1.0
	 *
	 * @param mixed $context  Optional. The context to pass to the
	 *                        dependencies.
	 */
	public function enqueue( $context = null ) {
		$context = $this->validate_context( $context );

		array_walk( $this->dependencies,
			[ $this, 'enqueue_dependency_type' ], $context );
	}

	/**
	 * Enqueue a single dependency retrieved by its handle.
	 *
	 * @since 0.2.2
	 *
	 * @param string $handle  The dependency handle to enqueue.
	 * @param mixed  $context Optional. The context to pass to the
	 *                        dependencies.
	 * @return bool Returns whether the handle was found or not.
	 */
	public function enqueue_handle( $handle, $context = null ) {
		list( $dependency_key, $dependency ) = $this->get_dependency_array( $handle );
		if ( $dependency ) {

			$this->enqueue_dependency(
				$dependency,
				$dependency_key,
				$context
			);

			$this->maybe_localize( $dependency, $context );

			return true;
		}
		return false;
	}

	/**
	 * Get the matching dependency for a given handle.
	 *
	 * @since 0.2.2
	 *
	 * @param string $handle The dependency handle to search for.
	 * @return array Array containing the dependency key as well as the
	 *                       dependency array itself.
	 */
	protected function get_dependency_array( $handle ) {
		foreach ( $this->dependencies as $dependency_type ) {
			$dependency_key = array_search( $handle, $dependency_type, true );
			if ( $dependency_key ) {
				return [ $dependency_key, $dependency_type[ $dependency_key ] ];
			}
		}
		// Handle not found, return an empty array.
		return [ '', null ];
	}

	/**
	 * Enqueue a single dependency.
	 *
	 * @since 0.1.0
	 *
	 * @param array  $dependency     Configuration data of the dependency.
	 * @param string $dependency_key Config key of the dependency.
	 * @param mixed  $context        Optional. Context to pass to the
	 *                               dependencies. Contains the type of the
	 *                               dependency at key
	 *                               'dependency_type'.
	 */
	protected function enqueue_dependency( $dependency, $dependency_key, $context = null ) {
		if ( ! $this->is_needed( $dependency, $context ) ) {
			return;
		}
		/** @var \BrightNucleus\Contract\Enqueueable $handler */
		$handler = new $this->handlers[$context['dependency_type']];
		$handler->enqueue( $dependency );
	}

	/**
	 * Check whether a specific dependency is needed.
	 *
	 * @since 0.1.0
	 *
	 * @param array $dependency Configuration of the dependency to check.
	 * @param mixed $context    Context to pass to the dependencies.
	 *                          Contains the type of the dependency at key
	 *                          'dependency_type'.
	 * @return bool Whether it is needed or not.
	 */
	protected function is_needed( $dependency, $context ) {
		$is_needed = array_key_exists( 'is_needed', $dependency )
			? $dependency['is_needed']
			: null;

		if ( null === $is_needed ) {
			return true;
		}

		return is_callable( $is_needed ) && $is_needed( $context );
	}

	/**
	 * Localize the script of a given dependency.
	 *
	 * @since 0.1.0
	 *
	 * @param array $dependency The dependency to localize the script of.
	 * @param mixed $context    Contextual data to pass to the callback.
	 *                          Contains the type of the dependency at key
	 *                          'dependency_type'.
	 */
	protected function maybe_localize( $dependency, $context ) {
		if ( ! array_key_exists( 'localize', $dependency ) ) {
			return;
		}

		$localize = $dependency['localize'];
		$data     = $localize['data'];
		if ( is_callable( $data ) ) {
			$data = $data( $context );
		}

		\wp_localize_script( $dependency['handle'], $localize['name'], $data );
	}

	/**
	 * Enqueue all dependencies of a specific type.
	 *
	 * @since 0.1.0
	 *
	 * @param array  $dependencies    The dependencies to enqueue.
	 * @param string $dependency_type The type of the dependencies.
	 * @param mixed  $context         Optional. The context to pass to the
	 *                                dependencies.
	 */
	protected function enqueue_dependency_type( $dependencies, $dependency_type, $context = null ) {
		$context['dependency_type'] = $dependency_type;
		array_walk( $dependencies, [ $this, 'enqueue_dependency' ], $context );
	}

	/**
	 * Register all dependencies of a specific type.
	 *
	 * @since 0.1.0
	 *
	 * @param array  $dependencies    The dependencies to register.
	 * @param string $dependency_type The type of the dependencies.
	 * @param mixed  $context         Optional. The context to pass to the
	 *                                dependencies.
	 */
	protected function register_dependency_type( $dependencies, $dependency_type, $context = null ) {
		$context['dependency_type'] = $dependency_type;
		array_walk( $dependencies, [ $this, 'register_dependency' ], $context );
	}

	/**
	 * Register a single dependency.
	 *
	 * @since 0.1.0
	 *
	 * @param array  $dependency     Configuration data of the dependency.
	 * @param string $dependency_key Config key of the dependency.
	 * @param mixed  $context        Optional. Context to pass to the
	 *                               dependencies. Contains the type of the
	 *                               dependency at key
	 *                               'dependency_type'.
	 */
	protected function register_dependency( $dependency, $dependency_key, $context = null ) {
		/** @var \BrightNucleus\Contract\Registerable $handler */
		$handler = new $this->handlers[$context['dependency_type']];
		$handler->register( $dependency );

		if ( $this->enqueue_immediately ) {
			$this->register_enqueue_hooks( $dependency, $context );
		}
	}

	/**
	 * Register the enqueueing to WordPress hooks.
	 *
	 * @since 0.2.2
	 *
	 * @param array $dependency Configuration data of the dependency.
	 * @param mixed $context    Optional. Context to pass to the dependencies.
	 *                          Contains the type of the dependency at key
	 *                          'dependency_type'.
	 */
	protected function register_enqueue_hooks( $dependency, $context = null ) {
		$priority = $this->get_priority( $dependency );


		foreach ( [ 'wp_enqueue_scripts', 'admin_enqueue_scripts' ] as $hook ) {
			\add_action( $hook, [ $this, 'enqueue' ], $priority, 1 );
		}

		$this->maybe_localize( $dependency, $context );
	}
}


1			<?php
2			/**
3			* DependencyManager Class.
4			*
5			* @package BrightNucleus\Dependency
6			* @author Alain Schlesser <[email protected]>
7			* @license GPL-2.0+
8			* @link http://www.brightnucleus.com/
9			* @copyright 2015 Alain Schlesser, Bright NucleusInterface
10			*/
11
12			namespace BrightNucleus\Dependency;
13
14			use BrightNucleus\Config\ConfigInterface;
15			use BrightNucleus\Config\ConfigTrait;
16			use BrightNucleus\Exception\InvalidArgumentException;
17			use BrightNucleus\Exception\RuntimeException;
18
19			/**
20			* Register and enqueue dependencies that are listed in the config file.
21			*
22			* @since 0.1.0
23			*
24			* @package BrightNucleus\Dependency
25			* @author Alain Schlesser <[email protected]>
26			*/
27			class DependencyManager implements DependencyManagerInterface {
28
29			use ConfigTrait;
30
31			/*
32			* Default dependency handler implementations.
33			*/
34			const DEFAULT_SCRIPT_HANDLER = '\BrightNucleus\Dependency\ScriptHandler';
35			const DEFAULT_STYLE_HANDLER = '\BrightNucleus\Dependency\StyleHandler';
36
37			/*
38			* Names of the configuration keys.
39			*/
40			const KEY_HANDLERS = 'handlers';
41			const KEY_SCRIPTS = 'scripts';
42			const KEY_STYLES = 'styles';
43
44			/**
45			* Hold the dependencies, grouped by type.
46			*
47			* @since 0.1.0
48			*
49			* @var array;
50			*/
51			protected $dependencies = [ ];
52
53			/**
54			* Hold the handlers.
55			*
56			* @since 0.1.0
57			*
58			* @var array
59			*/
60			protected $handlers = [ ];
61
62			/**
63			* Whether to enqueue immediately upon registration.
64			*
65			* @since 0.2.2
66			*
67			* @var bool
68			*/
69			protected $enqueue_immediately;
70
71			/**
72			* Instantiate DependencyManager object.
73			*
74			* @since 0.1.0
75			*
76			* @param ConfigInterface $config ConfigInterface object that contains
77			* dependency settings.
78			* @param bool $enqueue Optional. Whether to enqueue
79			* immediately. Defaults to true.
80			* @throws RuntimeException If the config could not be processed.
81			* @throws InvalidArgumentException If no dependency handlers were
82			* specified.
83			*/
84			public function __construct( ConfigInterface $config, $enqueue = true ) {
85			$this->processConfig( $config );
86			$this->enqueue_immediately = $enqueue;
87			$this->init_handlers();
88			$this->init_dependencies();
89			}
90
91			/**
92			* Initialize the dependency handlers.
93			*
94			* @since 0.1.0
95			*/
96			protected function init_handlers() {
97			$keys = [ self::KEY_SCRIPTS, self::KEY_STYLES ];
98			foreach ( $keys as $key ) {
99			if ( $this->hasConfigKey( $key ) ) {
100			$this->add_handler( $key );
101			}
102			}
103			}
104
105			/**
106			* Add a single dependency handler.
107			*
108			* @since 0.1.0
109			*
110			* @param string $dependency The dependency type for which to add a handler.
111			*/
112			protected function add_handler( $dependency ) {
113			if ( $this->hasConfigKey( $dependency ) ) {
114			$handler = $this->hasConfigKey( self::KEY_HANDLERS, $dependency )
115			? $this->getConfigKey( self::KEY_HANDLERS, $dependency )
116			: $this->get_default_handler( $dependency );
117			if ( $handler ) {
118			$this->handlers[ $dependency ] = $handler;
119			}
120			}
121			}
122
123			/**
124			* Get the default handler class for a given type of dependency.
125			*
126			* @since 0.1.0
127			*
128			* @param string $dependency The dependency that needs a handler.
129			* @return string\|null Class name of the handler. Null if none.
130			*/
131			protected function get_default_handler( $dependency ) {
132			switch ( $dependency ) {
133			case self::KEY_STYLES:
134			return self::DEFAULT_STYLE_HANDLER;
135			case self::KEY_SCRIPTS:
136			return self::DEFAULT_SCRIPT_HANDLER;
137			default:
138			return null;
139			}
140			}
141
142			/**
143			* Initialize the actual dependencies.
144			*
145			* @since 0.1.0
146			*/
147			protected function init_dependencies() {
148			array_walk( $this->handlers,
149			function ( $handler, $dependency_type ) {
150			if ( $this->hasConfigKey( $dependency_type ) ) {
151			$this->dependencies[ $dependency_type ] = $this->getConfigKey( $dependency_type );
152			}
153			} );
154			}
155
156			/**
157			* Register all dependencies.
158			*
159			* @since 0.1.0
160			*
161			* @param mixed $context Optional. The context to pass to the dependencies.
162			*/
163			public function register( $context = null ) {
164			$context = $this->validate_context( $context );
165			array_walk( $this->dependencies,
166			[ $this, 'register_dependency_type' ], $context );
167			}
168
169			/**
170			* Validate the context to make sure it is an array.
171			*
172			* @since 0.2.1
173			*
174			* @param mixed $context The context as passed in by WordPress.
175			* @return array Validated context.
176			*/
177			protected function validate_context( $context ) {
178			if ( is_string( $context ) ) {
179			return [ 'wp_context' => $context ];
180			}
181			return (array) $context;
182			}
183
184			/**
185			* Enqueue all dependencies.
186			*
187			* @since 0.1.0
188			*
189			* @param mixed $context Optional. The context to pass to the
190			* dependencies.
191			*/
192			public function enqueue( $context = null ) {
193			$context = $this->validate_context( $context );
194
195			array_walk( $this->dependencies,
196			[ $this, 'enqueue_dependency_type' ], $context );
197			}
198
199			/**
200			* Enqueue a single dependency retrieved by its handle.
201			*
202			* @since 0.2.2
203			*
204			* @param string $handle The dependency handle to enqueue.
205			* @param mixed $context Optional. The context to pass to the
206			* dependencies.
207			* @return bool Returns whether the handle was found or not.
208			*/
209			public function enqueue_handle( $handle, $context = null ) {
210			list( $dependency_key, $dependency ) = $this->get_dependency_array( $handle );
211			if ( $dependency ) {
212
213			$this->enqueue_dependency(
214			$dependency,
215			$dependency_key,
216			$context
217			);
218
219			$this->maybe_localize( $dependency, $context );
220
221			return true;
222			}
223			return false;
224			}
225
226			/**
227			* Get the matching dependency for a given handle.
228			*
229			* @since 0.2.2
230			*
231			* @param string $handle The dependency handle to search for.
232			* @return array Array containing the dependency key as well as the
233			* dependency array itself.
234			*/
235			protected function get_dependency_array( $handle ) {
236			foreach ( $this->dependencies as $dependency_type ) {
237			$dependency_key = array_search( $handle, $dependency_type, true );
238			if ( $dependency_key ) {
239			return [ $dependency_key, $dependency_type[ $dependency_key ] ];
240			}
241			}
242			// Handle not found, return an empty array.
243			return [ '', null ];
244			}
245
246			/**
247			* Enqueue a single dependency.
248			*
249			* @since 0.1.0
250			*
251			* @param array $dependency Configuration data of the dependency.
252			* @param string $dependency_key Config key of the dependency.
253			* @param mixed $context Optional. Context to pass to the
254			* dependencies. Contains the type of the
255			* dependency at key
256			* 'dependency_type'.
257			*/
258			protected function enqueue_dependency( $dependency, $dependency_key, $context = null ) {
259			if ( ! $this->is_needed( $dependency, $context ) ) {
260			return;
261			}
262			/** @var \BrightNucleus\Contract\Enqueueable $handler */
263			$handler = new $this->handlers[$context['dependency_type']];
264			$handler->enqueue( $dependency );
265			}
266
267			/**
268			* Check whether a specific dependency is needed.
269			*
270			* @since 0.1.0
271			*
272			* @param array $dependency Configuration of the dependency to check.
273			* @param mixed $context Context to pass to the dependencies.
274			* Contains the type of the dependency at key
275			* 'dependency_type'.
276			* @return bool Whether it is needed or not.
277			*/
278			protected function is_needed( $dependency, $context ) {
279			$is_needed = array_key_exists( 'is_needed', $dependency )
280			? $dependency['is_needed']
281			: null;
282
283			if ( null === $is_needed ) {
284			return true;
285			}
286
287			return is_callable( $is_needed ) && $is_needed( $context );
288			}
289
290			/**
291			* Localize the script of a given dependency.
292			*
293			* @since 0.1.0
294			*
295			* @param array $dependency The dependency to localize the script of.
296			* @param mixed $context Contextual data to pass to the callback.
297			* Contains the type of the dependency at key
298			* 'dependency_type'.
299			*/
300			protected function maybe_localize( $dependency, $context ) {
301			if ( ! array_key_exists( 'localize', $dependency ) ) {
302			return;
303			}
304
305			$localize = $dependency['localize'];
306			$data = $localize['data'];
307			if ( is_callable( $data ) ) {
308			$data = $data( $context );
309			}
310
311			\wp_localize_script( $dependency['handle'], $localize['name'], $data );
312			}
313
314			/**
315			* Enqueue all dependencies of a specific type.
316			*
317			* @since 0.1.0
318			*
319			* @param array $dependencies The dependencies to enqueue.
320			* @param string $dependency_type The type of the dependencies.
321			* @param mixed $context Optional. The context to pass to the
322			* dependencies.
323			*/
324			protected function enqueue_dependency_type( $dependencies, $dependency_type, $context = null ) {
325			$context['dependency_type'] = $dependency_type;
326			array_walk( $dependencies, [ $this, 'enqueue_dependency' ], $context );
327			}
328
329			/**
330			* Register all dependencies of a specific type.
331			*
332			* @since 0.1.0
333			*
334			* @param array $dependencies The dependencies to register.
335			* @param string $dependency_type The type of the dependencies.
336			* @param mixed $context Optional. The context to pass to the
337			* dependencies.
338			*/
339			protected function register_dependency_type( $dependencies, $dependency_type, $context = null ) {
340			$context['dependency_type'] = $dependency_type;
341			array_walk( $dependencies, [ $this, 'register_dependency' ], $context );
342			}
343
344			/**
345			* Register a single dependency.
346			*
347			* @since 0.1.0
348			*
349			* @param array $dependency Configuration data of the dependency.
350			* @param string $dependency_key Config key of the dependency.
351			* @param mixed $context Optional. Context to pass to the
352			* dependencies. Contains the type of the
353			* dependency at key
354			* 'dependency_type'.
355			*/
356			protected function register_dependency( $dependency, $dependency_key, $context = null ) {
357			/** @var \BrightNucleus\Contract\Registerable $handler */
358			$handler = new $this->handlers[$context['dependency_type']];
359			$handler->register( $dependency );
360
361			if ( $this->enqueue_immediately ) {
362			$this->register_enqueue_hooks( $dependency, $context );
363			}
364			}
365
366			/**
367			* Register the enqueueing to WordPress hooks.
368			*
369			* @since 0.2.2
370			*
371			* @param array $dependency Configuration data of the dependency.
372			* @param mixed $context Optional. Context to pass to the dependencies.
373			* Contains the type of the dependency at key
374			* 'dependency_type'.
375			*/
376			protected function register_enqueue_hooks( $dependency, $context = null ) {
377			$priority = $this->get_priority( $dependency );
			0 ignored issues – show Bug introduced 2016-02-25 07:03 UTC by Report Bug Copy Issue Report The method `get_priority()` does not seem to exist on `object<BrightNucleus\Dep...ency\DependencyManager>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
378
379			foreach ( [ 'wp_enqueue_scripts', 'admin_enqueue_scripts' ] as $hook ) {
380			\add_action( $hook, [ $this, 'enqueue' ], $priority, 1 );
381			}
382
383			$this->maybe_localize( $dependency, $context );
384			}
385			}
386

brightnucleus / dependencies

Push — master ( 3447e3...3ca089 )

DependencyManager::init_handlers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like