Merge pull request #11 from hummer2k/feature/remove-block-property

remove blocks via remove property
hummer2k · Oct 17, 2015 · d66ae5c · d66ae5c
2 parents f8c91e2 + 49614d4
commit d66ae5c
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 47 deletions.
diff --git a/docs/layout-instructions.md b/docs/layout-instructions.md
@@ -1,12 +1,11 @@
 # Layout instructions
 
-Currently there are 5 layout instructions:
+Currently there are 4 layout instructions:
 
 1. [`layout`](#1-layout)
 2. [`blocks`](#2-blocks)
-3. [`remove_blocks`](#3-remove_blocks)
-4. [`view_helpers`](#4-view_helpers)
-5. [`include`](#5-include)
+3. [`view_helpers`](#4-view_helpers)
+4. [`include`](#5-include)
 
 ## 1. `layout`
 
@@ -83,12 +82,16 @@ return [
              * if false, wrapper will be disabled: 'wrapper' => false,
              *
              * defaults: tag: 'div', 'template: 'blocks/wrapper'
-             */
+             */             
             'wrapper' => [
                 'template' => 'blocks/wrapper',
                 'class' => 'col-xs-12',
                 'tag' => 'div'
             ],
+            /**
+             * remove this block
+             */
+            'remove' => true,
             // just set a custom template
             'wrapper' => 'my/wrapper',
             // or add more attributes for the wrapper tag

diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -6,8 +6,7 @@ It is assumed that you already have set up a
 [ZendDeveloperTools](https://github.com/zendframework/ZendDeveloperTools) and
 installed the ConLayout module.
 We will cover basic configuration on module-basis and you will get to know the 
-layout instructions `layout`, `blocks`, `remove_blocks` and 
-`include`.
+layout instructions `layout`, `blocks` and `include`.
 
 ## Table of contents
 
@@ -577,7 +576,7 @@ view action.
 
 ## 9. Remove blocks from a specific page
 
-We can remove blocks with the instruction `remove_blocks`
+We can remove blocks with the property `remove`
 
 As an example, we edit our layout update file for the handle 
 `application/index/include`:
@@ -587,8 +586,10 @@ return [
     'include' => [
         'application/index/view' => true
     ],
-    'remove_blocks' => [
-        'latest.articles' => true
+    'blocks' => [
+        'latest.articles' => [
+            'remove' => true
+        ]
     ]
 ];
 ````

diff --git a/src/ConLayout/Layout/Layout.php b/src/ConLayout/Layout/Layout.php
@@ -39,13 +39,6 @@ class Layout implements
      */
     protected $blocksGenerated = false;
 
-    /**
-     * flag if blocks have already been removed from layout structure
-     *
-     * @var bool
-     */
-    protected $blocksRemoved = false;
-
     /**
      *
      * @var LayoutUpdaterInterface
@@ -116,7 +109,7 @@ protected function generateBlocks()
                 $blocks = $blocks->toArray();
             }
             foreach ($blocks as $blockId => $specs) {
-                if ($this->isBlockRemoved($blockId)) {
+                if ($this->isBlockRemoved($blockId, $specs)) {
                     continue;
                 }
                 $block = $this->blockFactory->createBlock($blockId, $specs);
@@ -126,36 +119,21 @@ protected function generateBlocks()
         }
     }
 
-    /**
-     * removes blocks defined in layout instructions
-     */
-    protected function removeBlocksByInstructions()
-    {
-        if (!$this->blocksRemoved) {
-            $removedBlocks = $this->updater->getLayoutStructure()
-                ->get(LayoutUpdaterInterface::INSTRUCTION_REMOVE_BLOCKS, []);
-            if ($removedBlocks instanceof Config) {
-                $removedBlocks = $removedBlocks->toArray();
-                foreach ($removedBlocks as $removedBlockId => $value) {
-                    if ($value) {
-                        $this->removeBlock($removedBlockId);
-                    }
-                }
-            }
-            $this->blocksRemoved = true;
-        }
-    }
-
     /**
      * check if block has been removed
      *
-     * @param   string  $blockId
+     * @param   string $blockId
+     * @param   array  $specs
      * @return  boolean
      */
-    protected function isBlockRemoved($blockId)
+    protected function isBlockRemoved($blockId, array $specs)
     {
-        $this->removeBlocksByInstructions();
-        return isset($this->removedBlocks[$blockId]);
+        if ((isset($specs['remove']) && $specs['remove']) ||
+            isset($this->removedBlocks[$blockId])
+        ) {
+            return true;
+        }
+        return false;
     }
 
     /**

diff --git a/src/ConLayout/Updater/LayoutUpdaterInterface.php b/src/ConLayout/Updater/LayoutUpdaterInterface.php
@@ -13,7 +13,6 @@ interface LayoutUpdaterInterface
 {
     const INSTRUCTION_LAYOUT_TEMPLATE = 'layout';
     const INSTRUCTION_BLOCKS          = 'blocks';
-    const INSTRUCTION_REMOVE_BLOCKS   = 'remove_blocks';
     const INSTRUCTION_VIEW_HELPERS    = 'view_helpers';
     const INSTRUCTION_INCLUDE         = 'include';
 

diff --git a/src/ConLayout/View/Helper/Proxy/HeadLinkProxy.php b/src/ConLayout/View/Helper/Proxy/HeadLinkProxy.php
@@ -7,6 +7,7 @@
 /**
  * @package ConLayout
  * @author Cornelius Adams (conlabz GmbH) <cornelius.adams@conlabz.de>
+ * @codeCoverageIgnore
  */
 class HeadLinkProxy extends AbstractViewHelperProxy
 {

diff --git a/src/ConLayout/View/Helper/Proxy/HeadMetaProxy.php b/src/ConLayout/View/Helper/Proxy/HeadMetaProxy.php
@@ -5,6 +5,7 @@
 /**
  * @package ConLayout
  * @author Cornelius Adams (conlabz GmbH) <cornelius.adams@conlabz.de>
+ * @codeCoverageIgnore
  */
 class HeadMetaProxy extends AbstractViewHelperProxy
 {

diff --git a/src/ConLayout/View/Helper/Proxy/HeadScriptProxy.php b/src/ConLayout/View/Helper/Proxy/HeadScriptProxy.php
@@ -5,6 +5,7 @@
 /**
  * @package ConLayout
  * @author Cornelius Adams (conlabz GmbH) <cornelius.adams@conlabz.de>
+ * @codeCoverageIgnore
  */
 class HeadScriptProxy extends AbstractViewHelperProxy
 {

diff --git a/src/ConLayout/View/Helper/Proxy/HeadTitleProxy.php b/src/ConLayout/View/Helper/Proxy/HeadTitleProxy.php
@@ -5,6 +5,7 @@
 /**
  * @package ConLayout
  * @author Cornelius Adams (conlabz GmbH) <cornelius.adams@conlabz.de>
+ * @codeCoverageIgnore
  */
 class HeadTitleProxy extends AbstractViewHelperProxy
 {

diff --git a/src/ConLayout/View/Helper/Proxy/InlineScriptProxy.php b/src/ConLayout/View/Helper/Proxy/InlineScriptProxy.php
@@ -5,6 +5,7 @@
 /**
  * @package ConLayout
  * @author Cornelius Adams (conlabz GmbH) <cornelius.adams@conlabz.de>
+ * @codeCoverageIgnore
  */
 class InlineScriptProxy extends HeadScriptProxy
 {

diff --git a/tests/ConLayoutTest/Layout/_files/layout-structure.php b/tests/ConLayoutTest/Layout/_files/layout-structure.php
@@ -16,9 +16,8 @@
         'widget.1.child' => [
             'capture_to' => 'widget.1::childHtml'
         ],
-        'some.removed.block' => []
-    ],
-    LayoutUpdaterInterface::INSTRUCTION_REMOVE_BLOCKS => [
-         'some.removed.block' => true
+        'some.removed.block' => [
+            'remove' => true
+        ]
     ]
 ];