File Editor

Directories:

Files:

Create New File

Edit File: Payments_Tab.php

<?php

namespace TEC\Tickets\Commerce;

use TEC\Tickets\Commerce\Shortcodes\Checkout_Shortcode;
use TEC\Tickets\Commerce\Shortcodes\Success_Shortcode;
use TEC\Tickets\Commerce\Gateways\Manager;
use TEC\Tickets\Commerce\Gateways\Contracts\Abstract_Gateway as Gateway;
use TEC\Tickets\Settings as Tickets_Commerce_Settings;
use Tribe\Tickets\Admin\Settings as Plugin_Settings;
use \TEC\Common\Contracts\Service_Provider;
use \Tribe__Template;
use Tribe__Tickets__Main;

/**
 * Class Payments_Tab
 *
 * @since   5.2.0
 *
 * @package TEC\Tickets\Commerce
 */
class Payments_Tab extends Service_Provider {

/**
	 * Slug for the tab.
	 *
	 * @since 5.2.1
	 *
	 * @var string
	 */
	public static $slug = 'payments';

/**
	 * Meta key for page creation flag.
	 *
	 * @since 5.2.1
	 *
	 * @var string
	 */
	public static $option_page_created_meta_key = 'tec_tc_payments_page_created';

/**
	 * Meta key for page creation flag.
	 *
	 * @since 5.3.0
	 *
	 * @var string
	 */
	public static $option_gateway_enabled_prefix = 'tec_tc_payments_gateway_enabled_';

/**
	 * Key to determine current section.
	 *
	 * @since 5.3.0
	 *
	 * @var string
	 */
	public static $key_current_section = 'tec_tc_payments_current_section';

/**
	 * Key to use in GET variable for currently selected section.
	 *
	 * @since 5.3.0
	 *
	 * @var string
	 */
	public static $key_current_section_get_var = 'tc-section';

/**
	 * Key to use for section menu.
	 *
	 * @since 5.3.0
	 *
	 * @var string
	 */
	public static $key_section_menu = 'tec_tc_section_menu';

/**
	 * Stores the instance of the template engine that we will use for rendering different elements.
	 *
	 * @since 5.3.0
	 *
	 * @var Tribe__Template
	 */
	protected $template;

/**
	 * @inheritdoc
	 */
	public function register() {
		$this->container->singleton( static::class, $this );
	}

/**
	 * Create the Tickets Commerce Payments Settings Tab.
	 *
	 * @since 5.2.0
	 */
	public function register_tab( $admin_page ) {
		if ( ! empty( $admin_page ) && Plugin_Settings::$settings_page_id !== $admin_page ) {
			return;
		}

$tab_settings = [
			'priority'  => 25,
			'fields'    => $this->get_fields(),
			'show_save' => true,
		];

$tab_settings = apply_filters( 'tec_tickets_commerce_payments_tab_settings', $tab_settings );

new \Tribe__Settings_Tab( static::$slug, esc_html__( 'Payments', 'event-tickets' ), $tab_settings );
	}

/**
	 * Add the payments tab to the list of tab ids for the Tickets settings.
	 *
	 * @since 5.4.0
	 *
	 * @param array $tabs Array containing the tabs ids for Event Tickets settings.
	 *
	 * @return array $tabs Array containing the tabs ids for Event Tickets settings.
	 */
	public function settings_add_tab_id( $tabs ) {
		$tabs[] = static::$slug;

return $tabs;
	}

/**
	 * Gets the template instance used to setup the rendering html.
	 *
	 * @since 5.3.0
	 *
	 * @return Tribe__Template
	 */
	public function get_template() {
		if ( empty( $this->template ) ) {
			$this->template = new Tribe__Template();
			$this->template->set_template_origin( Tribe__Tickets__Main::instance() );
			$this->template->set_template_folder( 'src/admin-views/settings' );
			$this->template->set_template_context_extract( true );
		}

return $this->template;
	}

/**
	 * Gets the URL for the Payment Tab.
	 *
	 * @since 5.3.0
	 *
	 * @param array $args Which query args we are adding.
	 *
	 * @return string
	 */
	public function get_url( array $args = [] ): string {
		// Force the payment tab.
		$args['tab'] = static::$slug;

// Use the settings page get_url to build the URL.
		return tribe( Plugin_Settings::class )->get_url( $args );
	}

/**
	 * Returns the settings item for the section menu at the top of the Payments settings tab.
	 *
	 * @since  5.3.0
	 *
	 * @return array[]
	 */
	public function get_section_menu(): array {
		$template_vars = [
			'sections'         => $this->get_sections(),
			'selected_section' => tribe_get_request_var( static::$key_current_section_get_var, '' ),
		];

return [
			static::$key_section_menu => [
				'type' => 'html',
				'html' => $this->get_template()->template( 'section/menu', $template_vars, false ),
			],
		];
	}

/**
	 * Gets an array of all the sections, based on the active Gateways.
	 *
	 * @since 5.3.0
	 *
	 * @return array[]
	 */
	public function get_sections(): array {
		$sections = [
			[
				'slug'    => '',
				'classes' => [],
				'url'     => $this->get_url(),
				'text'    => __( 'Tickets Commerce', 'event-tickets' ),
			],
		];

$gateways = tribe( Manager::class )->get_gateways();
		$gateways = array_filter( $gateways, static function ( $gateway ) {
			return $gateway::should_show();
		} );

foreach ( $gateways as $gateway_key => $gateway ) {
			$sections[] = [
				'classes' => [],
				'slug'    => $gateway_key,
				'url'     => $gateway::get_settings_url(),
				'text'    => $gateway::get_label(),
			];
		}

/**
		 * Filters the sections available on the Payment Tab.
		 *
		 * @since 5.3.0
		 *
		 * @param array[] $sections Current sections.
		 */
		return (array) apply_filters( 'tec_tickets_commerce_payments_tab_sections', $sections );
	}

/**
	 * Filters the redirect URL to include section, if applicable.
	 *
	 * @since 5.3.0
	 *
	 * @param string $url URL of redirection.
	 *
	 * @return string
	 */
	public function filter_redirect_url( $url ) {
		if ( ! is_admin() ) {
			return $url;
		}

$tab  = tribe_get_request_var( 'tab' );
		$page = tribe_get_request_var( 'page' );

if ( empty( $tab ) || empty( $page ) ) {
			return $url;
		}

if ( empty( $_SERVER['REQUEST_METHOD'] ) || 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
			return $url;
		}

if ( \Tribe\Tickets\Admin\Settings::$settings_page_id !== $page ) {
			return $url;
		}

if ( static::$slug !== $tab ) {
			return $url;
		}

$section = tribe_get_request_var( static::$key_current_section );
		if ( empty( $section ) ) {
			$section = tribe_get_request_var( static::$key_current_section_get_var );
		}

// In the main section we don't need to do anything.
		if ( empty( $section ) || 'main' === $section ) {
			return $url;
		}

return add_query_arg( static::$key_current_section_get_var, esc_attr( $section ), $url );
	}

/**
	 * Returns the settings item for the section menu at the top of the Payments settings tab.
	 *
	 * @since 5.3.0
	 *
	 * @return Gateway|null
	 */
	public function get_section_gateway() {
		$selected_section = tribe_get_request_var( static::$key_current_section_get_var );

return tribe( Manager::class )->get_gateway_by_key( $selected_section );
	}

/**
	 * Gets the fields for the Tickets Commerce top level fields.
	 *
	 * @since 5.3.0
	 *
	 * @return array[]
	 */
	public function get_tickets_commerce_section_fields() {
		$fields = [];

// If no gateway section is selected, show main settings.
		$plus_link = sprintf(
			'<a href="https://evnt.is/19zl" target="_blank" rel="noopener noreferrer">%s</a>',
			esc_html__( 'Event Tickets Plus', 'event-tickets' )
		);

$plus_message = sprintf(
		// Translators: %1$s: The Event Tickets Plus link.
			esc_html_x( 'Tickets Commerce provides a simple and flexible ecommerce checkout for purchasing tickets. Just choose your payment gateway and configure checkout options and you\'re all set.  If you need more advanced features like custom attendee information, QR code check in, and stock sharing between tickets, take a look at %1$s for these features and more.', 'about Tickets Commerce', 'event-tickets' ),
			$plus_link
		);

$is_tickets_commerce_enabled = tec_tickets_commerce_is_enabled();

$fields['tickets-commerce-header'] = [
			'type' => 'html',
			'html' => '<div class="tec-tickets__admin-settings-toggle-large-wrapper">
							<label class="tec-tickets__admin-settings-toggle-large">
								<input
									type="checkbox"
									name="' . Tickets_Commerce_Settings::$tickets_commerce_enabled . '"
									' . checked( $is_tickets_commerce_enabled, true, false ) . '
									id="tickets-commerce-enable-input"
									class="tec-tickets__admin-settings-toggle-large-checkbox tribe-dependency tribe-dependency-verified">
									<span class="tec-tickets__admin-settings-toggle-large-switch"></span>
									<span class="tec-tickets__admin-settings-toggle-large-label">' . esc_html__( 'Enable Tickets Commerce', 'event-tickets' ) . '</span>
							</label>
						</div>',

];

$fields['tickets-commerce-description'] = [
			'type' => 'html',
			'html' => '<div class="tec-tickets__admin-settings-tickets-commerce-description">' . $plus_message . '</div>',
		];

$fields[ Tickets_Commerce_Settings::$tickets_commerce_enabled ] = [
			'type'            => 'hidden',
			'validation_type' => 'boolean',
		];

return $fields;
	}

/**
	 * Get selected section top level menu.
	 *
	 * @since 5.3.0
	 *
	 * @param Gateway $section_gateway Gateway class.
	 *
	 * @return array[]
	 */
	public function get_gateway_section_fields( $section_gateway ): array {
		$fields = [];

// Show the switch to enable/disable gateway at the top.
		$option_key   = $section_gateway::get_enabled_option_key();
		$enable_label = sprintf(
		// Translators: %s: Name of payment gateway.
			esc_html__( 'Enable %s', 'event-tickets' ),
			$section_gateway::get_label()
		);

$attributes = tribe_get_attributes( [
			'type'     => 'checkbox',
			'name'     => $option_key,
			'id'       => 'tickets-commerce-enable-input',
			'class'    => 'tec-tickets__admin-settings-toggle-large-checkbox tribe-dependency tribe-dependency-verified',
			'disabled' => ! $section_gateway::is_connected(),
			'checked'  => $section_gateway::is_enabled(),
		] );

/**
		 * @todo this needs to move into a template
		 */
		$fields['tickets-commerce-header'] = [
			'type' => 'html',
			'html' => '<div class="tec-tickets__admin-settings-toggle-large-wrapper">
							<label class="tec-tickets__admin-settings-toggle-large">
								<input ' . implode( ' ', $attributes ) . ' />
								<span class="tec-tickets__admin-settings-toggle-large-switch"></span>
								<span class="tec-tickets__admin-settings-toggle-large-label">' . $enable_label . '</span>
							</label>
						</div>',

];

$fields[ $option_key ] = [
			'type'            => 'hidden',
			'validation_type' => 'boolean',
		];

return $fields;
	}

/**
	 * Gets the top level settings for Tickets Commerce.
	 *
	 * @since 5.3.0
	 *
	 * @return array[]
	 */
	public function get_fields(): array {
		$section_gateway = $this->get_section_gateway();

$fields = [
			'tribe-form-content-start' => [
				'type' => 'html',
				'html' => '<div class="tribe-settings-form-wrap">',
			],
		];

if ( empty( $section_gateway ) ) {
			$fields = array_merge( $fields, $this->get_tickets_commerce_section_fields() );
		} else {
			$fields = array_merge( $fields, $this->get_gateway_section_fields( $section_gateway ) );
		}

/**
		 * Hook to modify the top level settings for Tickets Commerce.
		 *
		 * @since 5.2.0
		 *
		 * @param array[] $top_level_settings Top level settings.
		 */
		return apply_filters( 'tec_tickets_commerce_settings_top_level', array_merge( $this->get_section_menu(), $fields ) );
	}

/**
	 * Maybe Generate Checkout and Success page if not found.
	 *
	 * @since 5.2.1
	 */
	public function maybe_generate_pages() {

$tc_enabled = tribe_get_request_var( Tickets_Commerce_Settings::$tickets_commerce_enabled );

if ( ! tribe_is_truthy( $tc_enabled ) ) {
			return;
		}

$this->maybe_auto_generate_checkout_page();
		$this->maybe_auto_generate_order_success_page();
	}

/**
	 * Generate Checkout page with the shortcode if the page is non-existent.
	 *
	 * @since 5.2.1
	 *
	 * @return bool
	 */
	public function maybe_auto_generate_checkout_page() {
		if ( tribe( Checkout::class )->page_has_shortcode() ) {
			return false;
		}

$page_slug = 'tickets-checkout';
		$shortcode = Checkout_Shortcode::get_wp_slug();

if ( $this->is_page_created( $shortcode ) ) {
			return false;
		}

$page_name = __( 'Tickets Checkout', 'event-tickets' );
		$page_id   = $this->create_page_with_shortcode( $page_slug, $page_name, $shortcode );

if ( is_wp_error( $page_id ) ) {
			return false;
		}

return tribe_update_option( Settings::$option_checkout_page, $page_id );
	}

/**
	 * Generate Order Success page with the shortcode if the page is non-existent.
	 *
	 * @since 5.2.1
	 *
	 * @return bool
	 */
	public function maybe_auto_generate_order_success_page() {
		if ( tribe( Success::class )->page_has_shortcode() ) {
			return false;
		}

$page_slug = 'tickets-order';
		$shortcode = Success_Shortcode::get_wp_slug();

if ( $this->is_page_created( $shortcode ) ) {
			return false;
		}

$page_name = __( 'Order Completed', 'event-tickets' );
		$page_id   = $this->create_page_with_shortcode( $page_slug, $page_name, $shortcode );

if ( is_wp_error( $page_id ) ) {
			return false;
		}

return tribe_update_option( Settings::$option_success_page, $page_id );
	}

/**
	 * Create a page with given properties.
	 *
	 * @since 5.2.1
	 *
	 * @param string $page_slug      URL slug of the page.
	 * @param string $page_name      Name for page title.
	 * @param string $shortcode_name Shortcode name that needs to be inserted in page content.
	 *
	 * @return int|bool|\WP_Error
	 */
	public function create_page_with_shortcode( $page_slug, $page_name, $shortcode_name ) {

if ( ! current_user_can( 'edit_pages' ) ) {
			return false;
		};

$page_data = [
			'post_status'    => 'publish',
			'post_type'      => 'page',
			'post_author'    => get_current_user_id(),
			'post_name'      => $page_slug,
			'post_title'     => $page_name,
			'post_content'   => '[' . $shortcode_name . ']',
			'post_parent'    => 0,
			'comment_status' => 'closed',
			'meta_input'     => [
				static::$option_page_created_meta_key => $shortcode_name,
			],
		];

return wp_insert_post( $page_data );
	}

/**
	 * Check if the provided page was created.
	 *
	 * @since 5.2.1
	 *
	 * @param string $shortcode_name Shortcode name that was inserted in page content.
	 *
	 * @return bool
	 */
	public function is_page_created( $shortcode_name ) {

$args = [
			'post_type'  => 'page',
			'meta_key'   => static::$option_page_created_meta_key,
			'meta_value' => $shortcode_name,
		];

$query = new \WP_Query( $args );

return (bool) $query->post_count;
	}
}

Rename File

[et_pb_section fb_built=”1″ theme_builder_area=”post_content” _builder_version=”4.17.4″ _module_preset=”default” custom_padding=”25px||20px|||”][et_pb_row _builder_version=”4.17.4″ _module_preset=”default” theme_builder_area=”post_content”][et_pb_column _builder_version=”4.17.4″ _module_preset=”default” theme_builder_area=”post_content” type=”4_4″][et_pb_image src=”https:\/\/retirementmaxradio.com\/wp-content\/uploads\/2022\/07\/Screen-Shot-2022-07-12-at-10.39.22-AM.png” _builder_version=”4.17.4″ _module_preset=”default” theme_builder_area=”post_content” hover_enabled=”0″ sticky_enabled=”0″][\/et_pb_image][\/et_pb_column][\/et_pb_row][\/et_pb_section][et_pb_section fb_built=”1″ _builder_version=”4.17.4″ _module_preset=”default” global_colors_info=”{}”][et_pb_row _builder_version=”4.17.4″ _module_preset=”default” global_colors_info=”{}”][et_pb_column type=”4_4″ _builder_version=”4.17.4″ _module_preset=”default” global_colors_info=”{}”][et_pb_code _builder_version=”4.17.4″ _module_preset=”default” hover_enabled=”0″ global_colors_info=”{}” sticky_enabled=”0″] <\/p>\n