Refactoring. Add some new services to consolidate some of the existing functionality.

Author: colinmurphy

plugins/hwp-previews/ACTIONS_AND_FILTERS.md

@@ -12,6 +12,7 @@
 - `hwp_previews_template_path` - To use our own template for iframe previews
 - `hwp_previews_core` - Register or unregister URL parameters, and adjust types/statuses
 - `hwp_previews_filter_available_post_types` - Filter to modify the available post types for Previews.
+- `hwp_previews_filter_available_post_statuses` - Filter for post statuses for previews for Previews
 - `hwp_previews_settings_group_option_key` - Filter to modify the settings group option key. Default is HWP_PREVIEWS_SETTINGS_KEY
 - `hwp_previews_settings_group_settings_group` - Filter to modify the settings group name. Default is HWP_PREVIEWS_SETTINGS_GROUP
 - `hwp_previews_settings_group_settings_config` - Filter to modify the settings array. See `Settings_Group`
@@ -20,7 +21,6 @@
 - `hwp_previews_hooks_post_type_config` - Filter for post type config service for the Hook class
 - `hwp_previews_hooks_post_status_config` - Filter for post status config service for the Hook class
 - `hwp_previews_hooks_preview_link_service` - Filter for preview link service for the Hook class
-- `hwp_previews_hooks_post_statuses` - Filter for post statuses for previews for the Hook Class
 - `hwp_previews_settings_fields` - Allows a user to register, modify, or remove settings fields for the settings page
 
 ## Usage Examples

plugins/hwp-previews/src/Hooks/Preview_Hooks.php

@@ -13,7 +13,10 @@
 use HWP\Previews\Preview\Post\Status\Post_Statuses_Config;
 use HWP\Previews\Preview\Post\Type\Contracts\Post_Types_Config_Interface;
 use HWP\Previews\Preview\Post\Type\Post_Types_Config_Registry;
-use HWP\Previews\Preview\Template_Resolver;
+use HWP\Previews\Preview\Service\Post_Preview_Service;
+use HWP\Previews\Preview\Service\Post_Settings_Service;
+use HWP\Previews\Preview\Service\Post_Type_Service;
+use HWP\Previews\Preview\Service\Template_Resolver_Service;
 use WP_Post;
 use WP_REST_Response;
 
@@ -60,7 +63,7 @@ class Preview_Hooks {
 	 */
 	public function __construct() {
 
-		// @TODO - Refactor to use a factory or service locator pattern and ananlyze what is is actually needed.
+		// @TODO - Refactor to use a factory or service locator pattern and analyze what is is actually needed.
 
 		$this->settings_helper = Settings_Helper::get_instance();
 
@@ -125,6 +128,7 @@ public function setup(): void {
 	 * @return array<string>
 	 */
 	public function get_post_statuses(): array {
+		// @TODO - Remove
 		$post_statuses = [
 			'publish',
 			'future',
@@ -202,22 +206,17 @@ public function add_iframe_preview_template( string $template ): string {
 			return $template;
 		}
 
-		// @TODO - Refactor as should be part of the main preview settings.
-		$settings_helper = Settings_Helper::get_instance();
-		if ( ! $settings_helper->in_iframe( $post->post_type ) ) {
-			return $template;
-		}
-
-		// @TODO - Refactor as part of types and post statuses config refactor.
-		$post_types        = $this->types_config->get_post_types();
-		$post_statuses     = $this->statuses_config->get_post_statuses();
-		$template_resolver = new Template_Resolver( $post, $post_types, $post_statuses );
+		// @TODO - Move main classes into properties
+		$post_preview_service  = new Post_Preview_Service();
+		$post_settings_service = new Post_Settings_Service();
+		$post_type_service     = new Post_Type_Service( $post, $post_preview_service, $post_settings_service );
 
-		if ( ! $template_resolver->is_allowed() ) {
+		if ( ! $post_type_service->is_allowed_for_previews() || ! $post_type_service->is_iframe() ) {
 			return $template;
 		}
 
-		$iframe_template = $template_resolver->get_iframe_template();
+		$template_resolver = new Template_Resolver_Service();
+		$iframe_template   = $template_resolver->get_iframe_template();
 		if ( empty( $iframe_template ) ) {
 			return $template;
 		}

plugins/hwp-previews/src/Preview/Helper/Settings_Helper.php

@@ -44,16 +44,6 @@ public static function get_instance(): self {
 		return self::$instance;
 	}
 
-	/**
-	 * Get the settings group.
-	 *
-	 * @return array<string, mixed>
-	 */
-	public function get_settings_config(): array {
-		// @TODO: Remove this method when the settings group is no longer needed.
-		return $this->settings_group->get_settings_config();
-	}
-
 	/**
 	 * Get all post types that are enabled in the settings.
 	 *
@@ -99,6 +89,7 @@ public function post_statuses_as_parent( string $post_type, bool $default_value
 	 */
 	public function in_iframe( string $post_type, bool $default_value = false ): bool {
 
+		// @TODO remove as part of Post_Type_Service refactor.
 		$key = $this->settings_group->get_settings_key_in_iframe();
 
 		return $this->settings_group->get_post_type_boolean_value( $key, $post_type, $default_value );

plugins/hwp-previews/src/Preview/Service/Post_Preview_Service.php

@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HWP\Previews\Preview\Service;
+
+class Post_Preview_Service {
+	/**
+	 * The allowed post-types for previews.
+	 *
+	 * @var array<string>
+	 */
+	protected $post_types = [];
+
+	/**
+	 * The allowed post-statuses for previews.
+	 *
+	 * @var array<string>
+	 */
+	protected $post_statuses = [];
+
+	/**
+	 * Constructor for the Post_Preview_Service class.
+	 *
+	 * Initializes the allowed post-types and statuses for previews.
+	 */
+	public function __construct() {
+		$this->set_post_types();
+		$this->set_post_statuses();
+	}
+
+	/**
+	 * @return array<string>
+	 */
+	public function get_allowed_post_types(): array {
+		return $this->post_types;
+	}
+
+	/**
+	 * Get the post statuses.
+	 *
+	 * @return array<string>
+	 */
+	public function get_post_statuses(): array {
+		return $this->post_statuses;
+	}
+
+	/**
+	 * Get the post types.
+	 *
+	 * @return array<string>
+	 */
+	public function get_post_types(): array {
+		return $this->post_types;
+	}
+
+	/**
+	 * Sets the allowed post types for previews.
+	 */
+	protected function set_post_types(): void {
+		$post_types = get_post_types( [ 'public' => true ], 'objects' );
+
+		$result = [];
+
+		foreach ( $post_types as $post_type ) {
+			$result[ $post_type->name ] = $post_type->label;
+		}
+
+		$this->post_types = apply_filters( 'hwp_previews_filter_available_post_types', $result );
+	}
+
+	/**
+	 * Sets the allowed post statuses for previews.
+	 */
+	protected function set_post_statuses(): void {
+
+		$post_statuses = [
+			'publish',
+			'future',
+			'draft',
+			'pending',
+			'private',
+			'auto-draft',
+		];
+
+		$this->post_statuses = apply_filters( 'hwp_previews_filter_available_post_statuses', $post_statuses );
+	}
+}

plugins/hwp-previews/src/Preview/Service/Post_Settings_Service.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HWP\Previews\Preview\Service;
+
+class Post_Settings_Service {
+	/**
+	 * The settings value
+	 *
+	 * @var array<mixed>
+	 */
+	protected $settings_values = [];
+
+	/**
+	 * Initialize the settings service.
+	 */
+	public function __construct() {
+		$this->setup();
+	}
+
+	/**
+	 * @param string $post_type
+	 *
+	 * @return array<mixed>|null
+	 */
+	public function get_post_type_config( string $post_type ): ?array {
+		return $this->settings_values[ $post_type ] ?? null;
+	}
+
+	/**
+	 * The option key for the settings group.
+	 */
+	public function get_option_key(): string {
+		return (string) apply_filters( 'hwp_previews_settings_group_option_key', HWP_PREVIEWS_SETTINGS_KEY );
+	}
+
+	/**
+	 * The settings group for the options.
+	 */
+	public function get_settings_group(): string {
+		return (string) apply_filters( 'hwp_previews_settings_group_settings_group', HWP_PREVIEWS_SETTINGS_GROUP );
+	}
+
+	/**
+	 * Setup the settings values by retrieving them from the database or cache.
+	 * This method is called in the constructor to ensure settings are available.
+	 */
+	protected function setup(): void {
+		$option_key     = $this->get_option_key();
+		$settings_group = $this->get_settings_group();
+
+		$value = wp_cache_get( $option_key, $settings_group );
+		if ( is_array( $value ) ) {
+			$this->settings_values = $value;
+
+			return;
+		}
+
+		$this->settings_values = (array) get_option( $option_key, [] );
+		wp_cache_set( $option_key, $value, $settings_group );
+	}
+}

plugins/hwp-previews/src/Preview/Service/Post_Type_Service.php

@@ -0,0 +1,96 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HWP\Previews\Preview\Service;
+
+use WP_Post;
+
+class Post_Type_Service {
+	/**
+	 * The post-object
+	 *
+	 * @var \WP_Post
+	 */
+	protected WP_Post $post;
+
+	/**
+	 * Post-preview service that provide information about the post type for previews.
+	 *
+	 * @var \HWP\Previews\Preview\Service\Post_Preview_Service
+	 */
+	private Post_Preview_Service $post_preview_service;
+
+	/**
+	 * Settings service to retrieve post type settings.
+	 *
+	 * @var \HWP\Previews\Preview\Service\Post_Settings_Service
+	 */
+	private Post_Settings_Service $post_settings_service;
+
+	/**
+	 * @param \WP_Post                                            $post
+	 * @param \HWP\Previews\Preview\Service\Post_Preview_Service  $post_preview_service
+	 * @param \HWP\Previews\Preview\Service\Post_Settings_Service $post_settings_service
+	 */
+	public function __construct( WP_Post $post, Post_Preview_Service $post_preview_service, Post_Settings_Service $post_settings_service ) {
+		$this->post                  = $post;
+		$this->post_preview_service  = $post_preview_service;
+		$this->post_settings_service = $post_settings_service;
+	}
+
+	/**
+	 * Checks if the post type is allowed for previews.
+	 */
+	public function is_allowed_for_previews(): bool {
+		return $this->is_enabled() && $this->is_allowed_post_type() && $this->is_allowed_post_status();
+	}
+
+	/**
+	 * Checks if the post-type is enabled for previews.
+	 */
+	public function is_enabled(): bool {
+		$config = $this->post_settings_service->get_post_type_config( $this->post->post_type );
+		if ( ! is_array( $config ) ) {
+			return false;
+		}
+
+		if ( ! isset( $config['enabled'] ) ) {
+			return false;
+		}
+		return (bool) $config['enabled'];
+	}
+
+	/**
+	 * Checks if the post-type is allowed for previews.
+	 */
+	public function is_allowed_post_type(): bool {
+		$post_type  = $this->post->post_type;
+		$post_types = $this->post_preview_service->get_post_types();
+		return array_key_exists( $post_type, $post_types );
+	}
+
+	/**
+	 * Checks if the post-status is allowed for previews.
+	 */
+	public function is_allowed_post_status(): bool {
+		$post_status   = $this->post->post_status;
+		$post_statuses = $this->post_preview_service->get_post_statuses();
+		return in_array( $post_status, $post_statuses, true );
+	}
+
+	/**
+	 * Checks if the post-type is allowed for iframe previews.
+	 */
+	public function is_iframe(): bool {
+		$config = $this->post_settings_service->get_post_type_config( $this->post->post_type );
+		if ( ! is_array( $config ) ) {
+			return false;
+		}
+
+		if ( ! isset( $config['in_iframe'] ) ) {
+			return false;
+		}
+		return (bool) $config['in_iframe'];
+	}
+}