From 3efbf22487006aa241516cc7783d36b81fdd6989 Mon Sep 17 00:00:00 2001 From: Justin Frydman Date: Wed, 29 Nov 2023 10:17:35 -0700 Subject: [PATCH 1/5] Add container entry for uplink assets uri --- src/Uplink/Uplink.php | 3 +++ tests/wpunit/ContainerTest.php | 18 ++++++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/src/Uplink/Uplink.php b/src/Uplink/Uplink.php index a62ee958..ca3f4d91 100644 --- a/src/Uplink/Uplink.php +++ b/src/Uplink/Uplink.php @@ -7,6 +7,8 @@ class Uplink { + public const UPLINK_ASSETS_URI = 'uplink.assets.uri'; + /** * Initializes the service provider. * @@ -23,6 +25,7 @@ public static function init() { $container = Config::get_container(); + $container->singleton( self::UPLINK_ASSETS_URI, dirname( plugin_dir_url( __FILE__ ) ) . '/assets' ); $container->bind( ContainerInterface::class, $container ); $container->singleton( View\Provider::class, View\Provider::class ); $container->singleton( API\Client::class, API\Client::class ); diff --git a/tests/wpunit/ContainerTest.php b/tests/wpunit/ContainerTest.php index 9fd333cf..271213b3 100644 --- a/tests/wpunit/ContainerTest.php +++ b/tests/wpunit/ContainerTest.php @@ -1,20 +1,30 @@ -assertInstanceOf( ContainerInterface::class, $container ); } + + public function test_it_gets_the_uplink_assets_uri(): void { + $uri = $this->container->get( Uplink::UPLINK_ASSETS_URI ); + + $this->assertSame( 'http://wordpress.test/wp-content/plugins/uplink/src/assets', $uri ); + + $uri = Config::get_container()->get( Uplink::UPLINK_ASSETS_URI ); + + $this->assertSame( 'http://wordpress.test/wp-content/plugins/uplink/src/assets', $uri ); + } } From f806839706f5d8a065edd9b09db9cd3afa9c45f7 Mon Sep 17 00:00:00 2001 From: Justin Frydman Date: Wed, 29 Nov 2023 10:18:57 -0700 Subject: [PATCH 2/5] enqueue assets with uplink uri, remove non php 7.1 code. --- src/Uplink/Admin/Field.php | 14 +++++++------- src/Uplink/Admin/License_Field.php | 18 +++++++++++------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/src/Uplink/Admin/Field.php b/src/Uplink/Admin/Field.php index dc344954..3e07924e 100644 --- a/src/Uplink/Admin/Field.php +++ b/src/Uplink/Admin/Field.php @@ -17,21 +17,21 @@ abstract class Field { * * @var string */ - protected string $path = ''; + protected $path = ''; /** * @since 1.0.0 * * @return void */ - abstract public function register_settings(); + abstract public function register_settings(): void; /** * @param array $args * * @return void */ - public function get_description( array $args = [] ) { + public function get_description( array $args = [] ): void { if ( empty( $args['description'] ) ) { return; } @@ -71,7 +71,7 @@ public function get_group_name( string $group_modifier = '' ) : string { * * @return void */ - public function field_html( array $args = [] ) { + public function field_html( array $args = [] ): void { $field = sprintf( '
@@ -112,7 +112,7 @@ public function add_nonce_field() : string { * * @return void */ - abstract public function render( bool $show_title = true, bool $show_button = true ); + abstract public function render( bool $show_title = true, bool $show_button = true ): void; /** * @param array $context @@ -155,11 +155,11 @@ protected function get_plugin() { * @since 1.0.0 * * @param string $page Slug title of the admin page whose settings fields you want to show. - * @param string $page Slug title of the admin page whose settings fields you want to show. + * @param string $section Slug title of the settings section whose fields you want to show. * @param string $plugin_slug Slug title of the settings section whose fields you want to show. * @param bool $show_title Whether to show the title or not. */ - public function do_settings_fields( string $page, string $section, string $plugin_slug, bool $show_title = true ) { + public function do_settings_fields( string $page, string $section, string $plugin_slug, bool $show_title = true ): void { global $wp_settings_fields; if ( ! isset( $wp_settings_fields[ $page ][ $section ] ) ) { diff --git a/src/Uplink/Admin/License_Field.php b/src/Uplink/Admin/License_Field.php index 2cd3573f..09cfe545 100644 --- a/src/Uplink/Admin/License_Field.php +++ b/src/Uplink/Admin/License_Field.php @@ -5,12 +5,16 @@ use StellarWP\Uplink\Config; use StellarWP\Uplink\Resources\Collection; use StellarWP\Uplink\Resources\Plugin; +use StellarWP\Uplink\Uplink; class License_Field extends Field { public const LICENSE_FIELD_ID = 'stellarwp_uplink_license'; - protected string $path = '/admin-views/fields/settings.php'; + /** + * @var string + */ + protected $path = '/admin-views/fields/settings.php'; /** * @param Plugin $plugin @@ -26,7 +30,7 @@ public function get_section_name( Plugin $plugin ) : string { * * @return void */ - public function register_settings() { + public function register_settings(): void { $collection = Config::get_container()->get( Collection::class ); $plugin = $collection->current(); @@ -77,7 +81,7 @@ public function get_field_html( Plugin $plugin ) : string { /** * @inheritDoc */ - public function render( bool $show_title = true, bool $show_button = true ) { + public function render( bool $show_title = true, bool $show_button = true ): void { echo $this->get_content( [ 'plugin' => $this->get_plugin(), 'show_title' => $show_title, @@ -90,16 +94,16 @@ public function render( bool $show_title = true, bool $show_button = true ) { * * @return void */ - public function enqueue_assets() { + public function enqueue_assets(): void { + $path = Config::get_container()->get( Uplink::UPLINK_ASSETS_URI ); $handle = sprintf( 'stellarwp-uplink-license-admin-%s', Config::get_hook_prefix() ); - $path = preg_replace( '/.*\/vendor/', plugin_dir_url( $this->get_plugin()->get_path() ) . 'vendor', dirname( __DIR__, 2 ) ); - $js_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_js_source', $path . '/assets/js/key-admin.js' ); + $js_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_js_source', $path . '/js/key-admin.js' ); wp_register_script( $handle, $js_src, [ 'jquery' ], '1.0.0', true ); wp_enqueue_script( $handle ); $action_postfix = Config::get_hook_prefix_underscored(); wp_localize_script( $handle, sprintf( 'stellarwp_config_%s', $action_postfix ), [ 'action' => sprintf( 'pue-validate-key-uplink-%s', $action_postfix ) ] ); - $css_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_css_source', $path . '/assets/css/main.css' ); + $css_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_css_source', $path . '/css/main.css' ); wp_enqueue_style( $handle, $css_src ); } } From 35d7044bb81fb6412a3de0a02ed09bbfd5f08858 Mon Sep 17 00:00:00 2001 From: Justin Frydman Date: Wed, 29 Nov 2023 10:44:50 -0700 Subject: [PATCH 3/5] Only enqueue license field assets when the license field is rendered --- src/Uplink/Admin/License_Field.php | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/src/Uplink/Admin/License_Field.php b/src/Uplink/Admin/License_Field.php index 09cfe545..9b67e48e 100644 --- a/src/Uplink/Admin/License_Field.php +++ b/src/Uplink/Admin/License_Field.php @@ -16,6 +16,17 @@ class License_Field extends Field { */ protected $path = '/admin-views/fields/settings.php'; + /** + * The script and style handle when registering assets for this field. + * + * @var string + */ + private $handle; + + public function __construct() { + $this->handle = sprintf( 'stellarwp-uplink-license-admin-%s', Config::get_hook_prefix() ); + } + /** * @param Plugin $plugin * @@ -82,6 +93,9 @@ public function get_field_html( Plugin $plugin ) : string { * @inheritDoc */ public function render( bool $show_title = true, bool $show_button = true ): void { + wp_enqueue_script( $this->handle ); + wp_enqueue_style( $this->handle ); + echo $this->get_content( [ 'plugin' => $this->get_plugin(), 'show_title' => $show_title, @@ -96,14 +110,13 @@ public function render( bool $show_title = true, bool $show_button = true ): voi */ public function enqueue_assets(): void { $path = Config::get_container()->get( Uplink::UPLINK_ASSETS_URI ); - $handle = sprintf( 'stellarwp-uplink-license-admin-%s', Config::get_hook_prefix() ); $js_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_js_source', $path . '/js/key-admin.js' ); - wp_register_script( $handle, $js_src, [ 'jquery' ], '1.0.0', true ); - wp_enqueue_script( $handle ); + wp_register_script( $this->handle, $js_src, [ 'jquery' ], '1.0.0', true ); + $action_postfix = Config::get_hook_prefix_underscored(); - wp_localize_script( $handle, sprintf( 'stellarwp_config_%s', $action_postfix ), [ 'action' => sprintf( 'pue-validate-key-uplink-%s', $action_postfix ) ] ); + wp_localize_script( $this->handle, sprintf( 'stellarwp_config_%s', $action_postfix ), [ 'action' => sprintf( 'pue-validate-key-uplink-%s', $action_postfix ) ] ); $css_src = apply_filters( 'stellarwp/uplink/' . Config::get_hook_prefix() . '/admin_css_source', $path . '/css/main.css' ); - wp_enqueue_style( $handle, $css_src ); + wp_register_style( $this->handle, $css_src ); } } From 3f3f8d07f811a57293f4366c1c16b58700facc3d Mon Sep 17 00:00:00 2001 From: Justin Frydman Date: Wed, 29 Nov 2023 10:56:16 -0700 Subject: [PATCH 4/5] Remove PHP 7.4 types, add method return types --- src/Uplink/Admin/Plugins_Page.php | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/Uplink/Admin/Plugins_Page.php b/src/Uplink/Admin/Plugins_Page.php index ec7e30ef..32751962 100644 --- a/src/Uplink/Admin/Plugins_Page.php +++ b/src/Uplink/Admin/Plugins_Page.php @@ -15,7 +15,7 @@ class Plugins_Page { * * @var array */ - public array $plugin_notice = []; + public $plugin_notice = []; /** * Displays messages on the plugins page in the dashboard. @@ -26,7 +26,7 @@ class Plugins_Page { * * @return void */ - public function display_plugin_messages( string $page ) { + public function display_plugin_messages( string $page ): void { if ( 'plugins.php' !== $page ) { return; } @@ -126,7 +126,7 @@ public function get_plugin_notice() { * * @return void */ - public function store_admin_notices( string $page ) { + public function store_admin_notices( string $page ): void { if ( 'plugins.php' !== $page ) { return; } @@ -141,8 +141,8 @@ public function store_admin_notices( string $page ) { * * @return void */ - public function output_notices_script() { - $slug = $this->get_plugin()->get_slug(); + public function output_notices_script(): void { + $slug = $this->get_plugin()->get_slug(); $notice = $this->get_plugin_notice(); if ( empty( $notice ) ) { @@ -203,7 +203,7 @@ public function get_plugin_message( Plugin $resource ) { * * @return void */ - public function remove_default_inline_update_msg() { + public function remove_default_inline_update_msg(): void { remove_action( "after_plugin_row_{$this->get_plugin()->get_path()}", 'wp_plugin_update_row' ); } @@ -235,13 +235,13 @@ protected function get_plugin() { * * @see plugins_api() * - * @param mixed $result - * @param string $action - * @param array|object $args + * @param mixed $result + * @param string|null $action + * @param array|object|null $args * * @return mixed */ - public function inject_info( $result, string $action = null, $args = null ) { + public function inject_info( $result, ?string $action = null, $args = null ) { $relevant = ( 'plugin_information' === $action ) && is_object( $args ) && isset( $args->slug ) && ( $args->slug === $this->get_plugin()->get_slug() ); if ( ! $relevant ) { From c1bdec46bcd765f5aaee14843ae3244b2319b55b Mon Sep 17 00:00:00 2001 From: Matthew Batchelder Date: Wed, 29 Nov 2023 16:55:40 -0500 Subject: [PATCH 5/5] Update src/Uplink/Admin/License_Field.php --- src/Uplink/Admin/License_Field.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Uplink/Admin/License_Field.php b/src/Uplink/Admin/License_Field.php index 9b67e48e..5e3bf5bb 100644 --- a/src/Uplink/Admin/License_Field.php +++ b/src/Uplink/Admin/License_Field.php @@ -22,7 +22,9 @@ class License_Field extends Field { * @var string */ private $handle; - + /** + * Constructor. Initializes handle. + */ public function __construct() { $this->handle = sprintf( 'stellarwp-uplink-license-admin-%s', Config::get_hook_prefix() ); }