<?php
/**
 * Base class to register a suite plugin under 53mp Tools.
 *
 * Loaded once by fifty-three-minute-tools-loader.php (highest SUITE_VERSION wins).
 * Extend in your plugin admin class and call Your_Admin::init() on plugins_loaded after priority 1.
 *
 * Declared only when an older copy has not already defined the class. init() writes
 * into the fifty_three_minute_tools_plugins registry; the winning core creates submenus.
 *
 * @package Fifty_Three_Minute_Tools
 */

defined( 'ABSPATH' ) || exit;

if ( ! class_exists( 'Fifty_Three_Minute_Tools_Submenu', false ) ) {

	/**
	 * Registers a plugin with the shared 53mp Tools menu.
	 */
	abstract class Fifty_Three_Minute_Tools_Submenu {

		/**
		 * Shared suite class version (must match fifty-three-minute-tools-version.php in this bundle).
		 */
		const SUITE_VERSION = '1.4.0';

		const PAGE_SLUG = '';

		/**
		 * Register this plugin with the shared menu.
		 */
		public static function init() {
			if ( ! function_exists( 'fifty_three_minute_tools_register_parent_menu' ) ) {
				return;
			}

			fifty_three_minute_tools_register_parent_menu();

			add_filter( 'fifty_three_minute_tools_plugins', array( get_called_class(), 'register_plugin' ) );
		}

		/**
		 * Submenu page slug.
		 *
		 * @return string
		 */
		public static function get_page_slug() {
			$slug = static::PAGE_SLUG;

			if ( '' === $slug ) {
				$slug = static::get_page_slug_fallback();
			}

			return $slug;
		}

		/**
		 * Optional override when not using PAGE_SLUG constant.
		 *
		 * @return string
		 */
		protected static function get_page_slug_fallback() {
			return '';
		}

		abstract public static function get_capability();

		abstract public static function get_text_domain();

		abstract public static function get_menu_title();

		public static function get_page_title() {
			return static::get_menu_title();
		}

		/**
		 * Optional submenu position. Null sorts with the other unpositioned items by title.
		 *
		 * @return int|null
		 */
		public static function get_menu_position() {
			return null;
		}

		/**
		 * Absolute path to this plugin's main file, used to match get_plugins() keys.
		 *
		 * @return string
		 */
		public static function get_plugin_file() {
			return '';
		}

		abstract public static function render_page();

		public static function get_hook_suffix() {
			return fifty_three_minute_tools_menu_slug() . '_page_' . static::get_page_slug();
		}

		public static function get_admin_url() {
			return admin_url( 'admin.php?page=' . static::get_page_slug() );
		}

		/**
		 * Add this plugin to the shared registry. The winning core creates the submenu.
		 *
		 * @param array<string, array<string, mixed>> $plugins Registered plugins.
		 * @return array<string, array<string, mixed>>
		 */
		public static function register_plugin( $plugins ) {
			if ( ! is_array( $plugins ) ) {
				$plugins = array();
			}

			$slug = static::get_page_slug();

			if ( '' === $slug ) {
				return $plugins;
			}

			$plugin_file = '';
			$path        = (string) static::get_plugin_file();

			if ( '' !== $path ) {
				$plugin_file = plugin_basename( $path );
			}

			$plugins[ $slug ] = array(
				'menu_title'  => static::get_menu_title(),
				'page_title'  => static::get_page_title(),
				'menu_slug'   => $slug,
				'capability'  => static::get_capability(),
				'callback'    => array( get_called_class(), 'render_page' ),
				'plugin_file' => $plugin_file,
				'position'    => static::get_menu_position(),
			);

			return $plugins;
		}

		/**
		 * Direct submenu registration kept for callers that invoke it themselves.
		 */
		public static function register_submenu() {
			add_submenu_page(
				fifty_three_minute_tools_menu_slug(),
				static::get_page_title(),
				static::get_menu_title(),
				static::get_capability(),
				static::get_page_slug(),
				array( get_called_class(), 'render_page' )
			);
		}

		public static function get_dashboard_blurb_title() {
			return static::get_menu_title();
		}

		public static function get_dashboard_blurb_content( $url ) {
			return sprintf(
				/* translators: %s: URL to the plugin admin page. */
				__( '<a href="%s">Open tool</a>.', '53mp-fast-bulk-page-creator' ),
				esc_url( $url )
			);
		}

		/**
		 * @param array<int, array{title:string, content:string}> $sections Dashboard sections.
		 * @return array<int, array{title:string, content:string}>
		 */
		public static function add_dashboard_blurb( $sections ) {
			if ( ! current_user_can( static::get_capability() ) ) {
				return $sections;
			}

			$content = static::get_dashboard_blurb_content( static::get_admin_url() );

			if ( '' === $content ) {
				return $sections;
			}

			$sections[] = array(
				'title'   => static::get_dashboard_blurb_title(),
				'content' => $content,
			);

			return $sections;
		}
	}
}