Page_Dispatcher::__construct() - Code Metrics - Pink-Crab/Perique_Admin_Menu - Measure and Improve Code Quality continuously with Scrutinizer

Page_Dispatcher::__construct() A
last analyzed 2025-01-28 09:54 UTC

↳ Parent: Page_Dispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

/**
 * Registers page groups.
 *
 * 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_Admin_Menu
 */

namespace PinkCrab\Perique_Admin_Menu\Registrar;

use Throwable;
use PinkCrab\Perique\Services\View\View;
use PinkCrab\Perique_Admin_Menu\Page\Page;
use PinkCrab\Perique\Interfaces\DI_Container;
use PinkCrab\Perique_Admin_Menu\Registrar\Registrar;
use PinkCrab\Perique_Admin_Menu\Group\Abstract_Group;
use PinkCrab\Perique_Admin_Menu\Exception\Page_Exception;
use PinkCrab\Perique_Admin_Menu\Exception\Group_Exception;
use PinkCrab\Perique_Admin_Menu\Validator\Group_Validator;

class Page_Dispatcher {

	protected DI_Container $di_container;
	protected View $view;
	protected Registrar $registrar;

	public function __construct( DI_Container $di_container, View $view, Registrar $registrar ) {
		$this->di_container = $di_container;
		$this->view         = $view;
		$this->registrar    = $registrar;
	}

	/**
	 * Registers the group and all of its pages.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
	 * @return void
	 */
	public function register_group( Abstract_Group $group ): void {

		// If current user can not access the group, bail without attempting to register.
		if ( ! current_user_can( $group->get_capability() ) ) {
			return;
		}

		try {

			// Validate the group.
			$validator = new Group_Validator();
			if ( ! $validator->validate( $group ) ) {
				throw Group_Exception::failed_validation( $validator, $group );
			}

			$this->register_primary_page( $group );

			// Register all pages and attempt to set primary page name in menu.
			foreach ( $this->get_pages( $group ) as $page ) {
				$this->register_subpage( $page, $this->get_primary_page( $group )->slug(), $group );
			}
			$this->set_primary_page_details( $group );
		} catch ( \Throwable $th ) {
			$this->admin_exception_notice( $group, $th );
		}
	}

	/**
	 * Handles the display of errors thrown registering admin menu pages in wp_admin.
	 *
	 * @param Abstract_Group|Page $object_instance
	 * @param \Throwable          $exception
	 * @return void
	 */
	public function admin_exception_notice( $object_instance, Throwable $exception ): void {
		add_action(
			'admin_notices',
			function () use ( $object_instance, $exception ) {
				$class   = 'notice notice-error';
				$message = sprintf(
					'%s <i>%s</i> generated errors while being registered. This might result in admin pages being missing or broken. <br><b>%s(%s: %s)</b>',
					get_class( $object_instance ) === Page::class ? 'Page' : 'Menu Group',
					get_class( $object_instance ),
					$exception->getMessage(),
					$exception->getFile(),
					$exception->getLine()
				);
				printf(
					'<div class="%1$s"><p>%2$s</p></div>',
					esc_attr( $class ),
					wp_kses(
						$message,
						array(
							'br' => array(),
							'b'  => array(),
							'i'  => array(),
						)
					)
				);
			}
		);
	}

	/**
	 * Registers the primary page and group.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
	 * @return void
	 */
	protected function register_primary_page( Abstract_Group $group ): void {
		$this->registrar->register_primary(
			$this->get_primary_page( $group ),
			$group
		);
	}

	/**
	 * Gets the constructed primary page.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
	 * @return \PinkCrab\Perique_Admin_Menu\Page\Page
	 */
	protected function get_primary_page( Abstract_Group $group ): Page {
		/**
 * @var Page
*/
		$page = $this->di_container->create( $group->get_primary_page() );

		if ( ! is_object( $page ) || ! is_a( $page, Page::class ) ) {
			throw Page_Exception::invalid_page_type( $page ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped, escaped in exception.
		}

		// Register view if requied.
		if ( \method_exists( $page, 'set_view' ) ) {
			$page->set_view( $this->view );
		}

		return $page;
	}

	/**
	 * Returns an array of all pages, constructed.
	 * Excludes the primary page.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
	 * @return array<Page>
	 * @throws Page_Exception (Code 202)
	 */
	protected function get_pages( Abstract_Group $group ): array {
		return array_map(
			function ( string $page ): Page {
				$constructed_page = $this->di_container->create( $page );
				if ( ! is_object( $constructed_page ) || ! is_a( $constructed_page, Page::class ) ) {
					throw Page_Exception::invalid_page_type( $constructed_page ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped, escaped in exception.
				}
				return $constructed_page;
			},
			array_filter(
				$group->get_pages(),
				function ( string $page ) use ( $group ) {
					return $page !== $group->get_primary_page();
				}
			)
		);
	}


	/**
	 * Sets the menu title the primary page value.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
	 * @return void
	 * @phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
	 * @throws Group_Exception (code 253)
	 */
	protected function set_primary_page_details( Abstract_Group $group ) {
		global $submenu;

		$primary = $this->get_primary_page( $group );

		if ( ! array_key_exists( $primary->slug(), $submenu ) ) {
			return;
		}

		$primary_page_key = array_search(
			$primary->slug(),
			\array_column( $submenu[ $primary->slug() ], 2 ),
			true
		) ?: 0; // phpcs:ignore Universal.Operators.DisallowShortTernary.Found

		$submenu[ $primary->slug() ][ $primary_page_key ][0] = $primary->menu_title();
	}


	/**
	 * Registers a subpage.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Page\Page                 $page
	 * @param string                                                 $parent_slug
	 * @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group|null $group
	 * @return void
	 */
	public function register_subpage( Page $page, string $parent_slug, ?Abstract_Group $group = null ): void {
		// If user cant access the page, bail before attempting to register.
		if ( ! current_user_can( $page->capability() ) ) {
			return;
		}

		// Register view if required.
		if ( \method_exists( $page, 'set_view' ) ) {
			$page->set_view( $this->view );
		}

		try {
			$this->registrar->register_subpage( $page, $parent_slug, $group );
		} catch ( \Throwable $th ) {
			$this->admin_exception_notice( $page, $th );
		}
	}

	/**
	 * Registers a single page.
	 *
	 * @param \PinkCrab\Perique_Admin_Menu\Page\Page $page
	 * @return void
	 */
	public function register_single_page( Page $page ): void {
		// Register view if required.
		if ( \method_exists( $page, 'set_view' ) ) {
			$page->set_view( $this->view );
		}

		try {
			$this->registrar->register_primary( $page, null );
		} catch ( \Throwable $th ) {
			$this->admin_exception_notice( $page, $th );
		}
	}
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Registers page groups.
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_Admin_Menu
23			*/
24
25			namespace PinkCrab\Perique_Admin_Menu\Registrar;
26
27			use Throwable;
28			use PinkCrab\Perique\Services\View\View;
29			use PinkCrab\Perique_Admin_Menu\Page\Page;
30			use PinkCrab\Perique\Interfaces\DI_Container;
31			use PinkCrab\Perique_Admin_Menu\Registrar\Registrar;
32			use PinkCrab\Perique_Admin_Menu\Group\Abstract_Group;
33			use PinkCrab\Perique_Admin_Menu\Exception\Page_Exception;
34			use PinkCrab\Perique_Admin_Menu\Exception\Group_Exception;
35			use PinkCrab\Perique_Admin_Menu\Validator\Group_Validator;
36
37			class Page_Dispatcher {
38
39			protected DI_Container $di_container;
40			protected View $view;
41			protected Registrar $registrar;
42
43			public function __construct( DI_Container $di_container, View $view, Registrar $registrar ) {
44			$this->di_container = $di_container;
45			$this->view = $view;
46			$this->registrar = $registrar;
47			}
48
49			/**
50			* Registers the group and all of its pages.
51			*
52			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
53			* @return void
54			*/
55			public function register_group( Abstract_Group $group ): void {
56
57			// If current user can not access the group, bail without attempting to register.
58			if ( ! current_user_can( $group->get_capability() ) ) {
59			return;
60			}
61
62			try {
63
64			// Validate the group.
65			$validator = new Group_Validator();
66			if ( ! $validator->validate( $group ) ) {
67			throw Group_Exception::failed_validation( $validator, $group );
68			}
69
70			$this->register_primary_page( $group );
71
72			// Register all pages and attempt to set primary page name in menu.
73			foreach ( $this->get_pages( $group ) as $page ) {
74			$this->register_subpage( $page, $this->get_primary_page( $group )->slug(), $group );
75			}
76			$this->set_primary_page_details( $group );
77			} catch ( \Throwable $th ) {
78			$this->admin_exception_notice( $group, $th );
79			}
80			}
81
82			/**
83			* Handles the display of errors thrown registering admin menu pages in wp_admin.
84			*
85			* @param Abstract_Group\|Page $object_instance
86			* @param \Throwable $exception
87			* @return void
88			*/
89			public function admin_exception_notice( $object_instance, Throwable $exception ): void {
90			add_action(
91			'admin_notices',
92			function () use ( $object_instance, $exception ) {
93			$class = 'notice notice-error';
94			$message = sprintf(
95			'%s <i>%s</i> generated errors while being registered. This might result in admin pages being missing or broken. <br><b>%s(%s: %s)</b>',
96			get_class( $object_instance ) === Page::class ? 'Page' : 'Menu Group',
97			get_class( $object_instance ),
98			$exception->getMessage(),
99			$exception->getFile(),
100			$exception->getLine()
101			);
102			printf(
103			'<div class="%1$s"><p>%2$s</p></div>',
104			esc_attr( $class ),
105			wp_kses(
106			$message,
107			array(
108			'br' => array(),
109			'b' => array(),
110			'i' => array(),
111			)
112			)
113			);
114			}
115			);
116			}
117
118			/**
119			* Registers the primary page and group.
120			*
121			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
122			* @return void
123			*/
124			protected function register_primary_page( Abstract_Group $group ): void {
125			$this->registrar->register_primary(
126			$this->get_primary_page( $group ),
127			$group
128			);
129			}
130
131			/**
132			* Gets the constructed primary page.
133			*
134			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
135			* @return \PinkCrab\Perique_Admin_Menu\Page\Page
136			*/
137			protected function get_primary_page( Abstract_Group $group ): Page {
138			/**
139			* @var Page
140			*/
141			$page = $this->di_container->create( $group->get_primary_page() );
142
143			if ( ! is_object( $page ) \|\| ! is_a( $page, Page::class ) ) {
144			throw Page_Exception::invalid_page_type( $page ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped, escaped in exception.
145			}
146
147			// Register view if requied.
148			if ( \method_exists( $page, 'set_view' ) ) {
149			$page->set_view( $this->view );
150			}
151
152			return $page;
153			}
154
155			/**
156			* Returns an array of all pages, constructed.
157			* Excludes the primary page.
158			*
159			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
160			* @return array<Page>
161			* @throws Page_Exception (Code 202)
162			*/
163			protected function get_pages( Abstract_Group $group ): array {
164			return array_map(
165			function ( string $page ): Page {
166			$constructed_page = $this->di_container->create( $page );
167			if ( ! is_object( $constructed_page ) \|\| ! is_a( $constructed_page, Page::class ) ) {
168			throw Page_Exception::invalid_page_type( $constructed_page ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped, escaped in exception.
169			}
170			return $constructed_page;
171			},
172			array_filter(
173			$group->get_pages(),
174			function ( string $page ) use ( $group ) {
175			return $page !== $group->get_primary_page();
176			}
177			)
178			);
179			}
180
181
182			/**
183			* Sets the menu title the primary page value.
184			*
185			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group $group
186			* @return void
187			* @phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
188			* @throws Group_Exception (code 253)
189			*/
190			protected function set_primary_page_details( Abstract_Group $group ) {
191			global $submenu;
192
193			$primary = $this->get_primary_page( $group );
194
195			if ( ! array_key_exists( $primary->slug(), $submenu ) ) {
196			return;
197			}
198
199			$primary_page_key = array_search(
200			$primary->slug(),
201			\array_column( $submenu[ $primary->slug() ], 2 ),
202			true
203			) ?: 0; // phpcs:ignore Universal.Operators.DisallowShortTernary.Found
204
205			$submenu[ $primary->slug() ][ $primary_page_key ][0] = $primary->menu_title();
206			}
207
208
209			/**
210			* Registers a subpage.
211			*
212			* @param \PinkCrab\Perique_Admin_Menu\Page\Page $page
213			* @param string $parent_slug
214			* @param \PinkCrab\Perique_Admin_Menu\Group\Abstract_Group\|null $group
215			* @return void
216			*/
217			public function register_subpage( Page $page, string $parent_slug, ?Abstract_Group $group = null ): void {
218			// If user cant access the page, bail before attempting to register.
219			if ( ! current_user_can( $page->capability() ) ) {
220			return;
221			}
222
223			// Register view if required.
224			if ( \method_exists( $page, 'set_view' ) ) {
225			$page->set_view( $this->view );
226			}
227
228			try {
229			$this->registrar->register_subpage( $page, $parent_slug, $group );
230			} catch ( \Throwable $th ) {
231			$this->admin_exception_notice( $page, $th );
232			}
233			}
234
235			/**
236			* Registers a single page.
237			*
238			* @param \PinkCrab\Perique_Admin_Menu\Page\Page $page
239			* @return void
240			*/
241			public function register_single_page( Page $page ): void {
242			// Register view if required.
243			if ( \method_exists( $page, 'set_view' ) ) {
244			$page->set_view( $this->view );
245			}
246
247			try {
248			$this->registrar->register_primary( $page, null );
249			} catch ( \Throwable $th ) {
250			$this->admin_exception_notice( $page, $th );
251			}
252			}
253			}
254

Pink-Crab / Perique_Admin_Menu

Page_Dispatcher::__construct() A last analyzed 2025-01-28 09:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Page_Dispatcher::__construct() A
last analyzed 2025-01-28 09:54 UTC