Restore previous classes in a Legacy namespace for easier transition to typed classes

Author: ocean90

src/Legacy/PostMeta.php

@@ -0,0 +1,166 @@
+<?php
+/**
+ * PostMeta class
+ *
+ * Deprecated: Use Required\Common\PostMeta instead.
+ *
+ * @since 0.3.1
+ */
+
+namespace Required\Common\Legacy;
+
+use Required\Common\Contracts\Registrable;
+
+/**
+ * Class used to implement post meta.
+ *
+ * @since 0.1.0
+ */
+abstract class PostMeta implements Registrable {
+
+	/**
+	 * Post meta key.
+	 */
+	public const KEY = null;
+
+	/**
+	 * Registers the object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return bool Whether the post meta was registered successfully.
+	 */
+	public function register(): bool {
+		return register_post_meta(
+			$this->post_type(),
+			static::KEY,
+			$this->get_args()
+		);
+	}
+
+	/**
+	 * Gets post meta arguments for this post meta object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @see register_meta() For the supported arguments.
+	 *
+	 * @return array Post meta arguments.
+	 */
+	protected function get_args(): array {
+		return [
+			'type'              => $this->type(),
+			'description'       => $this->description(),
+			'single'            => $this->is_single(),
+			'default'           => $this->default(),
+			'sanitize_callback' => [ $this, 'sanitize' ],
+			'auth_callback'     => [ $this, 'auth' ],
+			'show_in_rest'      => $this->show_in_rest(),
+		];
+	}
+
+	/**
+	 * The post type to register a meta key for.
+	 *
+	 * Pass an empty string to register the meta key across all existing post types.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return string Post type to register a meta key for.
+	 */
+	protected function post_type(): string {
+		return '';
+	}
+
+	/**
+	 * The type of data associated with this meta key.
+	 *
+	 * Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return string Type of the data.
+	 */
+	protected function type(): string {
+		return 'string';
+	}
+
+	/**
+	 * A description of the data attached to this meta key.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return string Description of the data.
+	 */
+	protected function description(): string {
+		return '';
+	}
+
+	/**
+	 * Whether the meta key has one value per object, or an array of values per object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return bool Whether the meta key has one value per object.
+	 */
+	protected function is_single(): bool {
+		return false;
+	}
+
+	/**
+	 * The default value if no value has been set yet.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return mixed The default value.
+	 */
+	protected function default() {
+		return '';
+	}
+
+	/**
+	 * Sanitization of the post meta data.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed  $meta_value      Meta value to sanitize.
+	 * @param string $meta_key        Meta key.
+	 * @param string $object_type     Object type.
+	 * @return mixed Sanitized meta value.
+	 */
+	public function sanitize( $meta_value, $meta_key, $object_type ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		return $meta_value;
+	}
+
+	/**
+	 * Whether the user is allowed to edit meta.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param bool   $allowed   Whether the user can add the post meta. Default false.
+	 * @param string $meta_key  The meta key.
+	 * @param int    $object_id Object ID.
+	 * @param int    $user_id   User ID.
+	 * @param string $cap       Capability name.
+	 * @param array  $caps      User capabilities.
+	 * @return bool False if the key is protected, true otherwise.
+	 */
+	public function auth( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ): bool { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+		return ! is_protected_meta( $meta_key, 'post' );
+	}
+
+	/**
+	 * Whether data associated with this meta key can be considered public and
+	 * should be accessible via the REST API.
+	 *
+	 * When registering complex meta values this argument may optionally be an
+	 * array with 'schema' or 'prepare_callback' keys instead of a boolean.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return bool|array Whether the data is public.
+	 */
+	protected function show_in_rest() {
+		return false;
+	}
+}

src/Legacy/PostType.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * PostType class
+ *
+ * Deprecated: Use Required\Common\PostType instead.
+ *
+ * @since 0.3.1
+ */
+
+namespace Required\Common\Legacy;
+
+use Required\Common\Contracts\Registrable;
+
+/**
+ * Class used to implement custom post types.
+ *
+ * @since 0.1.0
+ */
+abstract class PostType implements Registrable {
+
+	public const NAME = 'post';
+
+	/**
+	 * Creates a post type object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return bool Whether the post type was registered successfully.
+	 */
+	public function register(): bool {
+		if ( ! post_type_exists( static::NAME ) ) {
+			$post_type = register_post_type(
+				static::NAME,
+				$this->get_args()
+			);
+			return ! is_wp_error( $post_type );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Gets post type arguments for this post type object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array Post type arguments.
+	 */
+	abstract protected function get_args(): array;
+}

src/Legacy/Taxonomy.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Taxonomy class
+ *
+ * Deprecated: Use Required\Common\Taxonomy instead.
+ *
+ * @since 0.3.1
+ */
+
+namespace Required\Common\Legacy;
+
+use Required\Common\Contracts\Registrable;
+
+/**
+ * Class used to implement custom taxonomies.
+ *
+ * @since 0.1.0
+ */
+abstract class Taxonomy implements Registrable {
+
+	public const NAME = 'category';
+
+	/**
+	 * Object types the taxonomy is associated with.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var array
+	 */
+	protected $object_types;
+
+	/**
+	 * Creates a taxonomy object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return bool Whether the taxonomy was registered successfully.
+	 */
+	public function register(): bool {
+		if ( ! taxonomy_exists( static::NAME ) ) {
+			$taxonomy = register_taxonomy(
+				static::NAME,
+				$this->get_object_types(),
+				$this->get_args()
+			);
+			return ! is_wp_error( $taxonomy );
+		}
+
+		return true;
+	}
+
+	/**
+	 * Sets object types the taxonomy is associated with.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array|string $object_type Object type or array of object types with which the taxonomy should be associated.
+	 */
+	public function set_object_types( $object_type ) {
+		$this->object_types = (array) $object_type;
+	}
+
+	/**
+	 * Gets object types the taxonomy is associated with.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array Object types the taxonomy is associated with.
+	 */
+	public function get_object_types() {
+		return $this->object_types;
+	}
+
+	/**
+	 * Gets taxonomy arguments for this taxonomy object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return array Taxonomy arguments.
+	 */
+	abstract protected function get_args();
+}