Module_Manager::create_module() - Code Metrics - Inspection of "Release/2.0.0" - Pink-Crab/Perique-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#158)

by Glynn

created 2023-04-03 11:27 UTC

Module_Manager::create_module() A

↳ Parent: Module_Manager

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	5
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	11
rs	10

<?php

declare(strict_types=1);

/**
 * Module loader
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Glynn Quelch <[email protected]>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\Perique\Module
 * @since 2.0.0
 */

namespace PinkCrab\Perique\Services\Registration;

use Exception;
use PinkCrab\Loader\Hook_Loader;
use PinkCrab\Perique\Application\Hooks;
use PinkCrab\Perique\Interfaces\Module;
use PinkCrab\Perique\Interfaces\DI_Container;
use PinkCrab\Perique\Interfaces\Inject_Hook_Loader;
use PinkCrab\Perique\Interfaces\Registration_Middleware;
use PinkCrab\Perique\Exceptions\Module_Manager_Exception;
use PinkCrab\Perique\Services\Registration\Registration_Service;

final class Module_Manager {

	/**
	 * Modules
	 *
	 * @since 2.0.0
	 * @var array{
	 *  0:class-string<Module>,
	 *  1:?callable(Module, ?Registration_Middleware):Module
	 * }[]
	 */
	protected array $modules = array();

	/**
	 * Access to the DI Container
	 *
	 * @var DI_Container
	 */
	private DI_Container $di_container;

	/**
	 * Manages all the Registration Middleware.
	 *
	 * @var Registration_Service
	 */
	private Registration_Service $registration_service;

	/**
	 * Creates a new instance of the registration service.
	 *
	 * @param DI_Container $di_container
	 */
	public function __construct( DI_Container $di_container, Registration_Service $registration_service ) {
		$this->di_container = $di_container;

		// Create the registration service.
		$this->registration_service = $registration_service;
	}

	/**
	 * Adds a module to the manager.
	 *
	 * @template Module_Instance of Module
	 * @param class-string<Module_Instance> $module_name

	 * @param ?callable(Module, ?Registration_Middleware):Module $config
	 * @return void
	 */
	public function push_module( string $module_name, ?callable $config = null ): void {
		$this->modules[] = array( $module_name, $config );
	}

	/**
	 * Adds a class to the Registration Service.
	 *
	 * @param class-string $class

	 */
	public function register_class( string $class ): void {
		$this->registration_service->push_class( $class );
	}

	/**
	 * Creates and registers all modules.
	 *
	 * @throws Module_Manager_Exception If invalid module class name provided (Code 20)
	 * @throws Module_Manager_Exception If module does not implement Module (Code 21)
	 * @throws Module_Manager_Exception If module does not implement Registration_Middleware (Code 22)
	 */
	public function register_modules(): void {
		// Allow for additional apps to hook into the Module Manager.
		do_action( Hooks::MODULE_MANAGER, $this );

		foreach ( $this->modules as list($module_name, $config) ) {
			// Create the instance.
			$module = $this->create_module( $module_name );

			// Create the middleware.
			$middleware = $this->create_middleware( $module );

			// If a config is provided, call it.
			if ( ! is_null( $config ) ) {
				$module = $config( $module, $middleware );
			}

			// Add to the modules and register all hooks.
			$this->register_hooks( $module );

			// Add to the middleware, if provided.
			if ( ! is_null( $middleware ) ) {
				$this->registration_service->push_middleware( $middleware );
			}
		}
	}

	/**
	 * Creates the module from its class name.
	 *
	 * @param class-string<Module> $module

	 * @return Module
	 */
	private function create_module( string $module ): Module {
		$instance = $this->di_container->create( $module );

		// If not an object or not an instance of the module interface, throw.
		if ( ! is_object( $instance )
		|| ! is_a( $instance, Module::class, true )
		) {
			throw Module_Manager_Exception::invalid_module_class_name( $module );
		}

		return $instance;
	}

	/**
	 * Create the middleware from a module.
	 *
	 * @param Module $module
	 * @return Registration_Middleware|null
	 */
	private function create_middleware( Module $module ): ?Registration_Middleware {
		$middleware = $module->get_middleware();

		// If no middleware is provided, return null.
		if ( is_null( $middleware ) ) {
			return null;
		}

		// If not an object or not an instance of the module interface, throw.
		if ( ! is_a( $middleware, Registration_Middleware::class, true ) ) {
			throw Module_Manager_Exception::invalid_registration_middleware( $middleware );
		}

		// Create the middleware.
		$middleware = $this->di_container->create( $middleware );

		// If the middleware is not an object, throw.
		if ( ! is_object( $middleware )
		|| ! is_a( $middleware, Registration_Middleware::class, true )
		) {
			throw Module_Manager_Exception::failed_to_create_registration_middleware( $middleware );
		}

		return $middleware;
	}

	/**
	 * Register all hooks for modules.
	 *
	 * @param Module $module
	 * @return void
	 */
	private function register_hooks( Module $module ): void {
		add_action( Hooks::APP_INIT_PRE_BOOT, array( $module, 'pre_boot' ), 10, 3 );
		add_action( Hooks::APP_INIT_PRE_REGISTRATION, array( $module, 'pre_register' ), 10, 3 );
		add_action( Hooks::APP_INIT_POST_REGISTRATION, array( $module, 'post_register' ), 10, 3 );
	}

	/**
	 * Process all the middleware using Registration Service.
	 *
	 * @return void
	 */
	public function process_middleware(): void {

		// Register all modules.
		// $this->register_modules();

		// Process all middleware.
		$this->registration_service->process();
	}

}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Module loader
7			*
8			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
9			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
10			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
11			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
12			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
13			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
14			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
15			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
16			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
17			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
18			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
19			*
20			* @author Glynn Quelch <[email protected]>
21			* @license http://www.opensource.org/licenses/mit-license.html MIT License
22			* @package PinkCrab\Perique\Module
23			* @since 2.0.0
24			*/
25
26			namespace PinkCrab\Perique\Services\Registration;
27
28			use Exception;
29			use PinkCrab\Loader\Hook_Loader;
30			use PinkCrab\Perique\Application\Hooks;
31			use PinkCrab\Perique\Interfaces\Module;
32			use PinkCrab\Perique\Interfaces\DI_Container;
33			use PinkCrab\Perique\Interfaces\Inject_Hook_Loader;
34			use PinkCrab\Perique\Interfaces\Registration_Middleware;
35			use PinkCrab\Perique\Exceptions\Module_Manager_Exception;
36			use PinkCrab\Perique\Services\Registration\Registration_Service;
37
38			final class Module_Manager {
39
40			/**
41			* Modules
42			*
43			* @since 2.0.0
44			* @var array{
45			* 0:class-string<Module>,
46			* 1:?callable(Module, ?Registration_Middleware):Module
47			* }[]
48			*/
49			protected array $modules = array();
50
51			/**
52			* Access to the DI Container
53			*
54			* @var DI_Container
55			*/
56			private DI_Container $di_container;
57
58			/**
59			* Manages all the Registration Middleware.
60			*
61			* @var Registration_Service
62			*/
63			private Registration_Service $registration_service;
64
65			/**
66			* Creates a new instance of the registration service.
67			*
68			* @param DI_Container $di_container
69			*/
70			public function __construct( DI_Container $di_container, Registration_Service $registration_service ) {
71			$this->di_container = $di_container;
72
73			// Create the registration service.
74			$this->registration_service = $registration_service;
75			}
76
77			/**
78			* Adds a module to the manager.
79			*
80			* @template Module_Instance of Module
81			* @param class-string<Module_Instance> $module_name
			0 ignored issues – show Documentation Bug introduced 2023-04-03 11:35 UTC by Report Bug Copy Issue Report The doc comment `class-string<Module_Instance>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Module_Instance>. Loading history...
82			* @param ?callable(Module, ?Registration_Middleware):Module $config
83			* @return void
84			*/
85			public function push_module( string $module_name, ?callable $config = null ): void {
86			$this->modules[] = array( $module_name, $config );
87			}
88
89			/**
90			* Adds a class to the Registration Service.
91			*
92			* @param class-string $class
			0 ignored issues – show Documentation Bug introduced 2023-04-03 11:35 UTC by Report Bug Copy Issue Report The doc comment `class-string` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string. Loading history...
93			*/
94			public function register_class( string $class ): void {
95			$this->registration_service->push_class( $class );
96			}
97
98			/**
99			* Creates and registers all modules.
100			*
101			* @throws Module_Manager_Exception If invalid module class name provided (Code 20)
102			* @throws Module_Manager_Exception If module does not implement Module (Code 21)
103			* @throws Module_Manager_Exception If module does not implement Registration_Middleware (Code 22)
104			*/
105			public function register_modules(): void {
106			// Allow for additional apps to hook into the Module Manager.
107			do_action( Hooks::MODULE_MANAGER, $this );
108
109			foreach ( $this->modules as list($module_name, $config) ) {
110			// Create the instance.
111			$module = $this->create_module( $module_name );
112
113			// Create the middleware.
114			$middleware = $this->create_middleware( $module );
115
116			// If a config is provided, call it.
117			if ( ! is_null( $config ) ) {
118			$module = $config( $module, $middleware );
119			}
120
121			// Add to the modules and register all hooks.
122			$this->register_hooks( $module );
123
124			// Add to the middleware, if provided.
125			if ( ! is_null( $middleware ) ) {
126			$this->registration_service->push_middleware( $middleware );
127			}
128			}
129			}
130
131			/**
132			* Creates the module from its class name.
133			*
134			* @param class-string<Module> $module
			0 ignored issues – show Documentation Bug introduced 2023-04-03 11:35 UTC by Report Bug Copy Issue Report The doc comment `class-string<Module>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Module>. Loading history...
135			* @return Module
136			*/
137			private function create_module( string $module ): Module {
138			$instance = $this->di_container->create( $module );
139
140			// If not an object or not an instance of the module interface, throw.
141			if ( ! is_object( $instance )
142			\|\| ! is_a( $instance, Module::class, true )
143			) {
144			throw Module_Manager_Exception::invalid_module_class_name( $module );
145			}
146
147			return $instance;
148			}
149
150			/**
151			* Create the middleware from a module.
152			*
153			* @param Module $module
154			* @return Registration_Middleware\|null
155			*/
156			private function create_middleware( Module $module ): ?Registration_Middleware {
157			$middleware = $module->get_middleware();
158
159			// If no middleware is provided, return null.
160			if ( is_null( $middleware ) ) {
161			return null;
162			}
163
164			// If not an object or not an instance of the module interface, throw.
165			if ( ! is_a( $middleware, Registration_Middleware::class, true ) ) {
166			throw Module_Manager_Exception::invalid_registration_middleware( $middleware );
167			}
168
169			// Create the middleware.
170			$middleware = $this->di_container->create( $middleware );
171
172			// If the middleware is not an object, throw.
173			if ( ! is_object( $middleware )
174			\|\| ! is_a( $middleware, Registration_Middleware::class, true )
175			) {
176			throw Module_Manager_Exception::failed_to_create_registration_middleware( $middleware );
177			}
178
179			return $middleware;
180			}
181
182			/**
183			* Register all hooks for modules.
184			*
185			* @param Module $module
186			* @return void
187			*/
188			private function register_hooks( Module $module ): void {
189			add_action( Hooks::APP_INIT_PRE_BOOT, array( $module, 'pre_boot' ), 10, 3 );
190			add_action( Hooks::APP_INIT_PRE_REGISTRATION, array( $module, 'pre_register' ), 10, 3 );
191			add_action( Hooks::APP_INIT_POST_REGISTRATION, array( $module, 'post_register' ), 10, 3 );
192			}
193
194			/**
195			* Process all the middleware using Registration Service.
196			*
197			* @return void
198			*/
199			public function process_middleware(): void {
200
201			// Register all modules.
202			// $this->register_modules();
203
204			// Process all middleware.
205			$this->registration_service->process();
206			}
207
208			}
209

Pink-Crab / Perique-Framework

Pull Request — master (#158)

Module_Manager::create_module() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like