Source: templates/class-template.php

  1. <?php
  2. /**
  3.  * Abstract template.
  4.  *
  5.  * @package HivePress\Templates
  6.  */
  8. namespace HivePress\Templates;
  10. use HivePress\Helpers as hp;
  11. use HivePress\Traits;
  13. // Exit if accessed directly.
  14. defined( 'ABSPATH' ) || exit;
  16. /**
  17.  * Abstract template class.
  18.  */
  19. abstract class Template {
  20. 	use Traits\Mutator;
  21. 	use Traits\Meta;
  22. 	use Traits\Context;
  24. 	/**
  25. 	 * Template blocks.
  26. 	 *
  27. 	 * @var array
  28. 	 */
  29. 	protected $blocks = [];
  31. 	/**
  32. 	 * Template attributes.
  33. 	 *
  34. 	 * @var array
  35. 	 */
  36. 	protected $attributes = [];
  38. 	/**
  39. 	 * Class initializer.
  40. 	 *
  41. 	 * @param array $meta Class meta values.
  42. 	 */
  43. 	public static function init( $meta = [] ) {
  44. 		$meta = hp\merge_arrays(
  45. 			[
  46. 				'name' => hp\get_class_name( static::class ),
  47. 			],
  48. 			$meta
  49. 		);
  51. 		// Filter meta.
  52. 		foreach ( hp\get_class_parents( static::class ) as $class ) {
  54. 			/**
  55. 			 * Filters the template class meta. The class meta stores properties related to the template type rather than a specific template instance. The dynamic part of the hook refers to the template name (e.g. `listing_view_page`). You can check the available templates in the `includes/templates` directory of HivePress.
  56. 			 *
  57. 			 * @hook hivepress/v1/templates/{template_name}/meta
  58. 			 * @param {array} $meta Class meta values.
  59. 			 * @return {array} Class meta values.
  60. 			 */
  61. 			$meta = apply_filters( 'hivepress/v1/templates/' . hp\get_class_name( $class ) . '/meta', $meta );
  62. 		}
  64. 		// Set meta.
  65. 		static::set_meta( $meta );
  66. 	}
  68. 	/**
  69. 	 * Class constructor.
  70. 	 *
  71. 	 * @param array $args Template arguments.
  72. 	 */
  73. 	public function __construct( $args = [] ) {
  75. 		// Filter properties.
  76. 		foreach ( hp\get_class_parents( static::class ) as $class ) {
  78. 			/**
  79. 			 * Filters the template properties. The dynamic part of the hook refers to the template name (e.g. `listing_view_page`). You can check the available templates in the `includes/templates` directory of HivePress.
  80. 			 *
  81. 			 * @hook hivepress/v1/templates/{template_name}
  82. 			 * @param {array} $props Template properties.
  83. 			 * @param {object} $template Template object.
  84. 			 * @return {array} Template properties.
  85. 			 */
  86. 			$args = apply_filters( 'hivepress/v1/templates/' . hp\get_class_name( $class ), $args, $this );
  87. 		}
  89. 		// Set properties.
  90. 		foreach ( $args as $name => $value ) {
  91. 			$this->set_property( $name, $value );
  92. 		}
  94. 		// Bootstrap properties.
  95. 		$this->boot();
  96. 	}
  98. 	/**
  99. 	 * Bootstraps template properties.
  100. 	 */
  101. 	protected function boot() {
  103. 		// Filter blocks.
  104. 		foreach ( hp\get_class_parents( static::class ) as $class ) {
  106. 			/**
  107. 			 * Filters template blocks. At the time of this hook the template context is already available. The dynamic part of the hook refers to the template name (e.g. `listing_view_page`). You can check the available templates in the `includes/templates` directory of HivePress.
  108. 			 *
  109. 			 * @hook hivepress/v1/templates/{template_name}/blocks
  110. 			 * @param {array} $blocks Template blocks.
  111. 			 * @param {object} $template Template object.
  112. 			 * @return {array} Template blocks.
  113. 			 */
  114. 			$this->blocks = apply_filters( 'hivepress/v1/templates/' . hp\get_class_name( $class ) . '/blocks', $this->blocks, $this );
  115. 		}
  116. 	}
  118. 	/**
  119. 	 * Gets template blocks.
  120. 	 *
  121. 	 * @return array
  122. 	 */
  123. 	final public function get_blocks() {
  124. 		return $this->blocks;
  125. 	}
  127. 	/**
  128. 	 * Gets template attributes.
  129. 	 *
  130. 	 * @return array
  131. 	 */
  132. 	final public function get_attributes() {
  133. 		return $this->attributes;
  134. 	}
  136. 	/**
  137. 	 * Sets object context value.
  138. 	 *
  139. 	 * @param string $name Context name.
  140. 	 * @param mixed  $value Context value.
  141. 	 */
  142. 	final public function set_context( $name, $value = null ) {
  143. 		if ( is_array( $name ) ) {
  144. 			$this->context = $name;
  145. 		} else {
  146. 			$this->context[ $name ] = $value;
  147. 		}
  148. 	}
  149. }