<?php
/**
 * Easy Digital Downloads Settings Tabs
 *
 * @package     EDD
 * @subpackage  Settings
 * @copyright   Copyright (c) 2023, Easy Digital Downloads
 * @license     https://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       3.1.4
 */

namespace EDD\Admin\Settings\Tabs;

use EDD\Admin\Settings\Traits\Helpers;

defined( 'ABSPATH' ) || exit; // @codeCoverageIgnore

/**
 * Abstract class for a settings tab.
 *
 * @since 3.1.4
 */
abstract class Tab {

	use Helpers;

	/**
	 * The ID for this tab.
	 *
	 * @since 3.1.4
	 *
	 * @var string
	 */
	protected $id;

	/**
	 * The pass ID.
	 *
	 * @since 3.2.8
	 * @var int|bool
	 */
	private $pass_id;

	/**
	 * Constructor for the Tab class.
	 */
	public function __construct() {
		add_filter( 'edd_flyout_docs_link', array( $this, 'update_docs_link' ) );
	}

	/**
	 * Get the settings for this tab.
	 *
	 * @since 3.1.4
	 * @return array
	 */
	public function get() {
		return apply_filters( 'edd_settings_' . $this->get_id(), $this->register() );
	}

	/**
	 * Updates the documentation link.
	 *
	 * @since 3.3.0
	 * @param string $link The current documentation link.
	 * @return string
	 */
	public function update_docs_link( $link ) {
		return $link;
	}

	/**
	 * Get the ID for this tab.
	 *
	 * @since 3.1.4
	 *
	 * @throws \Exception If the ID property is not set.
	 *
	 * @return string
	 */
	protected function get_id() {
		try {
			if ( empty( $this->id ) ) {
				/* translators: %s: Tab class name. */
				throw new \Exception( sprintf( __( 'The %s settings class is missing the required ID property.', 'easy-digital-downloads' ), get_class( $this ) ) );
			}
		} catch ( \Exception $e ) {
			wp_die( esc_html( $e->getMessage() ) );
		}

		return $this->id;
	}

	/**
	 * Register the settings for this tab.
	 *
	 * @since 3.1.4
	 * @return array
	 */
	abstract protected function register();

	/**
	 * Gets the site name.
	 *
	 * @since 3.1.4
	 * @return string
	 */
	protected function get_site_name() {
		return get_bloginfo( 'name' );
	}

	/**
	 * Gets the admin email address.
	 *
	 * @since 3.1.4
	 * @return string
	 */
	protected function get_admin_email() {
		return get_bloginfo( 'admin_email' );
	}

	/**
	 * Gets the pass ID.
	 *
	 * @since 3.2.8
	 * @return int
	 */
	protected function get_pass_id() {
		if ( is_null( $this->pass_id ) ) {
			$pass_manager  = new \EDD\Admin\Pass_Manager();
			$this->pass_id = $pass_manager->highest_pass_id;
		}

		return $this->pass_id;
	}

	/**
	 * Checks if the current page is an admin page.
	 *
	 * @since 3.3.3
	 * @param string $page The page to check.
	 * @param string $view The view to check.
	 * @return bool
	 */
	protected function is_admin_page( $page = 'settings', $view = '' ) {
		return edd_is_admin_page( $page, $view );
	}

	/**
	 * Gets the current tab.
	 *
	 * @since 3.3.3
	 * @return string
	 */
	protected function get_tab() {
		return filter_input( INPUT_GET, 'tab', FILTER_SANITIZE_SPECIAL_CHARS );
	}

	/**
	 * Gets the current section.
	 *
	 * @since 3.3.3
	 * @return string
	 */
	protected function get_section() {
		return filter_input( INPUT_GET, 'section', FILTER_SANITIZE_SPECIAL_CHARS );
	}

}
