Uplink_Controller

Controller for setting up the stellarwp/uplink library.


Source

File: src/Common/Libraries/Uplink_Controller.php

class Uplink_Controller extends Controller_Contract {
	/**
	 * Register the controller.
	 *
	 * @since 6.3.0
	 */
	public function do_register(): void {
		$this->add_actions();
	}

	/**
	 * Unregister the controller.
	 *
	 * @since 6.3.0
	 *
	 * @return void
	 */
	public function unregister(): void {
		$this->remove_actions();
	}

	/**
	 * Add the action hooks.
	 *
	 * @since 6.3.0
	 */
	public function add_actions(): void {
		add_action( 'init', [ $this, 'register_uplink' ], 8 );
		add_filter( 'tribe_license_fields', [ $this, 'register_license_fields' ], 20 );
		add_action( 'tribe_settings_save', [ $this, 'save_empty_license_keys' ] );
	}

	/**
	 * Remove the action hooks.
	 *
	 * @since 6.3.0
	 */
	public function remove_actions(): void {
		remove_action( 'init', [ $this, 'register_uplink' ], 8 );
		remove_filter( 'tribe_license_fields', [ $this, 'register_license_fields' ], 20 );
	}

	/**
	 * Register the license fields.
	 *
	 * @since 6.3.0
	 *
	 * @param array $fields_array The array of fields.
	 *
	 * @return array
	 */
	public function register_license_fields( $fields_array ) {
		$plugins = get_plugins();

		$fields_to_inject = [];

		foreach ( $plugins as $plugin ) {
			$legacy_slug = str_replace( '-', '_', $plugin->get_slug() );

			$field = get_field( $plugin->get_slug() );
			$field->set_field_name( 'pue_install_key_' . $legacy_slug )->show_label( false );

			$prefix = tribe( Libraries_Provider::class )->get_hook_prefix();

			// If there is a license registered prior Uplink but not with Uplink. Return license registered prior Uplink.
			add_filter(
				'stellarwp/uplink/' . $prefix . '/' . $plugin->get_slug() . '/license_get_key',
				function ( $license, Resource $plugin ) {
					if ( $license ) {
						return $license;
					}

					return get_option( 'pue_install_key_' . str_replace( '-', '_', $plugin->get_slug() ), '' );
				},
				10,
				2
			);

			$field_html = $field->get_render_html();

			// Remove duplicate entries of plugins migrated to uplink.
			if ( isset( $fields_array[ 'pue_install_key_' . $legacy_slug . '-heading' ] ) ) {
				unset( $fields_array[ 'pue_install_key_' . $legacy_slug . '-heading' ] );
			}

			// Remove duplicate entries of plugins migrated to uplink.
			if ( isset( $fields_array[ 'pue_install_key_' . $legacy_slug ] ) ) {
				unset( $fields_array[ 'pue_install_key_' . $legacy_slug ] );
			}

			$fields_to_inject[ 'stellarwp-uplink_' . $plugin->get_slug() . '-heading' ] = [
				'type'  => 'heading',
				'label' => $plugin->get_name(),
			];

			$fields_to_inject[ 'stellarwp-uplink_' . $plugin->get_slug() ] = [
				'type'  => 'html',
				'label' => '',
				'html'  => $field_html,
			];
		}

		$fields_array = Arr::insert_after_key( 'tribe-form-content-start', $fields_array, $fields_to_inject );

		return $fields_array;
	}

	/**
	 * Save empty license keys.
	 *
	 * @since 6.3.0
	 */
	public function save_empty_license_keys() {
		$plugins = get_plugins();

		foreach ( $plugins as $plugin ) {
			$legacy_slug = str_replace( '-', '_', $plugin->get_slug() );

			if ( ! isset( $_POST[ 'pue_install_key_' . $legacy_slug ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
				continue;
			}

			$license_key = sanitize_text_field( $_POST[ 'pue_install_key_' . $legacy_slug ] ); // phpcs:ignore WordPress.Security.NonceVerification.Missing

			// If the license key has a value, it will be validated and stored by uplink.
			// We only want to give our users the option to remove a license key if they want to.
			if ( $license_key ) {
				continue;
			}

			$plugin->set_license_key( '' );
		}
	}

	/**
	 * Register the uplink library.
	 *
	 * @since 6.3.0
	 *
	 * @return void
	 */
	public function register_uplink(): void {
		$prefix = tribe( Libraries_Provider::class )->get_hook_prefix();

		Config::set_container( tribe() );
		Config::set_hook_prefix( $prefix );
		Config::set_token_auth_prefix( $prefix );
		Uplink::init();
	}
}

Top ↑

Changelog

Changelog
Version Description
6.3.0 Introduced.

Top ↑

Methods