class-component-factory.php

<?php
/**
 * Publish to Apple News: \Apple_Exporter\Component_Factory class
 *
 * @package Apple_News
 * @subpackage Apple_Exporter
 */

namespace Apple_Exporter;

use Apple_Exporter\Components\Component;
use DOMElement;

/**
 * This class in in charge of creating components. Manual component
 * instantiation should be avoided, use this instead.
 *
 * @since 0.2.0
 */
class Component_Factory {

	/**
	 * Available components.
	 *
	 * @var array
	 * @access private
	 */
	private static $components = [];

	/**
	 * Current workspace.
	 *
	 * @var Workspace
	 * @access private
	 */
	private static $workspace = null;

	/**
	 * Current settings.
	 *
	 * @var Settings
	 * @access private
	 */
	private static $settings = null;

	/**
	 * Current styles.
	 *
	 * @var \Apple_Exporter\Builders\Component_Text_Styles
	 * @access private
	 */
	private static $styles = null;

	/**
	 * Current component styles.
	 *
	 * @var \Apple_Exporter\Builders\Component_Styles
	 * @access private
	 */
	private static $component_styles = null;

	/**
	 * Current layouts.
	 *
	 * @var \Apple_Exporter\Builders\Component_Layouts
	 * @access private
	 */
	private static $layouts = null;

	/**
	 * Initialize the component factory.
	 *
	 * @param \Apple_Exporter\Workspace                      $workspace        The workspace to use.
	 * @param \Apple_Exporter\Settings                       $settings         The settings to use.
	 * @param \Apple_Exporter\Builders\Component_Text_Styles $styles           The styles to use.
	 * @param \Apple_Exporter\Builders\Component_Layouts     $layouts          The layouts to use.
	 * @param \Apple_Exporter\Builders\Component_Styles      $component_styles The component styles to use.
	 * @access public
	 */
	public static function initialize(
		$workspace = null,
		$settings = null,
		$styles = null,
		$layouts = null,
		$component_styles = null
	) {
		self::$workspace        = $workspace;
		self::$settings         = $settings;
		self::$styles           = $styles;
		self::$layouts          = $layouts;
		self::$component_styles = $component_styles;

		// Order is important. Components are checked in the order they are added.
		self::register_component( 'aside', '\\Apple_Exporter\\Components\\Aside' );
		self::register_component( 'gallery', '\\Apple_Exporter\\Components\\Gallery' );
		self::register_component( 'tweet', '\\Apple_Exporter\\Components\\Tweet' );
		self::register_component( 'facebook', '\\Apple_Exporter\\Components\\Facebook' );
		self::register_component( 'instagram', '\\Apple_Exporter\\Components\\Instagram' );
		self::register_component( 'tiktok', '\\Apple_Exporter\\Components\\TikTok' );
		self::register_component( 'table', '\\Apple_Exporter\\Components\\Table' );
		self::register_component( 'podcast', '\\Apple_Exporter\\Components\\Podcast' );
		self::register_component( 'iframe', '\\Apple_Exporter\\Components\\Embed_Web_Video' );
		self::register_component( 'embed', '\\Apple_Exporter\\Components\\Embed_Generic' );
		self::register_component( 'img', '\\Apple_Exporter\\Components\\Image' );
		self::register_component( 'video', '\\Apple_Exporter\\Components\\Video' );
		self::register_component( 'audio', '\\Apple_Exporter\\Components\\Audio' );
		self::register_component( 'heading', '\\Apple_Exporter\\Components\\Heading' );
		self::register_component( 'blockquote', '\\Apple_Exporter\\Components\\Quote' );
		self::register_component( 'footnotes', '\\Apple_Exporter\\Components\\Footnotes' );
		self::register_component( 'p', '\\Apple_Exporter\\Components\\Body' );
		self::register_component( 'ol', '\\Apple_Exporter\\Components\\Body' );
		self::register_component( 'ul', '\\Apple_Exporter\\Components\\Body' );
		self::register_component( 'pre', '\\Apple_Exporter\\Components\\Body' );
		self::register_component( 'hr', '\\Apple_Exporter\\Components\\Divider' );
		self::register_component( 'button', '\\Apple_Exporter\\Components\\Link_Button' );
		// Non HTML-based components.
		self::register_component( 'intro', '\\Apple_Exporter\\Components\\Intro' );
		self::register_component( 'cover', '\\Apple_Exporter\\Components\\Cover' );
		self::register_component( 'title', '\\Apple_Exporter\\Components\\Title' );
		self::register_component( 'byline', '\\Apple_Exporter\\Components\\Byline' );
		self::register_component( 'author', '\\Apple_Exporter\\Components\\Author' );
		self::register_component( 'date', '\\Apple_Exporter\\Components\\Date' );
		self::register_component( 'slug', '\\Apple_Exporter\\Components\\Slug' );
		self::register_component( 'end-of-article', '\\Apple_Exporter\\Components\\End_Of_Article' );
		self::register_component( 'in-article', '\\Apple_Exporter\\Components\\In_Article' );

		/**
		 * Allows you to add custom component classes to the plugin.
		 *
		 * @param array $components The list of registered component classes.
		 */
		self::$components = apply_filters( 'apple_news_initialize_components', self::$components );
	}

	/**
	 * Get all components
	 *
	 * @return array
	 * @access public
	 */
	public static function get_components() {
		return self::$components;
	}

	/**
	 * Register a component.
	 *
	 * @param string $shortname The short name for the component.
	 * @param string $classname The class name for the component.
	 * @access private
	 */
	private static function register_component( $shortname, $classname ) {
		/**
		 * Allows you to modify a specific component class before it's registered.
		 *
		 * This filter could allow you to replace an existing component class with
		 * your own custom version.
		 *
		 * @param string $classname The PHP class name for the component.
		 * @param string $shortname The internal name used to refer to this component.
		 */
		self::$components[ $shortname ] = apply_filters( 'apple_news_register_component', $classname, $shortname );
	}

	/**
	 * Get a component.
	 *
	 * @param string     $shortname The short name for the component type to use.
	 * @param string     $html      The HTML to be parsed by the component.
	 * @param ?Component $parent    If provided, treats this component as a subcomponent of this parent.
	 *
	 * @return Component A component class matching the shortname.
	 */
	public static function get_component( $shortname, $html, $parent = null ) {

		$class = self::$components[ $shortname ];

		if ( is_null( $class ) || ! class_exists( $class ) ) {
			return null;
		}

		$component = new $class(
			$html,
			self::$workspace,
			self::$settings,
			self::$styles,
			self::$layouts,
			null,
			self::$component_styles,
			$parent
		);

		return $component;
	}

	/**
	 * Given a node, returns an array of all the components inside that node. If
	 * the node is a component itself, returns an array of only one element.
	 *
	 * @param DOMElement $node   The node to be examined.
	 * @param ?Component $parent If provided, treats all components as subcomponents of this parent.
	 *
	 * @return array An array of components contained in the node.
	 */
	public static function get_components_from_node( $node, $parent = null ) {
		/* phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase */
		$result = [];

		foreach ( self::$components as $shortname => $class ) {

			$matched_node = $class::node_matches( $node );

			// Nothing matched? Skip to next match.
			if ( ! $matched_node ) {
				continue;
			}

			/**
			 * Did we match several components? If so, a hash is returned. Both the
			 * body and heading components can return this, in the case they find
			 * non-markdown-able elements inside.
			 */
			if ( is_array( $matched_node ) ) {
				foreach ( $matched_node as $base_component ) {
					$result[] = self::get_component( $base_component['name'], $base_component['value'], $parent );
				}
				return $result;
			}

			// We matched a single node.
			$html     = $node->ownerDocument->saveXML( $matched_node );
			$result[] = self::get_component( $shortname, $html, $parent );
			return $result;
		}
		// Nothing found. Maybe it's a container element?
		if ( $node->hasChildNodes() ) {
			foreach ( $node->childNodes as $child ) {
				$result = array_merge( $result, self::get_components_from_node( $child, $parent ) );
			}
			// Remove all nulls from the array.
			$result = array_filter( $result );
		}

		/**
		 * If nothing was found, log this as a component error by recording the node name.
		 * Only record components with a tagName since otherwise there is nothing to report.
		 * Others nodes without a match are almost always just stray empty text nodes
		 * that are always safe to remove. Paragraphs should also be ignored for this reason.
		 */
		if ( empty( $result ) && ( ! empty( $node->tagName ) && 'p' !== $node->tagName ) ) {
			self::$workspace->log_error( 'component_errors', $node->tagName );
		}

		return $result;
		/* phpcs:enable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase */
	}
}