Source: blocks/class-block.php

  1. <?php
  2. /**
  3.  * Abstract block.
  4.  *
  5.  * @package HivePress\Blocks
  6.  */
  8. namespace HivePress\Blocks;
  10. use HivePress\Helpers as hp;
  11. use HivePress\Traits;
  13. // Exit if accessed directly.
  14. defined( 'ABSPATH' ) || exit;
  16. /**
  17.  * Abstract block class.
  18.  */
  19. abstract class Block {
  20. 	use Traits\Mutator;
  21. 	use Traits\Context;
  23. 	use Traits\Meta {
  24. 		set_meta as _set_meta;
  25. 	}
  27. 	/**
  28. 	 * Block arguments.
  29. 	 *
  30. 	 * @var array
  31. 	 */
  32. 	protected $args = [];
  34. 	/**
  35. 	 * Block name.
  36. 	 *
  37. 	 * @var string
  38. 	 */
  39. 	protected $name;
  41. 	/**
  42. 	 * Class initializer.
  43. 	 *
  44. 	 * @param array $meta Class meta values.
  45. 	 */
  46. 	public static function init( $meta = [] ) {
  47. 		$meta = hp\merge_arrays(
  48. 			[
  49. 				'name'     => hp\get_class_name( static::class ),
  50. 				'settings' => [],
  51. 			],
  52. 			$meta
  53. 		);
  55. 		// Filter meta.
  56. 		foreach ( hp\get_class_parents( static::class ) as $class ) {
  58. 			/**
  59. 			 * Filters the block class meta. The class meta stores properties related to the block type rather than a specific block instance. For example, it stores the block settings displayed in the editor. The dynamic part of the hook refers to the block type (e.g. `listings`). You can check the available block types in the `includes/blocks` directory of HivePress.
  60. 			 *
  61. 			 * @hook hivepress/v1/blocks/{block_type}/meta
  62. 			 * @param {array} $meta Class meta values.
  63. 			 * @return {array} Class meta values.
  64. 			 */
  65. 			$meta = apply_filters( 'hivepress/v1/blocks/' . hp\get_class_name( $class ) . '/meta', $meta );
  66. 		}
  68. 		// Set meta.
  69. 		static::set_meta( $meta );
  70. 	}
  72. 	/**
  73. 	 * Class constructor.
  74. 	 *
  75. 	 * @param array $args Block arguments.
  76. 	 */
  77. 	public function __construct( $args = [] ) {
  79. 		// Filter properties.
  80. 		foreach ( hp\get_class_parents( static::class ) as $class ) {
  82. 			/**
  83. 			 * Filters the block properties. The dynamic part of the hook refers to the block type (e.g. `listings`). You can check the available block types in the `includes/blocks` directory of HivePress.
  84. 			 *
  85. 			 * @hook hivepress/v1/blocks/{block_type}
  86. 			 * @param {array} $props Block properties.
  87. 			 * @param {object} $block Block object.
  88. 			 * @return {array} Block properties.
  89. 			 */
  90. 			$args = apply_filters( 'hivepress/v1/blocks/' . hp\get_class_name( $class ), $args, $this );
  91. 		}
  93. 		// Set arguments.
  94. 		$this->args = $args;
  96. 		// Set properties.
  97. 		foreach ( $args as $name => $value ) {
  98. 			$this->set_property( $name, $value );
  99. 		}
  101. 		// Bootstrap properties.
  102. 		$this->boot();
  103. 	}
  105. 	/**
  106. 	 * Bootstraps block properties.
  107. 	 */
  108. 	protected function boot() {}
  110. 	/**
  111. 	 * Sets class meta values.
  112. 	 *
  113. 	 * @param array $meta Meta values.
  114. 	 */
  115. 	final protected static function set_meta( $meta ) {
  117. 		// Set settings.
  118. 		$settings = array_filter( hp\get_array_value( $meta, 'settings', [] ) );
  120. 		if ( $settings ) {
  121. 			$meta['settings'] = [];
  123. 			foreach ( hp\sort_array( $settings ) as $name => $args ) {
  125. 				// Create field.
  126. 				$field = hp\create_class_instance( '\HivePress\Fields\\' . $args['type'], [ array_merge( $args, [ 'name' => $name ] ) ] );
  128. 				// Add field.
  129. 				if ( $field ) {
  130. 					$meta['settings'][ $name ] = $field;
  131. 				}
  132. 			}
  133. 		}
  135. 		static::_set_meta( $meta );
  136. 	}
  138. 	/**
  139. 	 * Sets object context value.
  140. 	 *
  141. 	 * @param string $name Context name.
  142. 	 * @param mixed  $value Context value.
  143. 	 */
  144. 	final protected function set_context( $name, $value = null ) {
  145. 		if ( is_array( $name ) ) {
  146. 			$this->context = $name;
  148. 			// @todo remove when optimized globally.
  149. 			unset( $this->args['context'] );
  150. 		} else {
  151. 			$this->context[ $name ] = $value;
  152. 		}
  153. 	}
  155. 	/**
  156. 	 * Get block arguments.
  157. 	 *
  158. 	 * @return array
  159. 	 */
  160. 	final public function get_args() {
  161. 		return $this->args;
  162. 	}
  164. 	/**
  165. 	 * Gets block argument.
  166. 	 *
  167. 	 * @param string $name Argument name.
  168. 	 * @return mixed
  169. 	 */
  170. 	final public function get_arg( $name ) {
  171. 		return hp\get_array_value( $this->args, $name );
  172. 	}
  174. 	/**
  175. 	 * Renders block HTML.
  176. 	 *
  177. 	 * @return string
  178. 	 */
  179. 	abstract public function render();
  180. }