Yoast\WP\SEO\Schema_Aggregator\Application\Schema_Map

Schema_Map_Xml_Provider{}Yoast 1.0

Provides the schema map XML, building and caching it when needed.

Хуков нет.

Использование

$Schema_Map_Xml_Provider = new Schema_Map_Xml_Provider();
// use class methods

Методы

  1. public __construct(
  2. public get_xml()

Код Schema_Map_Xml_Provider{} Yoast 28.4

class Schema_Map_Xml_Provider {

	/**
	 * The command handler instance.
	 *
	 * @var Aggregate_Site_Schema_Map_Command_Handler
	 */
	private $aggregate_site_schema_map_command_handler;

	/**
	 * The XML cache manager instance.
	 *
	 * @var Xml_Manager
	 */
	private $xml_cache_manager;

	/**
	 * The aggregator configuration instance.
	 *
	 * @var Aggregator_Config
	 */
	private $aggregator_config;

	/**
	 * Schema_Map_Xml_Provider constructor.
	 *
	 * @param Aggregate_Site_Schema_Map_Command_Handler $aggregate_site_schema_map_command_handler The command handler.
	 * @param Xml_Manager                               $xml_cache_manager                         The XML cache
	 *                                                                                             manager.
	 * @param Aggregator_Config                         $aggregator_config                         The aggregator
	 *                                                                                             configuration.
	 */
	public function __construct(
		Aggregate_Site_Schema_Map_Command_Handler $aggregate_site_schema_map_command_handler,
		Xml_Manager $xml_cache_manager,
		Aggregator_Config $aggregator_config
	) {
		$this->aggregate_site_schema_map_command_handler = $aggregate_site_schema_map_command_handler;
		$this->xml_cache_manager                         = $xml_cache_manager;
		$this->aggregator_config                         = $aggregator_config;
	}

	/**
	 * Returns the schema map XML, building and caching it when it is not cached yet.
	 *
	 * @return string The schema map XML.
	 */
	public function get_xml(): string {
		$cached_xml = $this->xml_cache_manager->get();
		if ( $cached_xml !== null ) {
			return $cached_xml;
		}

		$command = new Aggregate_Site_Schema_Map_Command( $this->aggregator_config->get_allowed_post_types() );
		$xml     = $this->aggregate_site_schema_map_command_handler->handle( $command );

		$this->xml_cache_manager->set( $xml );

		return $xml;
	}
}