sheadawson / silverstripe-blocks

src/extensions/BlocksSiteTreeExtension.php

Indentation +317 added lines, -317 removed lines

@@ -27,321 +27,321 @@
  */
 class BlocksSiteTreeExtension extends SiteTreeExtension
 {
-	private static $db = [
-		'InheritBlockSets' => 'Boolean',
-	];
-
-	private static $many_many = [
-		"Blocks" => Block::class,
-		"DisabledBlocks" => Block::class,
-	];
-
-	public static $many_many_extraFields = [
-		'Blocks' => [
-			'Sort' => 'Int',
-			'BlockArea' => 'Varchar',
-		],
-	];
-
-	private static $defaults = [
-		'InheritBlockSets' => 1,
-	];
-
-	private static $dependencies = [
-		'blockManager' => '%$blockManager',
-	];
-
-	public $blockManager;
-
-
-	/**
-	 * Check if the Blocks CMSFields should be displayed for this Page
-	 *
-	 * @return boolean
-	 **/
-	public function showBlocksFields()
-	{
-		$whiteList = $this->blockManager->getWhiteListedPageTypes();
-		$blackList = $this->blockManager->getBlackListedPageTypes();
-
-		if (in_array($this->owner->ClassName, $blackList)) {
-			return false;
-		}
-
-		if (count($whiteList) && !in_array($this->owner->ClassName, $whiteList)) {
-			return false;
-		}
-
-		if (!Permission::check('BLOCK_EDIT')) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Block manager for Pages.
-	 * */
-	public function updateCMSFields(FieldList $fields)
-	{
-		if ($fields->fieldByName('Root.Blocks') || !$this->showBlocksFields()) {
-			return;
-		}
-
-		$areas = $this->blockManager->getAreasForPageType($this->owner->ClassName);
-
-		if ($areas && count($areas)) {
-			$fields->addFieldToTab('Root', new Tab('Blocks', _t('Block.PLURALNAME', 'Blocks')));
-			if (BlockManager::config()->get('block_area_preview')) {
-				$fields->addFieldToTab('Root.Blocks',
-						LiteralField::create('PreviewLink', $this->areasPreviewButton()));
-			}
-
-			// Blocks related directly to this Page
-			$gridConfig = GridFieldConfigBlockManager::create(true, true, true, true)
-				->addExisting($this->owner->class)
-				//->addBulkEditing()
-				// ->addComponent(new GridFieldOrderableRows()) // Comment until below TODO is complete.
-				;
-
-
-			// TODO it seems this sort is not being applied...
-			$gridSource = $this->owner->Blocks();
-				// ->sort(array(
-				// 	"FIELD(SiteTree_Blocks.BlockArea, '" . implode("','", array_keys($areas)) . "')" => '',
-				// 	'SiteTree_Blocks.Sort' => 'ASC',
-				// 	'Name' => 'ASC'
-				// ));
-
-			$fields->addFieldToTab('Root.Blocks', GridField::create('Blocks', _t('Block.PLURALNAME', 'Blocks'), $gridSource, $gridConfig));
-
-
-			// Blocks inherited from BlockSets
-			if ($this->blockManager->getUseBlockSets()) {
-				$inheritedBlocks = $this->getBlocksFromAppliedBlockSets(null, true);
-
-				if ($inheritedBlocks->count()) {
-					$activeInherited = $this->getBlocksFromAppliedBlockSets(null, false);
-
-					if ($activeInherited->count()) {
-						$fields->addFieldsToTab('Root.Blocks', [
-							GridField::create('InheritedBlockList', _t('BlocksSiteTreeExtension.BlocksInheritedFromBlockSets', 'Blocks Inherited from Block Sets'), $activeInherited,
-								GridFieldConfigBlockManager::create(false, false, false)),
-							LiteralField::create('InheritedBlockListTip', "<p class='message'>"._t('BlocksSiteTreeExtension.InheritedBlocksEditLink', 'Tip: Inherited blocks can be edited in the {link_start}Block Admin area{link_end}', '', ['link_start' => '<a href="admin/block-admin">', 'link_end' => '</a>']).'<p>'),
-						]);
-					}
-
-					$fields->addFieldToTab('Root.Blocks',
-							ListboxField::create('DisabledBlocks', _t('BlocksSiteTreeExtension.DisableInheritedBlocks', 'Disable Inherited Blocks'),
-									$inheritedBlocks->map('ID', 'Title'), null, null, true)
-									->setDescription(_t('BlocksSiteTreeExtension.DisableInheritedBlocksDescription', 'Select any inherited blocks that you would not like displayed on this page.'))
-					);
-				} else {
-					$fields->addFieldToTab('Root.Blocks',
-							ReadonlyField::create('DisabledBlocksReadOnly', _t('BlocksSiteTreeExtension.DisableInheritedBlocks', 'Disable Inherited Blocks'),
-									_t('BlocksSiteTreeExtension.NoInheritedBlocksToDisable','This page has no inherited blocks to disable.')));
-				}
-
-				$fields->addFieldToTab('Root.Blocks',
-					CheckboxField::create('InheritBlockSets', _t('BlocksSiteTreeExtension.InheritBlocksFromBlockSets', 'Inherit Blocks from Block Sets')));
-			}
-		}
-	}
-
-	/**
-	 * Called from templates to get rendered blocks for the given area.
-	 *
-	 * @param string $area
-	 * @param int    $limit Limit the items to this number, or null for no limit
-	 */
-	public function BlockArea($area, $limit = null)
-	{
-		if ($this->owner->ID <= 0) {
-			return;
-		} // blocks break on fake pages ie Security/login
-
-		$list = $this->getBlockList($area);
-
-		foreach ($list as $block) {
-			if (!$block->canView()) {
-				$list->remove($block);
-			}
-		}
-
-		if ($limit !== null) {
-			$list = $list->limit($limit);
-		}
-
-		$data = [];
-		$data['HasBlockArea'] = ($this->owner->canEdit() && isset($_REQUEST['block_preview']) && $_REQUEST['block_preview']) || $list->Count() > 0;
-		$data['BlockArea'] = $list;
-		$data['AreaID'] = $area;
-
-		$data = $this->owner->customise($data);
-
-		$template = ['BlockArea_'.$area];
-
-		if (SSViewer::hasTemplate($template)) {
-			return $data->renderWith($template);
-		} else {
-			return $data->renderWith('BlockArea');
-		}
-	}
-
-	public function HasBlockArea($area)
-	{
-		if ($this->owner->canEdit() && isset($_REQUEST['block_preview']) && $_REQUEST['block_preview']) {
-			return true;
-		}
-
-		$list = $this->getBlockList($area);
-
-		foreach ($list as $block) {
-			if (!$block->canView()) {
-				$list->remove($block);
-			}
-		}
-
-		return $list->Count() > 0;
-	}
-
-	/**
-	 * Get a merged list of all blocks on this page and ones inherited from BlockSets.
-	 *
-	 * @param string|null $area            filter by block area
-	 * @param bool        $includeDisabled Include blocks that have been explicitly excluded from this page
-	 *                                     i.e. blocks from block sets added to the "disable inherited blocks" list
-	 *
-	 * @return ArrayList
-	 * */
-	public function getBlockList($area = null, $includeDisabled = false)
-	{
-		$includeSets = $this->blockManager->getUseBlockSets() && $this->owner->InheritBlockSets;
-		$blocks = ArrayList::create();
-
-		// get blocks directly linked to this page
-		$nativeBlocks = $this->owner->Blocks()->sort('Sort');
-		if ($area) {
-			$nativeBlocks = $nativeBlocks->filter('BlockArea', $area);
-		}
-
-		if ($nativeBlocks->count()) {
-			foreach ($nativeBlocks as $block) {
-				$blocks->add($block);
-			}
-		}
-
-		// get blocks from BlockSets
-		if ($includeSets) {
-			$blocksFromSets = $this->getBlocksFromAppliedBlockSets($area, $includeDisabled);
-			if ($blocksFromSets->count()) {
-				// merge set sources
-				foreach ($blocksFromSets as $block) {
-					if (!$blocks->find('ID', $block->ID)) {
-						if ($block->AboveOrBelow == 'Above') {
-							$blocks->unshift($block);
-						} else {
-							$blocks->push($block);
-						}
-					}
-				}
-			}
-		}
-
-		return $blocks;
-	}
-
-	/**
-	 * Get Any BlockSets that apply to this page.
-	 *
-	 * @return ArrayList
-	 * */
-	public function getAppliedSets()
-	{
-		$list = ArrayList::create();
-		if (!$this->owner->InheritBlockSets) {
-			return $list;
-		}
-
-		$sets = BlockSet::get()->where("(PageTypes IS NULL) OR (PageTypes LIKE '%:\"{$this->owner->ClassName}%')");
-		$ancestors = $this->owner->getAncestors()->column('ID');
-
-		foreach ($sets as $set) {
-			$restrictedToParerentIDs = $set->PageParents()->column('ID');
-			if (count($restrictedToParerentIDs)) {
-				// check whether the set should include selected parent, in which case check whether
-				// it was in the restricted parents list. If it's not, or if include parentpage
-				// wasn't selected, we check the ancestors of this page.
-				if ($set->IncludePageParent && in_array($this->owner->ID, $restrictedToParerentIDs)) {
-					$list->add($set);
-				} else {
-					if (count($ancestors)) {
-						foreach ($ancestors as $ancestor) {
-							if (in_array($ancestor, $restrictedToParerentIDs)) {
-								$list->add($set);
-								continue;
-							}
-						}
-					}
-				}
-			} else {
-				$list->add($set);
-			}
-		}
-
-		return $list;
-	}
-
-	/**
-	 * Get all Blocks from BlockSets that apply to this page.
-	 *
-	 * @return ArrayList
-	 * */
-	public function getBlocksFromAppliedBlockSets($area = null, $includeDisabled = false)
-	{
-		$blocks = ArrayList::create();
-		$sets = $this->getAppliedSets();
-
-		if (!$sets->count()) {
-			return $blocks;
-		}
-
-		foreach ($sets as $set) {
-			$setBlocks = $set->Blocks()->sort('Sort DESC');
-
-			if (!$includeDisabled) {
-				$setBlocks = $setBlocks->exclude('ID', $this->owner->DisabledBlocks()->column('ID'));
-			}
-
-			if ($area) {
-				$setBlocks = $setBlocks->filter('BlockArea', $area);
-			}
-
-			$blocks->merge($setBlocks);
-		}
-
-		$blocks->removeDuplicates();
-
-		return $blocks;
-	}
-
-	/**
-	 * Get's the link for a block area preview button.
-	 *
-	 * @return string
-	 * */
-	public function areasPreviewLink()
-	{
-		return Controller::join_links($this->owner->Link(), '?block_preview=1');
-	}
-
-	/**
-	 * Get's html for a block area preview button.
-	 *
-	 * @return string
-	 * */
-	public function areasPreviewButton()
-	{
-		return "<a class='btn btn-primary' style='font-style:normal;' href='".$this->areasPreviewLink()."' target='_blank'>"._t('BlocksSiteTreeExtension.PreviewBlockAreasLink', 'Preview Block Areas for this page').'</a>';
-	}
+    private static $db = [
+        'InheritBlockSets' => 'Boolean',
+    ];
+
+    private static $many_many = [
+        "Blocks" => Block::class,
+        "DisabledBlocks" => Block::class,
+    ];
+
+    public static $many_many_extraFields = [
+        'Blocks' => [
+            'Sort' => 'Int',
+            'BlockArea' => 'Varchar',
+        ],
+    ];
+
+    private static $defaults = [
+        'InheritBlockSets' => 1,
+    ];
+
+    private static $dependencies = [
+        'blockManager' => '%$blockManager',
+    ];
+
+    public $blockManager;
+
+
+    /**
+     * Check if the Blocks CMSFields should be displayed for this Page
+     *
+     * @return boolean
+     **/
+    public function showBlocksFields()
+    {
+        $whiteList = $this->blockManager->getWhiteListedPageTypes();
+        $blackList = $this->blockManager->getBlackListedPageTypes();
+
+        if (in_array($this->owner->ClassName, $blackList)) {
+            return false;
+        }
+
+        if (count($whiteList) && !in_array($this->owner->ClassName, $whiteList)) {
+            return false;
+        }
+
+        if (!Permission::check('BLOCK_EDIT')) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Block manager for Pages.
+     * */
+    public function updateCMSFields(FieldList $fields)
+    {
+        if ($fields->fieldByName('Root.Blocks') || !$this->showBlocksFields()) {
+            return;
+        }
+
+        $areas = $this->blockManager->getAreasForPageType($this->owner->ClassName);
+
+        if ($areas && count($areas)) {
+            $fields->addFieldToTab('Root', new Tab('Blocks', _t('Block.PLURALNAME', 'Blocks')));
+            if (BlockManager::config()->get('block_area_preview')) {
+                $fields->addFieldToTab('Root.Blocks',
+                        LiteralField::create('PreviewLink', $this->areasPreviewButton()));
+            }
+
+            // Blocks related directly to this Page
+            $gridConfig = GridFieldConfigBlockManager::create(true, true, true, true)
+                ->addExisting($this->owner->class)
+                //->addBulkEditing()
+                // ->addComponent(new GridFieldOrderableRows()) // Comment until below TODO is complete.
+                ;
+
+
+            // TODO it seems this sort is not being applied...
+            $gridSource = $this->owner->Blocks();
+                // ->sort(array(
+                // 	"FIELD(SiteTree_Blocks.BlockArea, '" . implode("','", array_keys($areas)) . "')" => '',
+                // 	'SiteTree_Blocks.Sort' => 'ASC',
+                // 	'Name' => 'ASC'
+                // ));
+
+            $fields->addFieldToTab('Root.Blocks', GridField::create('Blocks', _t('Block.PLURALNAME', 'Blocks'), $gridSource, $gridConfig));
+
+
+            // Blocks inherited from BlockSets
+            if ($this->blockManager->getUseBlockSets()) {
+                $inheritedBlocks = $this->getBlocksFromAppliedBlockSets(null, true);
+
+                if ($inheritedBlocks->count()) {
+                    $activeInherited = $this->getBlocksFromAppliedBlockSets(null, false);
+
+                    if ($activeInherited->count()) {
+                        $fields->addFieldsToTab('Root.Blocks', [
+                            GridField::create('InheritedBlockList', _t('BlocksSiteTreeExtension.BlocksInheritedFromBlockSets', 'Blocks Inherited from Block Sets'), $activeInherited,
+                                GridFieldConfigBlockManager::create(false, false, false)),
+                            LiteralField::create('InheritedBlockListTip', "<p class='message'>"._t('BlocksSiteTreeExtension.InheritedBlocksEditLink', 'Tip: Inherited blocks can be edited in the {link_start}Block Admin area{link_end}', '', ['link_start' => '<a href="admin/block-admin">', 'link_end' => '</a>']).'<p>'),
+                        ]);
+                    }
+
+                    $fields->addFieldToTab('Root.Blocks',
+                            ListboxField::create('DisabledBlocks', _t('BlocksSiteTreeExtension.DisableInheritedBlocks', 'Disable Inherited Blocks'),
+                                    $inheritedBlocks->map('ID', 'Title'), null, null, true)
+                                    ->setDescription(_t('BlocksSiteTreeExtension.DisableInheritedBlocksDescription', 'Select any inherited blocks that you would not like displayed on this page.'))
+                    );
+                } else {
+                    $fields->addFieldToTab('Root.Blocks',
+                            ReadonlyField::create('DisabledBlocksReadOnly', _t('BlocksSiteTreeExtension.DisableInheritedBlocks', 'Disable Inherited Blocks'),
+                                    _t('BlocksSiteTreeExtension.NoInheritedBlocksToDisable','This page has no inherited blocks to disable.')));
+                }
+
+                $fields->addFieldToTab('Root.Blocks',
+                    CheckboxField::create('InheritBlockSets', _t('BlocksSiteTreeExtension.InheritBlocksFromBlockSets', 'Inherit Blocks from Block Sets')));
+            }
+        }
+    }
+
+    /**
+     * Called from templates to get rendered blocks for the given area.
+     *
+     * @param string $area
+     * @param int    $limit Limit the items to this number, or null for no limit
+     */
+    public function BlockArea($area, $limit = null)
+    {
+        if ($this->owner->ID <= 0) {
+            return;
+        } // blocks break on fake pages ie Security/login
+
+        $list = $this->getBlockList($area);
+
+        foreach ($list as $block) {
+            if (!$block->canView()) {
+                $list->remove($block);
+            }
+        }
+
+        if ($limit !== null) {
+            $list = $list->limit($limit);
+        }
+
+        $data = [];
+        $data['HasBlockArea'] = ($this->owner->canEdit() && isset($_REQUEST['block_preview']) && $_REQUEST['block_preview']) || $list->Count() > 0;
+        $data['BlockArea'] = $list;
+        $data['AreaID'] = $area;
+
+        $data = $this->owner->customise($data);
+
+        $template = ['BlockArea_'.$area];
+
+        if (SSViewer::hasTemplate($template)) {
+            return $data->renderWith($template);
+        } else {
+            return $data->renderWith('BlockArea');
+        }
+    }
+
+    public function HasBlockArea($area)
+    {
+        if ($this->owner->canEdit() && isset($_REQUEST['block_preview']) && $_REQUEST['block_preview']) {
+            return true;
+        }
+
+        $list = $this->getBlockList($area);
+
+        foreach ($list as $block) {
+            if (!$block->canView()) {
+                $list->remove($block);
+            }
+        }
+
+        return $list->Count() > 0;
+    }
+
+    /**
+     * Get a merged list of all blocks on this page and ones inherited from BlockSets.
+     *
+     * @param string|null $area            filter by block area
+     * @param bool        $includeDisabled Include blocks that have been explicitly excluded from this page
+     *                                     i.e. blocks from block sets added to the "disable inherited blocks" list
+     *
+     * @return ArrayList
+     * */
+    public function getBlockList($area = null, $includeDisabled = false)
+    {
+        $includeSets = $this->blockManager->getUseBlockSets() && $this->owner->InheritBlockSets;
+        $blocks = ArrayList::create();
+
+        // get blocks directly linked to this page
+        $nativeBlocks = $this->owner->Blocks()->sort('Sort');
+        if ($area) {
+            $nativeBlocks = $nativeBlocks->filter('BlockArea', $area);
+        }
+
+        if ($nativeBlocks->count()) {
+            foreach ($nativeBlocks as $block) {
+                $blocks->add($block);
+            }
+        }
+
+        // get blocks from BlockSets
+        if ($includeSets) {
+            $blocksFromSets = $this->getBlocksFromAppliedBlockSets($area, $includeDisabled);
+            if ($blocksFromSets->count()) {
+                // merge set sources
+                foreach ($blocksFromSets as $block) {
+                    if (!$blocks->find('ID', $block->ID)) {
+                        if ($block->AboveOrBelow == 'Above') {
+                            $blocks->unshift($block);
+                        } else {
+                            $blocks->push($block);
+                        }
+                    }
+                }
+            }
+        }
+
+        return $blocks;
+    }
+
+    /**
+     * Get Any BlockSets that apply to this page.
+     *
+     * @return ArrayList
+     * */
+    public function getAppliedSets()
+    {
+        $list = ArrayList::create();
+        if (!$this->owner->InheritBlockSets) {
+            return $list;
+        }
+
+        $sets = BlockSet::get()->where("(PageTypes IS NULL) OR (PageTypes LIKE '%:\"{$this->owner->ClassName}%')");
+        $ancestors = $this->owner->getAncestors()->column('ID');
+
+        foreach ($sets as $set) {
+            $restrictedToParerentIDs = $set->PageParents()->column('ID');
+            if (count($restrictedToParerentIDs)) {
+                // check whether the set should include selected parent, in which case check whether
+                // it was in the restricted parents list. If it's not, or if include parentpage
+                // wasn't selected, we check the ancestors of this page.
+                if ($set->IncludePageParent && in_array($this->owner->ID, $restrictedToParerentIDs)) {
+                    $list->add($set);
+                } else {
+                    if (count($ancestors)) {
+                        foreach ($ancestors as $ancestor) {
+                            if (in_array($ancestor, $restrictedToParerentIDs)) {
+                                $list->add($set);
+                                continue;
+                            }
+                        }
+                    }
+                }
+            } else {
+                $list->add($set);
+            }
+        }
+
+        return $list;
+    }
+
+    /**
+     * Get all Blocks from BlockSets that apply to this page.
+     *
+     * @return ArrayList
+     * */
+    public function getBlocksFromAppliedBlockSets($area = null, $includeDisabled = false)
+    {
+        $blocks = ArrayList::create();
+        $sets = $this->getAppliedSets();
+
+        if (!$sets->count()) {
+            return $blocks;
+        }
+
+        foreach ($sets as $set) {
+            $setBlocks = $set->Blocks()->sort('Sort DESC');
+
+            if (!$includeDisabled) {
+                $setBlocks = $setBlocks->exclude('ID', $this->owner->DisabledBlocks()->column('ID'));
+            }
+
+            if ($area) {
+                $setBlocks = $setBlocks->filter('BlockArea', $area);
+            }
+
+            $blocks->merge($setBlocks);
+        }
+
+        $blocks->removeDuplicates();
+
+        return $blocks;
+    }
+
+    /**
+     * Get's the link for a block area preview button.
+     *
+     * @return string
+     * */
+    public function areasPreviewLink()
+    {
+        return Controller::join_links($this->owner->Link(), '?block_preview=1');
+    }
+
+    /**
+     * Get's html for a block area preview button.
+     *
+     * @return string
+     * */
+    public function areasPreviewButton()
+    {
+        return "<a class='btn btn-primary' style='font-style:normal;' href='".$this->areasPreviewLink()."' target='_blank'>"._t('BlocksSiteTreeExtension.PreviewBlockAreasLink', 'Preview Block Areas for this page').'</a>';
+    }
 }