Refactored post parent functionality. Added constants for default fields. Added more tests.

Author: colinmurphy

plugins/hwp-previews/ACTIONS_AND_FILTERS.md

@@ -13,6 +13,7 @@
 - `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_filter_available_parent_post_statuses` - Filter for parent post statuses 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`
@@ -25,6 +26,9 @@
 
 ## Usage Examples
 
+@TODO - Redo
+
+
 ### Filter: Post Types List
 
 Modify which post types appear in the settings UI:

plugins/hwp-previews/src/Admin/Settings/Fields/Settings_Field_Collection.php

@@ -8,6 +8,36 @@
 use HWP\Previews\Admin\Settings\Fields\Field\URL_Input_Field;
 
 class Settings_Field_Collection {
+	/**
+	 * The ID of the field that enables or disables the previews.
+	 *
+	 * @var string
+	 */
+	public const ENABLED_FIELD_ID = 'enabled';
+
+
+	/**
+	 * The ID of the field that allows using post-statuses as parent.
+	 *
+	 * @var string
+	 */
+	public const POST_STATUSES_AS_PARENT_FIELD_ID = 'post_statuses_as_parent';
+
+
+	/**
+	 * The ID of the field that indicates whether the preview is rendered in an iframe.
+	 *
+	 * @var string
+	 */
+	public const IN_IFRAME_FIELD_ID = 'in_iframe';
+
+	/**
+	 * The ID of the field that contains the preview URL.
+	 *
+	 * @var string
+	 */
+	public const PREVIEW_URL_FIELD_ID = 'preview_url';
+
 	/**
 	 * Array of fields
 	 *
@@ -66,7 +96,7 @@ protected function initialize_fields(): void {
 
 		$this->add_field(
 			new Checkbox_Field(
-				'enabled',
+				self::ENABLED_FIELD_ID,
 				false,
 				__( 'Enable Previews', 'hwp-previews' ),
 				__( 'Enable previews for post type.', 'hwp-previews' )
@@ -75,7 +105,7 @@ protected function initialize_fields(): void {
 
 		$this->add_field(
 			new Checkbox_Field(
-				'post_statuses_as_parent',
+				self::POST_STATUSES_AS_PARENT_FIELD_ID,
 				true,
 				__( 'Allow all post statuses in parents option', 'hwp-previews' ),
 				__( 'By default WordPress only allows published posts to be parents. This option allows posts of all statuses to be used as parent within hierarchical post types.', 'hwp-previews' )
@@ -84,7 +114,7 @@ protected function initialize_fields(): void {
 
 		$this->add_field(
 			new Checkbox_Field(
-				'in_iframe',
+				self::IN_IFRAME_FIELD_ID,
 				false,
 				__( 'Use iframe to render previews', 'hwp-previews' ),
 				__( 'With this option enabled, headless previews will be displayed inside an iframe on the preview page, without leaving WordPress.', 'hwp-previews' )
@@ -93,7 +123,7 @@ protected function initialize_fields(): void {
 
 		$this->add_field(
 			new URL_Input_Field(
-				'preview_url',
+				self::PREVIEW_URL_FIELD_ID,
 				false,
 				__( 'Preview URL', 'hwp-previews' ),
 				__( 'Construct your preview URL using the tags on the right. You can add any parameters needed to support headless previews.', 'hwp-previews' ),

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

@@ -4,9 +4,8 @@
 
 namespace HWP\Previews\Hooks;
 
-use HWP\Previews\Preview\Helper\Settings_Helper;
+use HWP\Previews\Admin\Settings\Fields\Settings_Field_Collection;
 use HWP\Previews\Preview\Parameter\Preview_Parameter_Registry;
-use HWP\Previews\Preview\Post\Parent\Post_Parent_Manager;
 use HWP\Previews\Preview\Post\Post_Preview_Service;
 use HWP\Previews\Preview\Post\Post_Settings_Service;
 use HWP\Previews\Preview\Post\Post_Type_Service;
@@ -20,13 +19,6 @@
 use WP_REST_Response;
 
 class Preview_Hooks {
-	/**
-	 * Settings helper instance that provides access to plugin settings.
-	 *
-	 * @var \HWP\Previews\Preview\Helper\Settings_Helper
-	 */
-	protected Settings_Helper $settings_helper;
-
 	/**
 	 * Post types configuration.
 	 *
@@ -71,8 +63,6 @@ public function __construct() {
 
 		// @TODO - Refactor to use a factory or service locator pattern and analyze what is is actually needed.
 
-		$this->settings_helper = Settings_Helper::get_instance();
-
 		$this->types_config = apply_filters(
 			'hwp_previews_hooks_post_type_config',
 			Post_Types_Config_Registry::get_post_type_config()
@@ -153,26 +143,47 @@ public function get_post_statuses(): array {
 	 * @link https://developer.wordpress.org/reference/hooks/quick_edit_dropdown_pages_args/
 	 */
 	public function enable_post_statuses_as_parent( array $args ): array {
+		if ( ! $this->should_enable_post_statuses_as_parent( $args ) ) {
+			return $args;
+		}
 
-		if ( empty( $args['post_type'] ) ) {
+		$parent_statuses = $this->post_preview_service->get_parent_post_statuses();
+		$post_statuses   = $this->post_preview_service->get_post_statuses();
+		$post_statuses   = array_intersect( $parent_statuses, $post_statuses );
+
+		if ( empty( $post_statuses ) ) {
 			return $args;
 		}
 
-		$post_parent_manager = new Post_Parent_Manager( $this->types_config, $this->statuses_config );
+		$args['post_status'] = $post_statuses;
+
+		return $args;
+	}
+
+	/**
+	 * Whether post-statuses should be enabled as parent for the given post-type.
+	 *
+	 * @param array<mixed> $args
+	 */
+	public function should_enable_post_statuses_as_parent( array $args ): bool {
+		if ( empty( $args['post_type'] ) ) {
+			return false;
+		}
 
 		$post_type = (string) $args['post_type'];
 
-		// Check if the correspondent setting is enabled.
-		if ( ! $this->settings_helper->post_statuses_as_parent( $post_type ) ) {
-			return $args;
+		if ( ! is_post_type_hierarchical( $post_type ) ) {
+			return false;
 		}
 
-		$post_statuses = $post_parent_manager->get_post_statuses_as_parent( $post_type );
-		if ( ! empty( $post_statuses ) ) {
-			$args['post_status'] = $post_statuses;
+		$config = $this->post_settings_service->get_post_type_config( $post_type );
+		if ( ! is_array( $config ) || empty( $config ) ) {
+			return false;
 		}
 
-		return $args;
+		$field_id = Settings_Field_Collection::POST_STATUSES_AS_PARENT_FIELD_ID;
+
+		return isset( $config[ $field_id ] ) && (bool) $config[ $field_id ];
 	}
 
 	/**

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

@@ -68,16 +68,4 @@ public function post_types_enabled( array $default_value = [] ): array {
 		}
 		return $default_value;
 	}
-
-	/**
-	 * Get Post Statuses as Parent setting value for the given post type.
-	 *
-	 * @param string $post_type The post type to get the setting for.
-	 * @param bool   $default_value The default value to return if the setting is not set.
-	 */
-	public function post_statuses_as_parent( string $post_type, bool $default_value = false ): bool {
-		$key = $this->settings_group->get_settings_key_post_statuses_as_parent();
-
-		return $this->settings_group->get_post_type_boolean_value( $key, $post_type, $default_value );
-	}
 }

plugins/hwp-previews/src/Preview/Post/Parent/Contracts/Post_Parent_Manager_Interface.php

@@ -19,6 +19,13 @@ class Post_Preview_Service {
 	 */
 	protected $post_statuses = [];
 
+	/**
+	 * The allowed post-statuses for parent post-types (hierarchical).
+	 *
+	 * @var array<string>
+	 */
+	protected $parent_post_statuses = [];
+
 	/**
 	 * Constructor for the Post_Preview_Service class.
 	 *
@@ -27,6 +34,7 @@ class Post_Preview_Service {
 	public function __construct() {
 		$this->set_post_types();
 		$this->set_post_statuses();
+		$this->set_post_parent_statuses();
 	}
 
 	/**
@@ -54,6 +62,15 @@ public function get_post_types(): array {
 		return $this->post_types;
 	}
 
+	/**
+	 * Get the parent post statuses
+	 *
+	 * @return array<string>
+	 */
+	public function get_parent_post_statuses(): array {
+		return $this->parent_post_statuses;
+	}
+
 	/**
 	 * Sets the allowed post types for previews.
 	 */
@@ -85,4 +102,20 @@ protected function set_post_statuses(): void {
 
 		$this->post_statuses = apply_filters( 'hwp_previews_filter_available_post_statuses', $post_statuses );
 	}
+
+	/**
+	 * Sets the allowed post statuses for parent post-types (hierarchael).
+	 */
+	protected function set_post_parent_statuses(): void {
+
+		$post_statuses = [
+			'publish',
+			'future',
+			'draft',
+			'pending',
+			'private'
+		];
+
+		$this->parent_post_statuses = apply_filters( 'hwp_previews_filter_available_parent_post_statuses', $post_statuses );
+	}
 }

plugins/hwp-previews/src/Preview/Post/Parent/Post_Parent_Manager.php

@@ -4,6 +4,7 @@
 
 namespace HWP\Previews\Preview\Post;
 
+use HWP\Previews\Admin\Settings\Fields\Settings_Field_Collection;
 use WP_Post;
 
 class Post_Type_Service {
@@ -55,11 +56,13 @@ public function is_enabled(): bool {
 			return false;
 		}
 
-		if ( ! isset( $config['enabled'] ) ) {
+		$field_id = Settings_Field_Collection::ENABLED_FIELD_ID;
+
+		if ( ! isset( $config[ $field_id ] ) ) {
 			return false;
 		}
 
-		return (bool) $config['enabled'];
+		return (bool) $config[ $field_id ];
 	}
 
 	/**
@@ -91,12 +94,12 @@ public function is_iframe(): bool {
 			return false;
 		}
 
-		// @TODO - Key resolution.
-		if ( ! isset( $config['in_iframe'] ) ) {
+		$field_id = Settings_Field_Collection::IN_IFRAME_FIELD_ID;
+		if ( ! isset( $config[ $field_id ] ) ) {
 			return false;
 		}
 
-		return (bool) $config['in_iframe'];
+		return (bool) $config[ $field_id ];
 	}
 
 	/**
@@ -110,10 +113,11 @@ public function get_preview_url(): ?string {
 			return null;
 		}
 
-		if ( ! isset( $config['preview_url'] ) ) {
+		$field_id = Settings_Field_Collection::PREVIEW_URL_FIELD_ID;
+		if ( ! isset( $config[ $field_id ] ) ) {
 			return null;
 		}
 
-		return (string) $config['preview_url'];
+		return (string) $config[ $field_id ];
 	}
 }