Begin adding subcomponent structure

Author: kevinfodness

includes/apple-exporter/class-component-factory.php

@@ -8,6 +8,9 @@
 
 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.
@@ -163,39 +166,44 @@ private static function register_component( $shortname, $classname ) {
 	/**
 	 * 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.
-	 * @access public
-	 * @return \Apple_Exporter\Components\Component A component class matching the shortname.
+	 * @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 ) {
+	public static function get_component( $shortname, $html, $parent = null ) {
 
 		$class = self::$components[ $shortname ];
 
 		if ( is_null( $class ) || ! class_exists( $class ) ) {
 			return null;
 		}
 
-		return new $class(
+		$component = new $class(
 			$html,
 			self::$workspace,
 			self::$settings,
 			self::$styles,
 			self::$layouts,
 			null,
-			self::$component_styles
+			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.
-	 * @access public
+	 * @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 ) {
+	public static function get_components_from_node( $node, $parent = null ) {
 		/* phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase */
 		$result = [];
 
@@ -210,25 +218,25 @@ public static function get_components_from_node( $node ) {
 
 			/**
 			 * Did we match several components? If so, a hash is returned. Both the
-			 * body and heading components can returns this, in the case they find
+			 * 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'] );
+					$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 );
+			$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, $node ) );
+				$result = array_merge( $result, self::get_components_from_node( $child, $parent ) );
 			}
 			// Remove all nulls from the array.
 			$result = array_filter( $result );

includes/apple-exporter/components/class-aside.php

@@ -166,7 +166,7 @@ protected function build( $html ) {
 			[
 				'#components#' => array_map(
 					fn ( Component $component ) => $component->to_array(),
-					Component_Factory::get_components_from_node( $element ),
+					Component_Factory::get_components_from_node( $element, $this ),
 				),
 			],
 		);

includes/apple-exporter/components/class-component.php

@@ -144,6 +144,15 @@ abstract class Component {
 	 */
 	protected $layouts;
 
+	/**
+	 * The parent component.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @var ?Component
+	 */
+	protected $parent;
+
 	/**
 	 * The parser to use for this component.
 	 *
@@ -224,6 +233,7 @@ abstract class Component {
 	 * @param \Apple_Exporter\Builders\Component_Layouts     $layouts          Registered layouts.
 	 * @param \Apple_Exporter\Parser                         $parser           The parser in use during this run.
 	 * @param \Apple_Exporter\Builders\Component_Styles      $component_styles Registered text styles.
+	 * @param ?Component                                     $parent           The parent component, if this is a subcomponent.
 	 * @access public
 	 */
 	public function __construct(
@@ -233,7 +243,8 @@ public function __construct(
 		$styles = null,
 		$layouts = null,
 		$parser = null,
-		$component_styles = null
+		$component_styles = null,
+		$parent = null
 	) {
 		// Register specs for this component.
 		$this->register_specs();
@@ -250,6 +261,7 @@ public function __construct(
 		$this->component_styles = $component_styles;
 		$this->layouts          = $layouts;
 		$this->text             = $text;
+		$this->parent           = $parent;
 		$this->json             = null;
 
 		// Negotiate parser.
@@ -535,6 +547,20 @@ protected function register_spec( $name, $label, $spec ) {
 		$this->specs[ $name ] = new Component_Spec( $this->get_component_name(), $name, $label, $spec );
 	}
 
+	/**
+	 * Given a base name corresponding to a componentLayout, componentTextStyle, or componentStyle, returns a subcomponent
+	 * key if this component is a subcomponent, or the base name if it is not.
+	 *
+	 * @param string $name The base name of the componentLayout, componentTextStyle, or componentStyle.
+	 *
+	 * @return string The key for the componentLayout, componentTextStyle, or componentStyle with subcomponent namespacing added if necessary.
+	 */
+	protected function get_component_object_key( $name ) {
+		return $this->parent instanceof Component
+			? sprintf( '%s-subcomponent-%s', $this->parent->get_component_name(), $name )
+			: $name;
+	}
+
 	/**
 	 * Get a spec to use for creating component JSON.
 	 *
@@ -545,6 +571,7 @@ protected function register_spec( $name, $label, $spec ) {
 	 * @since 1.2.4
 	 */
 	protected function get_spec( $spec_name ) {
+		// TODO: Handle parent specs.
 		if ( ! isset( $this->specs[ $spec_name ] ) ) {
 			return null;
 		}
@@ -587,8 +614,8 @@ protected function register_style( $name, $spec_name, $values = [], $property =
 				? $this->workspace->content_id
 				: 0;
 			$json    = $component_spec->substitute_values( $values, $post_id );
-			$this->styles->register_style( $name, $json );
-			$this->set_json( $property, $name );
+			$this->styles->register_style( $this->get_component_object_key( $name ), $json );
+			$this->set_json( $property, $this->get_component_object_key( $name ) );
 		}
 	}
 
@@ -610,8 +637,8 @@ protected function register_component_style( $name, $spec_name, $values = [], $p
 				? $this->workspace->content_id
 				: 0;
 			$json    = $component_spec->substitute_values( $values, $post_id );
-			$this->component_styles->register_style( $name, $json );
-			$this->set_json( $property, $name );
+			$this->component_styles->register_style( $this->get_component_object_key( $name ), $json );
+			$this->set_json( $property, $this->get_component_object_key( $name ) );
 		}
 	}
 
@@ -632,8 +659,8 @@ protected function register_layout( $name, $spec_name, $values = [], $property =
 				? $this->workspace->content_id
 				: 0;
 			$json    = $component_spec->substitute_values( $values, $post_id );
-			$this->layouts->register_layout( $name, $json );
-			$this->set_json( $property, $name );
+			$this->layouts->register_layout( $this->get_component_object_key( $name ), $json );
+			$this->set_json( $property, $this->get_component_object_key( $name ) );
 		}
 	}