class-menu.php

<?php
/**
 * Class Menu
 *
 * @package wpct-plugin
 */

// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals

namespace WPCT_PLUGIN;

use ArgumentCountError;

if ( ! defined( 'ABSPATH' ) ) {
	exit();
}

/**
 * Plugin menu abstract class.
 */
class Menu extends Singleton {
	/**
	 * Handle menu name.
	 *
	 * @var string
	 */
	private $name;

	/**
	 * Handle menu slug.
	 *
	 * @var string
	 */
	private $slug;

	/**
	 * Handle plugin settings store instance.
	 *
	 * @var Settings_Store
	 */
	private $store;

	/**
	 * Class constructor. Set attributes and hooks to wp admin hooks.
	 *
	 * @param array{0: string, 1:string, 2:Settings_Store} ...$args Constructor arguments:
	 *                                                              1. Menu name.
	 *                                                              2. Plugin slug.
	 *                                                              3. Plugin store.
	 *
	 * @throws ArgumentCountError If parameters are not passed to the constructor.
	 */
	protected function construct( ...$args ) {
		if ( count( $args ) < 3 ) {
			throw new ArgumentCountError( 'Too few arguments to Menu constructor' );
		}

		list( $name, $slug, $store ) = $args;
		$this->name                  = $name;
		$this->slug                  = $slug;
		$this->store                 = $store;

		add_action(
			'admin_menu',
			function () {
				static::add_menu();
				do_action( 'wpct_plugin_register_menu', $this->name, $this );
			}
		);
	}

	/**
	 * Register plugin options page.
	 */
	private static function add_menu() {
		add_options_page(
			static::name(),
			static::name(),
			'manage_options',
			static::slug(),
			static function () {
				static::render_page();
			}
		);
	}

	/**
	 * Render menu page HTML.
	 *
	 * @param bool $echo Control if the HTML is outputed as a return value or
	 *                   echoed to the output buffer.
	 *
	 * @return string|null Page content.
	 */
	protected static function render_page( $echo = true ) {
		$store_settings = static::store()->settings();

		$tabs = array();

		foreach ( $store_settings as $setting ) {
			$setting_name          = $setting->option();
			$tabs[ $setting_name ] = esc_html(
				static::tab_title( $setting_name )
			);
		}

		$current_tab = isset( $_GET['tab'] )
			? sanitize_text_field( wp_unslash( $_GET['tab'] ) )
			: array_key_first( $tabs );

		ob_start();
		?>
			<div class="wrap">
			<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
				<form method="post" action="options.php">
					<nav class="nav-tab-wrapper">
				<?php
				foreach ( $tabs as $tab => $name ) {
					$current = $tab === $current_tab ? 'nav-tab-active' : '';
					$url     = add_query_arg(
						array(
							'page' => static::slug(),
							'tab'  => $tab,
						),
						''
					);
					printf(
						'<a class="nav-tab %s" href="%s">%s</a>',
						esc_attr( $current ),
						esc_url( $url ),
						esc_html( $name )
					);
				}
				?>
					</nav>
				<?php
				settings_fields( $current_tab );
				do_settings_sections( $current_tab );
				submit_button();
				?>
				</form>
			</div>
			<?php
			$output = ob_get_clean();

			if ( $echo ) {
				// phpcs:disable WordPress.Security.EscapeOutput
				echo $output;
				// phpcs:enable WordPress.Security.EscapeOutput
			}

			return $output;
	}

	/**
	 * Menu name getter.
	 *
	 * @return string $name menu name
	 */
	final public static function name() {
		return static::get_instance()->name;
	}

	/**
	 * Menu slug getter.
	 *
	 * @return string $slug menu slug
	 */
	final public static function slug() {
		return static::get_instance()->slug;
	}

	/**
	 * Menu settings store getter.
	 *
	 * @return Settings_Store plugin settings store instance
	 */
	final public static function store() {
		return static::get_instance()->store;
	}

	/**
	 * To be overwriten by the child class.
	 *
	 * @param string $setting_name Setting name.
	 *
	 * @return string
	 */
	protected static function tab_title( $setting_name ) {
		return $setting_name;
	}

	/**
	 * Check if the current page is the plugin admin page.
	 *
	 * @return boolean
	 */
	public static function is_admin_current_page() {
		if ( is_admin() ) {
			$page = isset( $_GET['page'] )
				? sanitize_text_field( wp_unslash( $_GET['page'] ) )
				: null;
			$slug = static::slug();

			return $page && $page === $slug;
		}

		return false;
	}
}