Pink-Crab / Perique-Registerables

src/Registrar/Taxonomy_Registrar.php

<?php

declare(strict_types=1);

/**
 * Registration Registrar for all custom Taxonomies.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Glynn Quelch <glynn.quelch@gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\Registerables
 */

namespace PinkCrab\Registerables\Registrar;

use Exception;
use PinkCrab\Registerables\Taxonomy;
use PinkCrab\Registerables\Registerable_Hooks;
use PinkCrab\Registerables\Registrar\Registrar;
use PinkCrab\Registerables\Validator\Taxonomy_Validator;
use PinkCrab\Registerables\Registrar\Meta_Data_Registrar;
use PinkCrab\Registerables\Module\Middleware\Registerable;

class Taxonomy_Registrar implements Registrar {

	protected Taxonomy_Validator $validator;
	protected Meta_Data_Registrar $meta_data_registrar;

	public function __construct(
		Taxonomy_Validator $validator,
		Meta_Data_Registrar $meta_data_registrar
	) {
		$this->validator           = $validator;
		$this->meta_data_registrar = $meta_data_registrar;
	}

	/**
	 * Register a taxonomy
	 *
	 * @param \PinkCrab\Registerables\Module\Middleware\Registerable $registerable
	 * @return void
	 */
	public function register( Registerable $registerable ): void {
		/**
 * @var Taxonomy $registerable, Validation call below catches no Post_Type Registerables
*/

		if ( ! $this->validator->validate( $registerable ) ) {
			throw new Exception(
				sprintf(
					'Failed validating taxonomy model(%s) with errors: %s',
					esc_html( get_class( $registerable ) ),
					esc_html( join( ', ', $this->validator->get_errors() ) )
				)
			);
		}

		// Attempt to register the taxonomy.
		try {
			$result = \register_taxonomy(
				$registerable->slug,

Accessing slug on the interface PinkCrab\Registerables\Module\Middleware\Registerable suggest that you code against a concrete implementation. How about adding an instanceof check?

				$registerable->object_type,

Accessing object_type on the interface PinkCrab\Registerables\Module\Middleware\Registerable suggest that you code against a concrete implementation. How about adding an instanceof check?

				/* @phpstan-ignore-next-line */
				$this->compile_args( $registerable )
			);

			if ( is_a( $result, \WP_Error::class ) ) {
				throw new Exception( join( $result->get_error_messages() ) );

The call to join() has too few arguments starting with array.

			}
		} catch ( \Throwable $th ) {
			throw new Exception( esc_html( "Failed to register {$registerable->slug} taxonomy ({$th->getMessage()})" ) );
		}

		// Register any associated meta data.
		$this->register_meta_data( $registerable );
	}

	/**
	 * Registers all meta data for taxonomy.
	 *
	 * @param \PinkCrab\Registerables\Taxonomy $taxonomy
	 * @return void
	 */
	protected function register_meta_data( Taxonomy $taxonomy ): void {

		// Get all meta fields for taxonomy.
		$meta_fields = $taxonomy->meta_data( array() );

		// Attempt to register all Meta for taxonomy.
		try {
			foreach ( $meta_fields as $meta_field ) {
				$this->meta_data_registrar->register_for_term( $meta_field, $taxonomy->slug );
			}
		} catch ( \Throwable $th ) {
			throw new Exception( esc_html( $th->getMessage() ) );
		}
	}

	/**
	 * Compiles the args used to register the taxonomy.
	 *
	 * @param \PinkCrab\Registerables\Taxonomy $taxonomy
	 * @return array<string, string|int|array<string, string>>
	 */
	protected function compile_args( Taxonomy $taxonomy ): array {
		// Create the labels.
		$base_labels = array(
			'name'                  => $taxonomy->plural,
			'singular_name'         => $taxonomy->singular,
			'menu_name'             => \ucfirst( \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'search_items'          => wp_sprintf( _x( 'Search %s', 'Label for searching plural items. Default is ‘Search {taxonomy plural name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'popular_items'         => wp_sprintf( _x( 'Popular %s', 'Label for the popular terms', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'edit_item'             => wp_sprintf( _x( 'Edit %s', 'Label for editing a singular item. Default is ‘Edit {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'view_item'             => wp_sprintf( _x( 'View %s', 'Label for viewing a singular item. Default is ‘View {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'update_item'           => wp_sprintf( _x( 'Update %s', 'Label for editing a singular item. Default is ‘Edit {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'add_new_item'          => wp_sprintf( _x( 'Add New %s', 'Label for adding a new singular item. Default is ‘Add New {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'new_item_name'         => wp_sprintf( _x( 'New %s', 'Label for the new item page title. Default is ‘New {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'not_found'             => wp_sprintf( _x( 'No %s found', 'Label used when no items are found. Default is ‘No {taxonomy plural name} found’.', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'items_list'            => wp_sprintf( _x( '%s list', 'Label for the table hidden heading. Default is ‘{taxonomy plural name} list’.', 'pinkcrab' ), \ucfirst( \esc_attr( $taxonomy->plural ?? '' ) ) ),
			/* translators: %s: Taxonomy plural name */
			'items_list_navigation' => wp_sprintf( _x( '%s list navigation', 'Label for the pagination hidden heading. Default is ‘{taxonomy plural name} list’.', 'pinkcrab' ), \ucfirst( \esc_attr( $taxonomy->plural ?? '' ) ) ),
			/* translators: %s: Taxonomy plural name */
			'all_items'             => wp_sprintf( _x( 'All %s', 'Label for the pagination hidden heading. Default is ‘{taxonomy plural name} list’.', 'pinkcrab' ), \ucfirst( \esc_attr( $taxonomy->plural ?? '' ) ) ),
			'most_used'             => _x( 'Most Used', 'Title for the Most Used tab. Default \'Most Used\'.', 'pinkcrab' ),
			/* translators: %s: Taxonomy plural name */
			'back_to_items'         => wp_sprintf( _x( '← Back to %s', 'Label for the pagination hidden heading. Default is ‘{taxonomy plural name} list’.', 'pinkcrab' ), \ucfirst( \esc_attr( $taxonomy->plural ?? '' ) ) ),
			/* translators: %s: Taxonomy singular name */
			'item_link'             => wp_sprintf( _x( '%s Link', 'Title for a navigation link block variation. Default is ‘{taxonomy singular name} Link’.', 'pinkcrab' ), \ucfirst( \esc_attr( $taxonomy->singular ?? '' ) ) ),
			/* translators: %s: Taxonomy singular name */
			'item_link_description' => wp_sprintf( _x( 'A link to a %s', 'Description for a navigation link block variation. Default is ‘A link to a {taxonomy singular name}’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
		);

		$tag_labels = array(
			/* translators: %s: Taxonomy plural name */
			'separate_items_with_commas' => wp_sprintf( _x( 'Separate %s with commas', 'This label is only used for non-hierarchical taxonomies. Default \'Separate {taxonomy plural name} with commas\', used in the meta box.’.', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'add_or_remove_items'        => wp_sprintf( _x( 'Add or remove %s', 'This label is only used for non-hierarchical taxonomies. Default \'Add or remove {taxonomy plural name}\', used in the meta box when JavaScript is disabled.', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
			/* translators: %s: Taxonomy plural name */
			'choose_from_most_used'      => wp_sprintf( _x( 'Add or remove %s', 'This label is only used on non-hierarchical taxonomies. Default\'Choose from the most used {taxonomy plural name}\', used in the meta box.', 'pinkcrab' ), \esc_attr( $taxonomy->plural ?? '' ) ),
		);

		$hierarchical_labels = array(
			/* translators: %s: Taxonomy singular name */
			'parent_item_colon' => wp_sprintf( _x( 'Parent %s:', 'Label used to prefix parents of hierarchical items. Not used on non-hierarchical taxonomys. Default is ‘Parent {taxonomy plural name}:’.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'parent_item'       => wp_sprintf( _x( 'Parent %s', 'Label for the parent term', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
			/* translators: %s: Taxonomy singular name */
			'filter_by_item'    => wp_sprintf( _x( 'Filter by %s', 'This label is only used for hierarchical taxonomies. Default \'Filter by {taxonomy singular name}\', used in the posts list table.', 'pinkcrab' ), \esc_attr( $taxonomy->singular ?? '' ) ),
		);

		$labels = array_merge(
			$base_labels,
			$taxonomy->hierarchical ? $hierarchical_labels : $tag_labels
		);

		/**
		 * Allow 3rd party plugins to filter the labels also.
		 *
		 * @filter_handle PinkCrab/Registerable/taxonomy_labels
		 * @param array<string, string> $labels
		 * @param Taxonomy $taxonomy
		 * @return array<string, string>
		 */
		$labels = apply_filters( Registerable_Hooks::TAXONOMY_LABELS, $taxonomy->filter_labels( $labels ), $taxonomy );

		// Compose args.
		$args = array(
			'labels'                => $labels,
			'publicly_queryable'    => $taxonomy->publicly_queryable,
			'show_ui'               => $taxonomy->show_ui,
			'show_in_menu'          => $taxonomy->show_in_menu,
			'show_in_nav_menus'     => $taxonomy->public,
			'show_in_rest'          => $taxonomy->show_in_rest,
			'rest_base'             => $taxonomy->rest_base ?? $taxonomy->slug,
			'rest_controller_class' => $taxonomy->rest_controller_class,
			'show_tagcloud'         => $taxonomy->show_tagcloud,
			'show_in_quick_edit'    => $taxonomy->show_in_quick_edit,
			'show_admin_column'     => $taxonomy->show_admin_column,
			'sort'                  => $taxonomy->sort,
			'description'           => $taxonomy->description,
			'rewrite'               => $taxonomy->slug,
			'label'                 => $taxonomy->label ?? $taxonomy->plural,
			'query_var'             => $taxonomy->query_var,
			'hierarchical'          => $taxonomy->hierarchical,
			'update_count_callback' => $taxonomy->update_count_callback ?? '_update_post_term_count',
			'meta_box_cb'           => $taxonomy->meta_box_cb ??
				$taxonomy->hierarchical ? 'post_categories_meta_box' : 'post_tags_meta_box',
			'default_term'          => $taxonomy->default_term,
		);

		// Merge existing capabilities with the new ones.
		$args['capabilities'] = array_merge(
			array(
				'manage_terms' => 'manage_categories',
				'edit_terms'   => 'manage_categories',
				'delete_terms' => 'manage_categories',
				'assign_terms' => 'edit_posts',
			),
			$taxonomy->capabilities ?? array()
		);

		/**
		 * Allow 3rd party plugins to filter this also.
		 *
		 * @filter_handle PinkCrab/Registerable/taxonomy_args
		 * @param array<string, string|bool|int|null|array<string, string>> $args
		 * @param Taxonomy $taxonomy
		 * @return array<string, string|bool|int|null|array<string, string>>
		 */
		/* @phpstan-ignore-next-line, this is due to apply_filters type hints being wrong. */
		return apply_filters( Registerable_Hooks::TAXONOMY_ARGS, $taxonomy->filter_args( $args ), $taxonomy );
	}
}