Better support for all Gutenberg block parameters

Author: Miika Arponen

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
         * `Geniem\ACF\Factory\Block`: A factory for creating ACF Gutenberg blocks with Codifier components.
     + Component rendering functionality implementing the `Geniem\ACF\Interfaces\Renderer` interface.
         * `Geniem\ACF\Renderer\PHP`: Uses PHP files as templates.
+        * `Geniem\ACF\Renderer\Dust`: Uses Dust.js template files.
 
 ## [1.16.0] - 2019-04-17
 

src/Component.php

@@ -39,27 +39,26 @@ abstract class Component implements ComponentInterface {
     protected $title = '';
 
     /**
-     * Getter for the category.
+     * The block category
      *
      * @var string
      */
     protected $category = '';
 
     /**
-     * Getter for the icon.
+     * The block icon. Can hold both the string or array representation.
      *
-     * @var string
+     * @var string|array
      */
     protected $icon = '';
 
     /**
-     * Getter for the keywords.
+     * The block keywords.
      *
      * @var array
      */
     protected $keywords = [];
 
-
     /**
      * Component description, shows to the user
      *
@@ -74,6 +73,40 @@ abstract class Component implements ComponentInterface {
      */
     protected $fields = [];
 
+    /**
+     * Array of post types to restrict this block type to.
+     *
+     * @var array
+     */
+    protected $post_types = [];
+
+    /**
+     * Display mode for the block.
+     *
+     * Options: auto, preview or edit.
+     *
+     * @var string
+     */
+    protected $mode = 'preview';
+
+    /**
+     * The default block alignment.
+     *
+     * Options: left, center, right, wide or full.
+     *
+     * @var string
+     */
+    protected $align = '';
+
+    /**
+     * An array of features for the block to support.
+     *
+     * @see https://wordpress.org/gutenberg/handbook/block-api/
+     *
+     * @var array
+     */
+    protected $supports = [];
+
     /**
      * The renderer for this component.
      *
@@ -156,9 +189,9 @@ public function get_category() : string {
     /**
      * Getter for the icon.
      *
-     * @return string
+     * @return string|array
      */
-    public function get_icon() : string {
+    public function get_icon() {
         return $this->icon;
     }
 
@@ -170,4 +203,40 @@ public function get_icon() : string {
     public function get_keywords() : array {
         return $this->keywords;
     }
+
+    /**
+     * Getter for the post types.
+     *
+     * @return array
+     */
+    public function get_post_types() : array {
+        return $this->post_types;
+    }
+
+    /**
+     * Getter for the display mode.
+     *
+     * @return string
+     */
+    public function get_mode() : string {
+        return $this->mode;
+    }
+
+    /**
+     * Getter for the default block alignment.
+     *
+     * @return string
+     */
+    public function get_align() : string {
+        return $this->align;
+    }
+
+    /**
+     * Getter for the supported features of the block.
+     *
+     * @return array
+     */
+    public function get_supports() : array {
+        return $this->supports;
+    }
 }

src/Factory/Block.php

@@ -81,18 +81,25 @@ protected function register_field_group() {
      * @return array
      */
     protected function register_block() {
+        $args = [
+            'name'            => $this->component->get_name(),
+            'title'           => $this->component->get_title(),
+            'description'     => $this->component->get_description(),
+            'render_callback' => [ $this, 'render' ],
+            'category'        => $this->component->get_category(),
+            'icon'            => $this->component->get_icon(),
+            'keywords'        => $this->component->get_keywords(),
+            'mode'            => $this->component->get_mode(),
+            'align'           => $this->component->get_align(),
+            'supports'        => $this->component->get_supports(),
+        ];
+
+        if ( ! empty( $this->component->get_post_types() ) ) {
+            $args['post_types'] = $this->component->get_post_types();
+        }
+
         // Register the ACF Block.
-        $block = acf_register_block(
-            [
-                'name'            => $this->component->get_name(),
-                'title'           => $this->component->get_title(),
-                'description'     => $this->component->get_description(),
-                'render_callback' => [ $this, 'render' ],
-                'category'        => $this->component->get_category(),
-                'icon'            => $this->component->get_icon(),
-                'keywords'        => $this->component->get_keywords(),
-            ]
-        );
+        $block = acf_register_block( $args );
 
         return $block;
     }