Closes #6367 Add theme resolver for compatibility classes (#6390)

wp-media · Mar 15, 2024 · b3dd96e · b3dd96e
1 parent 3e4a773
commit b3dd96e
Show file tree

Hide file tree

Showing 37 changed files with 567 additions and 659 deletions.
diff --git a/inc/ThirdParty/Themes/Avada.php b/inc/ThirdParty/Themes/Avada.php
@@ -2,18 +2,12 @@
 namespace WP_Rocket\ThirdParty\Themes;
 
 use WP_Rocket\Admin\Options_Data;
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
 /**
  * Compatibility class for Avada theme
  */
-class Avada extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'avada';
-
+class Avada implements Subscriber_Interface {
 	/**
 	 * Options instance
 	 *
@@ -29,9 +23,6 @@ class Avada extends ThirdpartyTheme {
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
 		return [
 			'avada_clear_dynamic_css_cache'        => 'clean_domain',
 			'rocket_exclude_defer_js'              => 'exclude_defer_js',

diff --git a/inc/ThirdParty/Themes/Bridge.php b/inc/ThirdParty/Themes/Bridge.php
@@ -2,18 +2,12 @@
 namespace WP_Rocket\ThirdParty\Themes;
 
 use WP_Rocket\Admin\Options_Data;
+use WP_Rocket\Event_Management\Subscriber_Interface;
 use WP_Rocket\ThirdParty\ReturnTypesTrait;
 
-class Bridge extends ThirdpartyTheme {
+class Bridge implements Subscriber_Interface {
 	use ReturnTypesTrait;
 
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'bridge';
-
 	/**
 	 * Options instance
 	 *
@@ -29,10 +23,6 @@ class Bridge extends ThirdpartyTheme {
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
-
 		return [
 			'rocket_lazyload_background_images' => 'return_false',
 			'update_option_qode_options_proya'  => [ 'maybe_clear_cache', 10, 2 ],

diff --git a/inc/ThirdParty/Themes/Divi.php b/inc/ThirdParty/Themes/Divi.php
@@ -5,15 +5,9 @@
 use WP_Rocket\Admin\{Options, Options_Data};
 use WP_Rocket\Engine\Optimization\DelayJS\HTML;
 use WP_Rocket\Engine\Optimization\RUCSS\Controller\UsedCSS;
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
-class Divi extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'divi';
-
+class Divi implements Subscriber_Interface {
 	/**
 	 * Options API instance.
 	 *
@@ -64,13 +58,10 @@ public function __construct( Options $options_api, Options_Data $options, HTML $
 	 */
 	public static function get_subscribed_events() {
 		$events = [
-			'switch_theme'                    => [ 'maybe_disable_youtube_preview', PHP_INT_MAX, 2 ],
+			'after_switch_theme'              => [ 'maybe_disable_youtube_preview', PHP_INT_MAX ],
 			'rocket_specify_dimension_images' => 'disable_image_dimensions_height_percentage',
 		];
 
-		if ( ! self::is_current_theme() ) {
-			return $events;
-		}
 		$events['rocket_exclude_js']                            = 'exclude_js';
 		$events['rocket_maybe_disable_youtube_lazyload_helper'] = 'add_divi_to_description';
 
@@ -116,16 +107,9 @@ public function exclude_js( $excluded_js ) {
 	 *
 	 * @since 3.6.3
 	 *
-	 * @param string   $name  Name of the new theme.
-	 * @param WP_Theme $theme instance of the new theme.
-	 *
 	 * @return void
 	 */
-	public function maybe_disable_youtube_preview( $name, $theme ) {
-		if ( ! self::is_current_theme( $theme ) ) {
-			return;
-		}
-
+	public function maybe_disable_youtube_preview() {
 		$this->options->set( 'lazyload_youtube', 0 );
 		$this->options_api->set( 'settings', $this->options->get_options() );
 	}
@@ -140,10 +124,6 @@ public function maybe_disable_youtube_preview( $name, $theme ) {
 	 * @return array
 	 */
 	public function add_divi_to_description( $disable_youtube_lazyload ) {
-		if ( ! self::is_current_theme() ) {
-			return $disable_youtube_lazyload;
-		}
-
 		$disable_youtube_lazyload[] = 'Divi';
 
 		return $disable_youtube_lazyload;

diff --git a/inc/ThirdParty/Themes/Flatsome.php b/inc/ThirdParty/Themes/Flatsome.php
@@ -3,25 +3,18 @@
 
 namespace WP_Rocket\ThirdParty\Themes;
 
-class Flatsome extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'flatsome';
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
+class Flatsome implements Subscriber_Interface {
 	/**
 	 * Return an array of events that this subscriber wants to listen to.
 	 *
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
-
-		return [ 'rocket_rucss_inline_content_exclusions' => 'preserve_patterns' ];
+		return [
+			'rocket_rucss_inline_content_exclusions' => 'preserve_patterns',
+		];
 	}
 
 	/**

diff --git a/inc/ThirdParty/Themes/Jevelin.php b/inc/ThirdParty/Themes/Jevelin.php
@@ -1,23 +1,15 @@
 <?php
 namespace WP_Rocket\ThirdParty\Themes;
 
-class Jevelin extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'jevelin';
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
+class Jevelin implements Subscriber_Interface {
 	/**
 	 * Return an array of events that this subscriber wants to listen to.
 	 *
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
 		return [
 			'rocket_rucss_inline_content_exclusions' => 'preserve_patterns',
 		];

diff --git a/inc/ThirdParty/Themes/MinimalistBlogger.php b/inc/ThirdParty/Themes/MinimalistBlogger.php
@@ -2,24 +2,15 @@
 
 namespace WP_Rocket\ThirdParty\Themes;
 
-class MinimalistBlogger extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'minimalistblogger';
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
+class MinimalistBlogger implements Subscriber_Interface {
 	/**
 	 * Return an array of events that this subscriber wants to listen to.
 	 *
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
-
 		return [
 			'rocket_delay_js_exclusions' => 'exclude_jquery_from_delay_js',
 		];

diff --git a/inc/ThirdParty/Themes/Polygon.php b/inc/ThirdParty/Themes/Polygon.php
@@ -2,24 +2,15 @@
 
 namespace WP_Rocket\ThirdParty\Themes;
 
-class Polygon extends ThirdpartyTheme {
-	/**
-	 * Theme name
-	 *
-	 * @var string
-	 */
-	protected static $theme_name = 'polygon';
+use WP_Rocket\Event_Management\Subscriber_Interface;
 
+class Polygon implements Subscriber_Interface {
 	/**
 	 * Return an array of events that this subscriber wants to listen to.
 	 *
 	 * @return array
 	 */
 	public static function get_subscribed_events() {
-		if ( ! self::is_current_theme() ) {
-			return [];
-		}
-
 		return [
 			'rocket_rucss_inline_content_exclusions' => 'add_rucss_content_excluded',
 		];
@@ -35,14 +26,4 @@ public function add_rucss_content_excluded( $excluded ) {
 		$excluded [] = '.expanding_bar_';
 		return $excluded;
 	}
-
-	/**
-	 * Checks if the current theme (or parent) is Polygone
-	 *
-	 * @param WP_Theme $theme Instance of the theme.
-	 */
-	private static function is_polygon( $theme = null ) {
-		$theme = $theme instanceof WP_Theme ? $theme : wp_get_theme();
-		return ( 'polygon' === strtolower( $theme->get( 'Name' ) ) || 'polygon' === $theme->get_template() );
-	}
 }
diff --git a/inc/ThirdParty/Themes/ServiceProvider.php b/inc/ThirdParty/Themes/ServiceProvider.php
@@ -3,9 +3,9 @@
 
 namespace WP_Rocket\ThirdParty\Themes;
 
-use WP_Rocket\Dependencies\League\Container\ServiceProvider\AbstractServiceProvider;
+use WP_Rocket\Dependencies\League\Container\ServiceProvider\{AbstractServiceProvider, BootableServiceProviderInterface};
 
-class ServiceProvider extends AbstractServiceProvider {
+class ServiceProvider extends AbstractServiceProvider implements BootableServiceProviderInterface {
 	/**
 	 * The provides array is a way to let the container
 	 * know that a service is provided by this service
@@ -15,65 +15,46 @@ class ServiceProvider extends AbstractServiceProvider {
 	 *
 	 * @var array
 	 */
-	protected $provides = [
-		'avada_subscriber',
-		'bridge_subscriber',
-		'divi',
-		'flatsome',
-		'jevelin',
-		'minimalist_blogger',
-		'polygon',
-		'uncode',
-		'xstore',
-		'themify',
-		'shoptimizer',
-	];
+	protected $provides = [];
+
+	/**
+	 * Register the service in the provider array
+	 *
+	 * @return void
+	 */
+	public function boot() {
+		$theme = ThemeResolver::get_current_theme();
+
+		if ( ! empty( $theme ) ) {
+			$this->provides[] = $theme;
+		}
+	}
 
 	/**
 	 * Registers the subscribers in the container
 	 *
 	 * @return void
 	 */
 	public function register() {
-		$options = $this->getContainer()->get( 'options' );
+		$theme = ThemeResolver::get_current_theme();
+
+		if ( ! empty( $theme ) ) {
+			$factory = new SubscriberFactory();
+
+			$theme_data = $factory->get_subscriber();
+			$arguments  = [];
 
-		$this->getContainer()
-			->share( 'avada_subscriber', Avada::class )
-			->addArgument( $options )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'bridge_subscriber', Bridge::class )
-			->addArgument( $options )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'divi', Divi::class )
-			->addArgument( $this->getContainer()->get( 'options_api' ) )
-			->addArgument( $options )
-			->addArgument( $this->getContainer()->get( 'delay_js_html' ) )
-			->addArgument( $this->getContainer()->get( 'rucss_used_css_controller' ) )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'flatsome', Flatsome::class )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'jevelin', Jevelin::class )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'minimalist_blogger', MinimalistBlogger::class )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'polygon', Polygon::class )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'uncode', Uncode::class )
-			->addTag( 'common_subscriber' );
-		$this->getContainer()
-			->share( 'xstore', Xstore::class )
-			->addTag( 'common_subscriber' );
+			if ( empty( $theme_data ) ) {
+				return;
+			}
 
-		$this->getContainer()->share( 'themify', Themify::class )
-			->addArgument( $options );
+			foreach ( $theme_data['arguments'] as $arg ) {
+				$arguments[] = $this->getContainer()->get( $arg );
+			}
 
-		$this->getContainer()->share( 'shoptimizer', Shoptimizer::class );
+			$this->getContainer()
+				->share( $theme, $theme_data['class'] )
+				->addArguments( $arguments );
+		}
 	}
 }