File Manager

Editing File: /home/eticmes/www/wp-content/plugins/the-events-calendar/common/src/Common/Admin/Help_Hub/Hub.php

<?php
/**
 * Hub class for managing the Help Hub functionality.
 *
 * This class handles rendering the Help Hub page, loading necessary assets,
 * and generating iframes and admin notices related to the Help Hub.
 *
 * @since 6.3.2
 * @package TEC\Common\Admin\Help_Hub
 */

namespace TEC\Common\Admin\Help_Hub;

use TEC\Common\Admin\Help_Hub\Resource_Data\Help_Hub_Data_Interface;
use RuntimeException;
use TEC\Common\Admin\Help_Hub\Section_Builder\Section_Helper;
use TEC\Common\StellarWP\AdminNotices\AdminNotice;
use TEC\Common\StellarWP\AdminNotices\AdminNotices;
use Tribe__Main;
use Tribe__Template;
use TEC\Common\Configuration\Configuration;

/**
 * Class Hub
 *
 * Manages the Help Hub functionality, including rendering templates,
 * loading assets, and managing iframe content and notices.
 *
 * @package TEC\Common\Admin\Help_Hub
 */
class Hub {

/**
	 * The Help Hub page slug.
	 *
	 * @since 6.3.2
	 *
	 * @var string
	 */
	const IFRAME_PAGE_SLUG = 'tec-help-hub';

/**
	 * Data object implementing Help_Hub_Data_Interface, providing necessary Help Hub resources.
	 *
	 * @since 6.3.2
	 *
	 * @var Help_Hub_Data_Interface
	 */
	protected Help_Hub_Data_Interface $data;

/**
	 * The template class.
	 *
	 * @since 6.3.2
	 *
	 * @var Tribe__Template
	 */
	protected Tribe__Template $template;

/**
	 * The configuration object.
	 *
	 * @since 6.3.2
	 *
	 * @var Configuration
	 */
	protected Configuration $config;

/**
	 * Constructor.
	 *
	 * @since 6.3.2
	 *
	 * @param Help_Hub_Data_Interface $data     The data class instance containing Help Hub resources.
	 * @param Configuration           $config   The Zendesk support key.
	 * @param Tribe__Template         $template The template class.
	 */
	public function __construct( Help_Hub_Data_Interface $data, Configuration $config, Tribe__Template $template ) {
		$this->config   = $config;
		$this->template = $template;
		$this->set_data( $data );

$this->setup_support_keys();
		$this->register_hooks();
	}

/**
	 * Sets or replaces the Help Hub data object.
	 *
	 * This method assigns the provided data instance to the Hub. It may be called multiple times,
	 * such as during construction or later via a hook (e.g., `tec_help_hub_before_iframe_render`)
	 * to override an initial default.
	 *
	 * This method will overwrite any previously set data instance.
	 *
	 * @since 6.8.0
	 *
	 * @param Help_Hub_Data_Interface $data The Help Hub data instance to use.
	 *
	 * @return void
	 */
	public function set_data( Help_Hub_Data_Interface $data ) {
		$this->data = $data;
	}

/**
	 * Sets up support keys for embedding the chat widgets.
	 *
	 * @since 6.3.2
	 *
	 * @link  https://docsbot.ai/documentation/developer/embeddable-chat-widget Docsbot Embeddable Chat Widget Documentation
	 * @link  https://support.zendesk.com/hc/en-us/articles/4408836216218-Using-Web-Widget-Classic-to-embed-customer-service-in-your-website Zendesk Classic Chat Widget Documentation
	 */
	protected function setup_support_keys() {
		if ( ! defined( 'TEC_HELP_HUB_CHAT_DOCSBOT_SUPPORT_KEY' ) ) {
			/**
			 * Docsbot key for embedding the bot iframe.
			 */
			define( 'TEC_HELP_HUB_CHAT_DOCSBOT_SUPPORT_KEY', 'yes2mjAljn0V5ndsWaOi/VhpexdT7TZTckW7FLyN7' );
		}

if ( ! defined( 'TEC_HELP_HUB_CHAT_ZENDESK_CHAT_KEY' ) ) {
			/**
			 * Zendesk key for embedding the classic chat widget.
			 */
			define( 'TEC_HELP_HUB_CHAT_ZENDESK_CHAT_KEY', 'd8e5e319-c54b-4da9-9d7d-e984cc3c4900' );
		}

if ( ! defined( 'TEC_HELP_HUB_CHAT_HELPSCOUT_BEACON_CHAT_KEY' ) ) {
			/**
			 * Help Scout Beacon key for embedding the beacon widget.
			 */
			define( 'TEC_HELP_HUB_CHAT_HELPSCOUT_BEACON_CHAT_KEY', '9bb4e819-f901-45b4-9616-abe17a460fc2' );
		}
	}

/**
	 * Retrieves the data object used by the Help Hub.
	 *
	 * @since 6.3.2
	 *
	 * @return Help_Hub_Data_Interface The data object containing Help Hub resources.
	 */
	public function get_data(): Help_Hub_Data_Interface {
		if ( empty( $this->data ) ) {
			$this->data->initialize();
			return $this->data;
		}

$this->ensure_data_is_set();
		return $this->data;
	}

/**
	 * Registers the hooks and filters needed for Help Hub functionality.
	 *
	 * Sets up actions and filters for initializing iframe content,
	 * loading assets, and adding custom body classes for Help Hub pages.
	 *
	 * @since 6.3.2
	 *
	 * @return void
	 */
	public function register_hooks(): void {
		add_action( 'admin_init', [ $this, 'generate_iframe_content' ] );
		add_action( 'admin_enqueue_scripts', [ $this, 'load_assets' ], 1 );
		add_filter( 'admin_body_class', [ $this, 'add_help_page_body_class' ] );
		add_action( 'admin_menu', [ $this, 'register_hidden_page' ], 999 );
	}

/**
	 * Registers the hidden admin page for the Help Hub.
	 *
	 * @since 6.8.0
	 *
	 * @return void
	 */
	public function register_hidden_page(): void {
		add_submenu_page(
			'', // Make the page hidden.
			__( 'Help Hub', 'tribe-common' ),
			__( 'Help Hub', 'tribe-common' ),
			'manage_options',
			self::IFRAME_PAGE_SLUG,
			[ $this, 'render' ]
		);
	}

/**
	 * Ensures that the Help Hub data object is set.
	 *
	 * This should be called before rendering or accessing data-dependent methods.
	 * It expects that the data has been injected either via constructor or through a hook.
	 *
	 * @since 6.3.2
	 * @since 6.8.0 Refactored.
	 *
	 * @throws RuntimeException If the data has not been set by the time this method runs.
	 *
	 * @return void
	 */
	protected function ensure_data_is_set(): void {
		if ( isset( $this->data ) && $this->data instanceof Help_Hub_Data_Interface ) {
			$this->data->initialize();
			return;
		}

$page = tribe_get_request_var( 'page' );
		throw new RuntimeException(
			sprintf(
				'Help Hub data was not set for page [%s]. Ensure your resource data class calls $hub->set_data() before render.',
				esc_html( $page )
			)
		);
	}

/**
	 * Renders the Help Hub page.
	 *
	 * Generates necessary notices, retrieves data, and renders the appropriate Help Hub template.
	 *
	 * @since 6.3.2
	 *
	 * @throws RuntimeException If data is not set using the setup method before rendering.
	 * @return void
	 */
	public function render(): void {
		$this->ensure_data_is_set();

/**
		 * Fires before the Help Hub page is rendered.
		 *
		 * Use this hook to modify data or enqueue additional assets before the Help Hub template is generated.
		 *
		 * @since 6.3.2
		 * @since 6.9.5 Add new filter `tec_help_hub_register_tabs`.
		 *
		 * @param Hub $instance The Hub instance.
		 */
		do_action( 'tec_help_hub_before_render', $this );

$status           = $this->get_license_and_opt_in_status();
		$template_variant = self::get_template_variant( $status['has_valid_license'], $status['is_opted_in'] );
		$active_tab       = tec_get_request_var( 'tab', 'tec-help-tab' );

// Build the tabs.
		$builder = tribe( Tab_Builder::class );

$builder::make(
			'tec-help-tab',
			__( 'Support Hub', 'tribe-common' ),
			'tec-help-tab',
			'help-hub/support/support-hub'
		)
			->set_class( 'tec-nav__tab--active' )
			->build();

$builder::make(
			'tec-resources-tab',
			__( 'Resources', 'tribe-common' ),
			'tec-resources-tab',
			'help-hub/resources/resources',
			[ 'sections' => $this->handle_resource_sections() ]
		)
			->build();

/**
		 * Allow other code to register custom Help Hub tabs before rendering.
		 *
		 * Use this filter to call `$builder::make()->build()` and add new tabs.
		 *
		 * @since 6.9.5
		 *
		 * @param Tab_Builder $builder The tab builder instance.
		 */
		$builder = apply_filters( 'tec_help_hub_register_tabs', $builder );

// Now apply the active class *after* all tabs are registered.
		$tabs = $builder::get_all_tabs();
		foreach ( $tabs as &$tab ) {
			$tab['class'] = ( $tab['id'] === $active_tab ) ? 'tec-nav__tab--active' : '';
		}

$template_args = wp_parse_args(
			$builder->get_arguments(),
			[
				'template_variant' => $template_variant,
				'tabs'             => $tabs,
			]
		);

$this->render_template(
			'help-hub',
			(array) $template_args
		);

/**
		 * Fires after the Help Hub page is rendered.
		 *
		 * Use this hook to perform actions or cleanup tasks after the Help Hub template is generated and displayed.
		 *
		 * @since 6.3.2
		 *
		 * @param Hub $instance The Hub instance.
		 */
		do_action( 'tec_help_hub_after_render', $this );
	}

/**
	 * Handles and filters the resource sections for the Help Hub.
	 *
	 * This method centralizes the creation and filtering of resource sections,
	 * allowing for a single point of modification based on the data class.
	 *
	 * @since 6.3.2
	 *
	 * @return array The filtered resource sections.
	 */
	public function handle_resource_sections(): array {
		$sections = $this->data->create_resource_sections();

return Section_Helper::from_array( $sections, $this->data )
			->to_array();
	}

/**
	 * Determines the template variant based on license validity and opt-in status.
	 *
	 * @since 6.3.2
	 *
	 * @param bool $has_valid_license Whether the license is valid.
	 * @param bool $is_opted_in       Whether the user has opted into telemetry.
	 *
	 * @return string The template variant.
	 */
	protected static function get_template_variant( bool $has_valid_license, bool $is_opted_in ): string {
		if ( ! $has_valid_license ) {
			return 'no-license';
		}

return $is_opted_in ? 'has-license-has-consent' : 'has-license-no-consent';
	}

/**
	 * Checks if the current page is a Help Hub page.
	 *
	 * @since 6.3.2
	 *
	 * @return bool
	 */
	public static function is_current_page(): bool {
		global $current_screen;

$help_pages = [
			'tribe_events_page_tec-events-help',
			'tribe_events_page_tec-events-help-hub',
		];

/**
		 * Filter the list of help pages.
		 *
		 * Allows extending the list of pages that are considered Help Hub pages.
		 * Mainly used to enqueue assets on the Help Hub page.
		 *
		 * @since 6.8.0
		 *
		 * @param array $help_pages Array of page IDs that are considered Help Hub pages.
		 */
		$help_pages = (array) apply_filters( 'tec_help_hub_pages', $help_pages );

return in_array( $current_screen->id, $help_pages, true );
	}

/**
	 * Adds custom body classes to the Help Hub page.
	 *
	 * This method adds default classes to the Help Hub page, with an option
	 * to customize or add additional classes via the `tec_help_hub_body_classes` filter.
	 *
	 * @since 6.3.2
	 * @since 6.8.0 removed type hinting.
	 *
	 * @param string $classes Space-separated string of classes for the body tag.
	 *
	 * @return string Filtered list of classes.
	 */
	public function add_help_page_body_class( $classes ) {
		if ( ! self::is_current_page() ) {
			return $classes;
		}

$classes = (string) $classes;

// Default classes for Help Hub.
		$default_classes = [ 'tribe-help', 'tec-help' ];

/**
		 * Filters the list of body classes for the Help Hub page.
		 *
		 * This filter allows customization of the body classes applied to the Help Hub page,
		 * enabling the addition or removal of classes as needed.
		 *
		 * @since 6.3.2
		 *
		 * @param array $class_array The default array of body classes.
		 */
		$class_array = (array) apply_filters( 'tec_help_hub_body_classes', array_merge( $default_classes ) );

// Merge filtered classes with the existing $classes argument.
		$class_array = array_merge( explode( ' ', $classes ), $class_array );

return implode( ' ', array_unique( $class_array ) );
	}

/**
	 * Enqueues assets for the Help Hub page.
	 *
	 * @since 6.3.2
	 *
	 * @return void
	 */
	public function load_assets() {
		if ( ! self::is_current_page() ) {
			return;
		}

tec_asset(
			Tribe__Main::instance(),
			'tec-common-help-hub-style',
			'help-hub.css',
			[],
			'admin_enqueue_scripts'
		);

tec_asset(
			Tribe__Main::instance(),
			'tribe-admin-help-page',
			'admin/help-page.js',
			[ 'tribe-clipboard', 'tribe-common' ],
			'admin_enqueue_scripts',
			[
				'conditionals' => [ self::class, 'is_current_page' ],
				'localize'     => [
					'name' => 'tribe_system_info',
					'data' => [
						'sysinfo_optin_nonce'        => wp_create_nonce( 'sysinfo_optin_nonce' ),
						'clipboard_btn_text'         => _x( 'Copy to clipboard', 'Copy to clipboard button text.', 'tribe-common' ),
						'clipboard_copied_text'      => _x( 'System info copied', 'Copy to clipboard success message', 'tribe-common' ),
						'clipboard_fail_text'        => _x( 'Press "Cmd + C" to copy', 'Copy to clipboard instructions', 'tribe-common' ),
						'sysinfo_error_message_text' => _x( 'Something has gone wrong!', 'Default error message for system info optin', 'tribe-common' ),
						'sysinfo_error_code_text'    => _x( 'Code:', 'Error code label for system info optin', 'tribe-common' ),
						'sysinfo_error_status_text'  => _x( 'Status:', 'Error status label for system info optin', 'tribe-common' ),
					],
				],
			]
		);

wp_enqueue_script( 'jquery-ui-accordion' );
	}

/**
	 * Generates a telemetry opt-in link.
	 *
	 * @since 6.3.2
	 * @since 6.8.0 Added filter.
	 *
	 * @return string
	 */
	public static function get_telemetry_opt_in_link(): string {
		$default_url = add_query_arg(
			[
				'page'      => 'tec-events-settings',
				'tab'       => 'general-debugging-tab',
				'post_type' => 'tribe_events',
			],
			admin_url( 'edit.php' )
		);

/**
		 * Filters the telemetry opt-in link.
		 *
		 * Allows customization of the link used for the telemetry opt-in location.
		 *
		 * @since 6.8.0
		 *
		 * @param string $default_url The default URL to the telemetry opt-in settings tab.
		 */
		return apply_filters( 'tec_help_hub_telemetry_opt_in_link', $default_url );
	}

/**
	 * Generates and outputs iframe content when appropriate.
	 *
	 * @since 6.3.2
	 * @since 6.8.0 Moved `tec_help_hub_before_iframe_render` to trigger sooner.
	 *
	 * @throws RuntimeException If data has not been set using setup.
	 * @return void
	 */
	public function generate_iframe_content(): void {

$page          = tribe_get_request_var( 'page' );
		$iframe        = (bool) tribe_get_request_var( 'embedded_content' );
		$help_hub_page = tribe_get_request_var( 'help_hub' );

if (
			empty( $page )
			|| self::IFRAME_PAGE_SLUG !== $help_hub_page
			|| ! $iframe
		) {
			return;
		}

/**
		 * Fires before the Help Hub iframe content is rendered.
		 *
		 * Use this hook to enqueue additional assets, modify iframe-specific content,
		 * or take other actions just before the iframe content is generated.
		 *
		 * @since 6.3.2
		 *
		 * @param Hub $instance The Hub instance.
		 */
		do_action( 'tec_help_hub_before_iframe_render', $this );

$this->ensure_data_is_set();

if ( ! defined( 'IFRAME_REQUEST' ) ) {
			define( 'IFRAME_REQUEST', true );
		}

// phpcs:ignore WordPressVIPMinimum.UserExperience.AdminBarRemoval.RemovalDetected
		show_admin_bar( false );

$this->register_iframe_hooks();

$this->render_template( 'help-hub/support/iframe-content' );

/**
		 * Fires after the Help Hub iframe content has been rendered.
		 *
		 * Use this hook to perform actions or cleanup tasks after the iframe content
		 * has been generated and displayed.
		 *
		 * @since 6.3.2
		 *
		 * @param Hub $instance The Hub instance.
		 */
		do_action( 'tec_help_hub_after_iframe_render', $this );

exit;
	}

/**
	 * Registers the hooks and filters needed for Help Hub Iframe functionality.
	 *
	 * Sets up actions and filters for initializing iframe content,
	 * loading assets, and adding custom body classes for Help Hub pages.
	 *
	 * @since 6.3.2
	 *
	 * @return void
	 */
	public function register_iframe_hooks() {
		add_action( 'tec_help_hub_iframe_header', [ $this, 'enqueue_help_page_iframe_assets' ] );
		add_filter( 'emoji_svg_url', '__return_false' );
		remove_action( 'wp_print_styles', 'print_emoji_styles' );
		remove_action( 'wp_head', 'print_emoji_styles' );
	}

/**
	 * Enqueues assets specific to the iframe content and removes theme styles.
	 *
	 * @since 6.3.2
	 * @return void
	 */
	public function enqueue_help_page_iframe_assets(): void {
		if ( ! defined( 'IFRAME_REQUEST' ) ) {
			define( 'IFRAME_REQUEST', true );
		}

tec_asset(
			Tribe__Main::instance(),
			'tec-help-hub-iframe-style',
			'help-hub-iframe.css',
			[],
			[],
		);

tec_asset(
			Tribe__Main::instance(),
			'tec-help-hub-iframe-js',
			'admin/help-hub-iframe.js',
			[],
			[],
			[
				'localize' => [
					'name' => 'helpHubSettings',
					'data' => [
						'docsbot_key'        => $this->config->get( 'TEC_HELP_HUB_CHAT_DOCSBOT_SUPPORT_KEY' ),
						'zendeskChatKey'     => $this->config->get( 'TEC_HELP_HUB_CHAT_ZENDESK_CHAT_KEY' ),
						'helpScoutBeaconKey' => $this->config->get( 'TEC_HELP_HUB_CHAT_HELPSCOUT_BEACON_CHAT_KEY' ),
						// Pass userIdentifiers as an array if you want to prefill the Help Scout form.
						'userIdentifiers'    => null,
						'errorMessages'      => [
							'helpScoutScriptLoadFailed' => __( 'Failed to load Help Scout Beacon script.', 'tribe-common' ),
						],
					],
				],
			]
		);

tribe_asset_enqueue( 'tec-help-hub-iframe-style' );
		tribe_asset_enqueue( 'tec-help-hub-iframe-js' );
		tribe_asset_enqueue( 'tribe-common-full-style' );
	}

/**
	 * Removes theme-related styles to avoid iframe conflicts.
	 *
	 * @since 6.3.2
	 *
	 * @return void
	 */
	public static function dequeue_theme_styles(): void {
		global $wp_styles;
		$theme_directory = get_template_directory_uri();

foreach ( $wp_styles->queue as $handle ) {
			$src = $wp_styles->registered[ $handle ]->src;
			if ( strpos( $src, $theme_directory ) !== false ) {
				wp_dequeue_style( $handle );
			}
		}
	}

/**
	 * Generates HTML for the admin notice.
	 *
	 * @since 6.3.2
	 *
	 * @param string $text The text to display.
	 * @param string $slug Slug for the notice.
	 *
	 * @return string The HTML for the admin notice.
	 */
	public function generate_notice_html( string $text, string $slug ): string {
		$notice_admin = ( new AdminNotice( $slug, "<p>$text</p>" ) )
			->urgency( 'info' )
			->inline()
			->dismissible( true )
			->withWrapper();

return AdminNotices::render( $notice_admin, false );
	}

/**
	 * Wrapper to get the license validity and telemetry opt-in status.
	 *
	 * @since 6.3.2
	 *
	 * @return array Contains 'has_valid_license' and 'is_opted_in' status.
	 */
	public function get_license_and_opt_in_status(): array {
		return $this->data->get_license_and_opt_in_status();
	}

/**
	 * Wrapper to retrieve the URL for a specified icon.
	 *
	 * @since 6.3.2
	 *
	 * @param string $icon_name The name of the icon to retrieve.
	 *
	 * @return string The URL of the specified icon, or an empty string if the icon does not exist.
	 */
	public function get_icon_url( string $icon_name ): string {
		return $this->data->get_icon_url( $icon_name );
	}

/**
	 * Renders the specified template with provided variables.
	 *
	 * @since 6.3.2
	 *
	 * @param string $template_name The template file name (without .php).
	 * @param array  $extra_values  Extra values to pass to the template.
	 *
	 * @return void
	 */
	private function render_template( string $template_name, array $extra_values = [] ): void {
		$main     = Tribe__Main::instance();
		$template = $this->template;

$template_values = wp_parse_args(
			$extra_values,
			[
				'main'     => $main,
				'help_hub' => $this,
			]
		);

$template->set_values( $template_values );
		$template->set_template_origin( $main );
		$template->set_template_folder( 'src/admin-views' );
		$template->set_template_context_extract( true );
		$template->set_template_folder_lookup( false );
		$template->template( $template_name );
	}
}

Back to Directory File Manager