TypeRegistry.php

<?php
/**
 * Registers Plugin types to the GraphQL schema.
 *
 * @package WPGraphQL\RankMath
 */

declare( strict_types = 1 );

namespace WPGraphQL\RankMath;

use Exception;
use WPGraphQL\RankMath\Fields;
use WPGraphQL\RankMath\Modules\Redirection\TypeRegistry as RedirectionTypeRegistry;
use WPGraphQL\RankMath\Type\Enum;
use WPGraphQL\RankMath\Type\WPInterface;
use WPGraphQL\RankMath\Type\WPObject;
use WPGraphQL\RankMath\Vendor\AxeWP\GraphQL\Interfaces\Registrable;

/**
 * Class - TypeRegistry
 */
class TypeRegistry {
	/**
	 * The local registry of registered types.
	 *
	 * @var string[]
	 */
	public static array $registry = [];

	/**
	 * Gets an array of all the registered GraphQL types along with their class name.
	 *
	 * @return string[]
	 */
	public static function get_registered_types(): array {
		if ( empty( self::$registry ) ) {
			self::initialize_registry();
		}

		return self::$registry;
	}

	/**
	 * Registers types, connections, unions, and mutations to GraphQL schema.
	 */
	public static function init(): void {
		/**
		 * Fires before all types have been registered.
		 */
		do_action( 'graphql_seo_before_register_types' );

		// Register individual modules.
		RedirectionTypeRegistry::init();

		// Initialize the registry.
		self::initialize_registry();

		/**
		 * Fires after all types have been registered.
		 */
		do_action( 'graphql_seo_after_register_types' );
	}

	/**
	 * Initializes the plugin type registry.
	 */
	private static function initialize_registry(): void {
		$classes_to_register = array_merge(
			self::enums(),
			self::inputs(),
			self::interfaces(),
			self::objects(),
			self::connections(),
			self::mutations(),
			self::fields(),
		);

		self::register_types( $classes_to_register );
	}

	/**
	 * List of Enum classes to register.
	 *
	 * @return string[]
	 */
	private static function enums(): array {
		// Enums to register.
		$classes_to_register = [
			Enum\ArticleTypeEnum::class,
			Enum\BulkEditingTypeEnum::class,
			Enum\ImagePreviewSizeEnum::class,
			Enum\KnowledgeGraphTypeEnum::class,
			Enum\OpenGraphLocaleEnum::class,
			Enum\OpenGraphProductAvailabilityEnum::class,
			Enum\RobotsMetaValueEnum::class,
			Enum\SeoScorePositionEnum::class,
			Enum\SeoScoreTemplateTypeEnum::class,
			Enum\SeoRatingEnum::class,
			Enum\SnippetTypeEnum::class,
			Enum\TwitterCardTypeEnum::class,
		];

		/**
		 * Filters the list of enum classes to register.
		 *
		 * Useful for adding/removing specific enums to the schema.
		 *
		 * @param array           $classes_to_register Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_enum_classes', $classes_to_register );
	}

	/**
	 * List of Input classes to register.
	 *
	 * @return string[]
	 */
	private static function inputs(): array {
		$classes_to_register = [];

		/**
		 * Filters the list of input classes to register.
		 *
		 * Useful for adding/removing specific inputs to the schema.
		 *
		 * @param array           $classes_to_register Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_input_classes', $classes_to_register );
	}

	/**
	 * List of Interface classes to register.
	 *
	 * @return string[]
	 */
	public static function interfaces(): array {
		$classes_to_register = [
			WPInterface\MetaSettingWithArchive::class,
			WPInterface\MetaSettingWithRobots::class,
			WPInterface\Seo::class,
			WPInterface\ContentNodeSeo::class,
			WPInterface\NodeWithSeo::class,
		];

		/**
		 * Filters the list of interfaces classes to register.
		 *
		 * Useful for adding/removing specific interfaces to the schema.
		 *
		 * @param array           $classes_to_register = Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_interface_classes', $classes_to_register );
	}

	/**
	 * List of Object classes to register.
	 *
	 * @return string[]
	 */
	public static function objects(): array {
		$classes_to_register = [
			WPObject\AdvancedRobotsMeta::class,
			WPObject\SeoScore::class,
			WPObject\JsonLd::class,
			WPObject\Breadcrumbs::class,

			// Open Graph.
			WPObject\OpenGraph\Article::class,
			WPObject\OpenGraph\Facebook::class,
			WPObject\OpenGraph\Image::class,
			WPObject\OpenGraph\Product::class,
			WPObject\OpenGraph\SlackEnhancedData::class,
			WPObject\OpenGraph\TwitterApp::class,
			WPObject\OpenGraph\Twitter::class,
			WPObject\OpenGraph\Video::class,
			WPObject\OpenGraphMeta::class,

			// General settings.
			WPObject\Settings\General\BreadcrumbsConfig::class,
			WPObject\Settings\General\FrontendSeoScore::class,
			WPObject\Settings\General\Links::class,
			WPObject\Settings\General\Webmaster::class,
			WPObject\Settings\General::class,
			// Meta settings.
			WPObject\Settings\Meta\AuthorArchiveMeta::class,
			WPObject\Settings\Meta\ContentTypeMeta::class,
			WPObject\Settings\Meta\DateArchiveMeta::class,
			WPObject\Settings\Meta\GlobalMeta::class,
			WPObject\Settings\Meta\HomepageMeta::class,
			WPObject\Settings\Meta\LocalMeta::class,
			WPObject\Settings\Meta\SocialMeta::class,
			WPObject\Settings\Meta\TaxonomyMeta::class,
			WPObject\Settings\Meta::class,
			// Sitemap settings.
			WPObject\Settings\Sitemap\Author::class,
			WPObject\Settings\Sitemap\ContentType::class,
			WPObject\Settings\Sitemap\General::class,
			WPObject\Settings\Sitemap\Taxonomy::class,
			WPObject\Settings\Sitemap::class,

			// Settings.
			WPObject\Settings::class,

			// The individual SEO objects.
			WPObject\SeoObjects::class,
		];

		/**
		 * Filters the list of object classes to register.
		 *
		 * Useful for adding/removing specific objects to the schema.
		 *
		 * @param array           $classes_to_register = Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_object_classes', $classes_to_register );
	}

	/**
	 * List of Field classes to register.
	 *
	 * @return string[]
	 */
	public static function fields(): array {
		$classes_to_register = [
			Fields\RootQuery::class,
		];

		/**
		 * Filters the list of field classes to register.
		 *
		 * Useful for adding/removing specific fields to the schema.
		 *
		 * @param array           $classes_to_register = Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_field_classes', $classes_to_register );
	}

	/**
	 * List of Connection classes to register.
	 *
	 * @return string[]
	 */
	public static function connections(): array {
		$classes_to_register = [];

		/**
		 * Filters the list of connection classes to register.
		 *
		 * Useful for adding/removing specific connections to the schema.
		 *
		 * @param array           $classes_to_register = Array of classes to be registered to the schema.
		 */
		return apply_filters( 'graphql_seo_registered_connection_classes', $classes_to_register );
	}

	/**
	 * Registers mutation.
	 *
	 * @return string[]
	 */
	public static function mutations(): array {
		$classes_to_register = [];

		/**
		 * Filters the list of connection classes to register.
		 *
		 * Useful for adding/removing specific connections to the schema.
		 *
		 * @param array           $classes_to_register = Array of classes to be registered to the schema.
		 */
		$classes_to_register = apply_filters( 'graphql_seo_registered_mutation_classes', $classes_to_register );

		return $classes_to_register;
	}

	/**
	 * Loops through a list of classes to manually register each GraphQL to the registry, and stores the type name and class in the local registry.
	 *
	 * Classes must extend WPGraphQL\Type\AbstractType.
	 *
	 * @param string[] $classes_to_register .
	 *
	 * @throws \Exception .
	 */
	private static function register_types( array $classes_to_register ): void {
		// Bail if there are no classes to register.
		if ( empty( $classes_to_register ) ) {
			return;
		}

		foreach ( $classes_to_register as $class ) {
			if ( ! is_a( $class, Registrable::class, true ) ) {
				// translators: PHP class.
				throw new Exception( sprintf( esc_html__( 'To be registered to the WPGraphQL Plugin Name GraphQL schema, %s needs to implement WPGraphQL\RankMath\Vendor\AxeWP\GraphQL\Interfaces\Registrable.', 'wp-graphql-rank-math' ), esc_html( $class ) ) );
			}

			// Register the type to the GraphQL schema.
			$class::init();
			// Store the type in the local registry.
			self::$registry[] = $class;
		}
	}
}