sheadawson / silverstripe-blocks

src/BlockManager.php

Unused Use Statements -2 removed lines

@@ -3,11 +3,9 @@
 namespace SheaDawson\Blocks;
 
 use SilverStripe\ORM\ArrayLib;
-use SilverStripe\SiteConfig\SiteConfig;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Forms\FormField;
-use SilverStripe\View\SSViewer;
 use SilverStripe\View\ViewableData;
 
 /**

Indentation +162 added lines, -162 removed lines

@@ -17,187 +17,187 @@
  */
 class BlockManager extends ViewableData
 {
-	/**
-	 * Use default ContentBlock class.
-	 *
-	 * @var bool
-	 **/
-	private static $use_default_blocks = true;
-
-	/**
-	 * Show a block area preview button in CMS
-	 *
-	 * @var bool
-	 **/
-	private static $block_area_preview = true;
-
-	public function __construct()
-	{
-		parent::__construct();
-	}
-
-	/**
-	 * Gets an array of all areas defined for blocks.
-	 *
-	 * @param bool   $keyAsValue
-	 *
-	 * @return array $areas
-	 **/
-	public function getAreas($keyAsValue = true)
-	{
-		$areas = $this->config()->get('areas');
-
-		$areas = $keyAsValue ? ArrayLib::valuekey(array_keys($areas)) : $areas;
-		if (count($areas)) {
-			foreach ($areas as $k => $v) {
-				$areas[$k] = $keyAsValue ? FormField::name_to_label($k) : $v;
-			}
-		}
-
-		return $areas;
-	}
-
-	/**
-	 * Gets an array of all areas defined that are compatible with pages of type $class.
-	 *
-	 * @param string $class
-	 *
-	 * @return array $areas
-	 **/
-	public function getAreasForPageType($class)
-	{
-		$areas = $this->getAreas(false);
-
-		if (!$areas) {
-			return false;
-		}
-
-		foreach ($areas as $area => $config) {
-			if (!is_array($config)) {
-				continue;
-			}
-
-			if (isset($config['except'])) {
-				$except = $config['except'];
-				if (is_array($except)
-					? in_array($class, $except)
-					: $except == $class
-				) {
-					unset($areas[$area]);
-					continue;
-				}
-			}
-
-			if (isset($config['only'])) {
-				$only = $config['only'];
-				if (is_array($only)
-					? !in_array($class, $only)
-					: $only != $class
-				) {
-					unset($areas[$area]);
-					continue;
-				}
-			}
-		}
-
-		if (count($areas)) {
-			foreach ($areas as $k => $v) {
-				$areas[$k] = _t('Block.BlockAreaName.'.$k, FormField::name_to_label($k));
-			}
-
-			return $areas;
-		} else {
-			return $areas;
-		}
-	}
-
-	public function getBlockClasses()
-	{
-		$classes = ArrayLib::valuekey(ClassInfo::subclassesFor("SheaDawson\Blocks\model\Block"));
-		array_shift($classes);
-		foreach ($classes as $k => $v) {
-			$classes[$k] = singleton($k)->singular_name();
-		}
-
-		$config = $this->config()->get('options');
-
-		if (isset($config['use_default_blocks']) && !$config['use_default_blocks']) {
-	        unset($classes['ContentBlock']);
-	    } else if (!$config['use_default_blocks']) {
-	        unset($classes['ContentBlock']);
-	    }
-
-		$disabledArr = Config::inst()->get("BlockManager", 'disabled_blocks') ? Config::inst()->get("BlockManager", 'disabled_blocks') : [];
-		if (isset($config['disabled_blocks'])) {
-		    $disabledArr = array_merge($disabledArr, $config['disabled_blocks']);
-		}
-		if (count($disabledArr)) {
-			foreach ($disabledArr as $k => $v) {
-				unset($classes[$v]);
-			}
-		}
-
-		return $classes;
-	}
-
-	/*
+    /**
+     * Use default ContentBlock class.
+     *
+     * @var bool
+     **/
+    private static $use_default_blocks = true;
+
+    /**
+     * Show a block area preview button in CMS
+     *
+     * @var bool
+     **/
+    private static $block_area_preview = true;
+
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Gets an array of all areas defined for blocks.
+     *
+     * @param bool   $keyAsValue
+     *
+     * @return array $areas
+     **/
+    public function getAreas($keyAsValue = true)
+    {
+        $areas = $this->config()->get('areas');
+
+        $areas = $keyAsValue ? ArrayLib::valuekey(array_keys($areas)) : $areas;
+        if (count($areas)) {
+            foreach ($areas as $k => $v) {
+                $areas[$k] = $keyAsValue ? FormField::name_to_label($k) : $v;
+            }
+        }
+
+        return $areas;
+    }
+
+    /**
+     * Gets an array of all areas defined that are compatible with pages of type $class.
+     *
+     * @param string $class
+     *
+     * @return array $areas
+     **/
+    public function getAreasForPageType($class)
+    {
+        $areas = $this->getAreas(false);
+
+        if (!$areas) {
+            return false;
+        }
+
+        foreach ($areas as $area => $config) {
+            if (!is_array($config)) {
+                continue;
+            }
+
+            if (isset($config['except'])) {
+                $except = $config['except'];
+                if (is_array($except)
+                    ? in_array($class, $except)
+                    : $except == $class
+                ) {
+                    unset($areas[$area]);
+                    continue;
+                }
+            }
+
+            if (isset($config['only'])) {
+                $only = $config['only'];
+                if (is_array($only)
+                    ? !in_array($class, $only)
+                    : $only != $class
+                ) {
+                    unset($areas[$area]);
+                    continue;
+                }
+            }
+        }
+
+        if (count($areas)) {
+            foreach ($areas as $k => $v) {
+                $areas[$k] = _t('Block.BlockAreaName.'.$k, FormField::name_to_label($k));
+            }
+
+            return $areas;
+        } else {
+            return $areas;
+        }
+    }
+
+    public function getBlockClasses()
+    {
+        $classes = ArrayLib::valuekey(ClassInfo::subclassesFor("SheaDawson\Blocks\model\Block"));
+        array_shift($classes);
+        foreach ($classes as $k => $v) {
+            $classes[$k] = singleton($k)->singular_name();
+        }
+
+        $config = $this->config()->get('options');
+
+        if (isset($config['use_default_blocks']) && !$config['use_default_blocks']) {
+            unset($classes['ContentBlock']);
+        } else if (!$config['use_default_blocks']) {
+            unset($classes['ContentBlock']);
+        }
+
+        $disabledArr = Config::inst()->get("BlockManager", 'disabled_blocks') ? Config::inst()->get("BlockManager", 'disabled_blocks') : [];
+        if (isset($config['disabled_blocks'])) {
+            $disabledArr = array_merge($disabledArr, $config['disabled_blocks']);
+        }
+        if (count($disabledArr)) {
+            foreach ($disabledArr as $k => $v) {
+                unset($classes[$v]);
+            }
+        }
+
+        return $classes;
+    }
+
+    /*
 	 * Usage of BlockSets configurable from yaml
 	 */
-	public function getUseBlockSets()
-	{
-		$config = $this->config()->get('options');
+    public function getUseBlockSets()
+    {
+        $config = $this->config()->get('options');
 
-		return isset($config['use_blocksets']) ? $config['use_blocksets'] : true;
-	}
+        return isset($config['use_blocksets']) ? $config['use_blocksets'] : true;
+    }
 
-	/*
+    /*
 	 * Exclusion of blocks from page types defined in yaml
 	 */
-	public function getExcludeFromPageTypes()
-	{
-		$config = $this->config()->get('options');
+    public function getExcludeFromPageTypes()
+    {
+        $config = $this->config()->get('options');
 
-		return isset($config['exclude_from_page_types']) ? $config['exclude_from_page_types'] : [];
-	}
+        return isset($config['exclude_from_page_types']) ? $config['exclude_from_page_types'] : [];
+    }
 
-	/*
+    /*
 	 * getWhiteListedPageTypes optionally configured by the developer
 	 */
-	public function getWhiteListedPageTypes()
-	{
-		$config = $this->config()->get('options');
-		return isset($config['pagetype_whitelist']) ? $config['pagetype_whitelist'] : [];
-	}
+    public function getWhiteListedPageTypes()
+    {
+        $config = $this->config()->get('options');
+        return isset($config['pagetype_whitelist']) ? $config['pagetype_whitelist'] : [];
+    }
 
-	/*
+    /*
 	 * getBlackListedPageTypes optionally configured by the developer
 	 * Includes blacklisted page types defined in the old exclude_from_page_types array
 	 */
-	public function getBlackListedPageTypes()
-	{
-		$config = $this->config()->get('options');
-		$legacy = isset($config['exclude_from_page_types']) ? $config['exclude_from_page_types'] : [];
-		$current = isset($config['pagetype_blacklist']) ? $config['pagetype_blacklist'] : [];
-		return array_merge($legacy, $current);
-	}
-
-	/*
+    public function getBlackListedPageTypes()
+    {
+        $config = $this->config()->get('options');
+        $legacy = isset($config['exclude_from_page_types']) ? $config['exclude_from_page_types'] : [];
+        $current = isset($config['pagetype_blacklist']) ? $config['pagetype_blacklist'] : [];
+        return array_merge($legacy, $current);
+    }
+
+    /*
 	 * Usage of extra css classes configurable from yaml
 	 */
-	public function getUseExtraCSSClasses()
-	{
-		$config = $this->config()->get('options');
+    public function getUseExtraCSSClasses()
+    {
+        $config = $this->config()->get('options');
 
-		return isset($config['use_extra_css_classes']) ? $config['use_extra_css_classes'] : false;
-	}
+        return isset($config['use_extra_css_classes']) ? $config['use_extra_css_classes'] : false;
+    }
 
-	/*
+    /*
 	 * Prefix for the default CSSClasses
 	 */
-	public function getPrefixDefaultCSSClasses()
-	{
-		$config = $this->config()->get('options');
+    public function getPrefixDefaultCSSClasses()
+    {
+        $config = $this->config()->get('options');
 
-		return isset($config['prefix_default_css_classes']) ? $config['prefix_default_css_classes'] : false;
-	}
+        return isset($config['prefix_default_css_classes']) ? $config['prefix_default_css_classes'] : false;
+    }
 }

src/controllers/BlockAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     }
 
     /**
-     * @return Form
+     * @return \SilverStripe\Forms\Form
      **/
     public function getEditForm($id = null, $fields = null)
     {

src/extensions/BlocksSiteTreeExtension.php

Doc Comments +1 added lines

@@ -267,6 +267,7 @@
 	/**
 	 * Get all Blocks from BlockSets that apply to this page.
 	 *
+	 * @param string $area
 	 * @return ArrayList
 	 * */
 	public function getBlocksFromAppliedBlockSets($area = null, $includeDisabled = false)

Unused Use Statements -2 removed lines

@@ -3,7 +3,6 @@ 
 namespace SheaDawson\Blocks\Extensions;
 
 use SheaDawson\Blocks\Model\Block;
-use SheaDawson\Blocks\Model\Blockset;
 use SheaDawson\Blocks\BlockManager;
 use SheaDawson\Blocks\Forms\GridFieldConfigBlockManager;
 use SilverStripe\CMS\Model\SiteTreeExtension;
@@ -18,7 +17,6 @@ 
 use SilverStripe\ORM\ArrayList;
 use SilverStripe\Security\Permission;
 use SilverStripe\Control\Controller;
-use SilverStripeAustralia\GridFieldExtensions\GridFieldOrderableRows;
 
 /**
  * BlocksSiteTreeExtension.

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("(PageTypesValue IS NULL) OR (PageTypesValue 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("(PageTypesValue IS NULL) OR (PageTypesValue 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>';
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
 				} 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.')));
+									_t('BlocksSiteTreeExtension.NoInheritedBlocksToDisable', 'This page has no inherited blocks to disable.')));
 				}
 
 				$fields->addFieldToTab('Root.Blocks',

src/model/Block.php

Doc Comments +4 added lines, -4 removed lines

@@ -126,7 +126,7 @@ 
     protected $controller;
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getTypeForGridfield()
     {
@@ -237,7 +237,7 @@ 
      * looks for templates that match BlockClassName_AreaName
      * falls back to BlockClassName.
      *
-     * @return string
+     * @return DBHTMLText
      **/
     public function forTemplate()
     {
@@ -253,7 +253,7 @@ 
     }
 
     /**
-     * @return string
+     * @return DBHTMLText
      */
     public function BlockHTML()
     {
@@ -428,7 +428,7 @@ 
     /**
      * Check if this block has been published.
      *
-     * @return bool True if this page has been published.
+     * @return string True if this page has been published.
      */
     public function isPublishedNice()
     {

Indentation +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
 class Block extends DataObject implements PermissionProvider
 {
 
-	private static $table_name = 'Block';
+    private static $table_name = 'Block';
 
     /**
      * @var array

Spacing +4 added lines, -4 removed lines

@@ -74,7 +74,7 @@ 
 
     public function fieldLabels($includerelations = true)
     {
-        $labels =  parent::fieldLabels($includerelations);
+        $labels = parent::fieldLabels($includerelations);
 
         $labels = array_merge($labels, [
             'singular_name' => _t('Block.BlockType', 'Block Type'),
@@ -138,7 +138,7 @@ 
         $self = $this;
         $this->beforeUpdateCMSFields(function($fields) use($self) {
             /** @var FieldList $fields */
-            Requirements::add_i18n_javascript(BLOCKS_DIR . '/javascript/lang');
+            Requirements::add_i18n_javascript(BLOCKS_DIR.'/javascript/lang');
 
             // this line is a temporary patch until I can work out why this dependency isn't being
             // loaded in some cases...
@@ -445,9 +445,9 @@ 
     {
         $obj = DBHTMLText::create();
         if ($this->isPublished()) {
-            $obj->setValue('<img src="' . FRAMEWORK_ADMIN_DIR . '/images/alert-good.gif" />');
+            $obj->setValue('<img src="'.FRAMEWORK_ADMIN_DIR.'/images/alert-good.gif" />');
         } else {
-            $obj->setValue('<img src="' . FRAMEWORK_ADMIN_DIR . '/images/alert-bad.gif" />');
+            $obj->setValue('<img src="'.FRAMEWORK_ADMIN_DIR.'/images/alert-bad.gif" />');
         }
         return $obj;
     }

src/model/BlockSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
     /**
      * Returns a list of pages this BlockSet features on.
      *
-     * @return DataList
+     * @return \SilverStripe\ORM\DataList
      */
     public function Pages()
     {

Unused Use Statements -2 removed lines

@@ -2,13 +2,11 @@
 
 namespace SheaDawson\Blocks\Model;
 
-use SheaDawson\Blocks\Forms\GridFieldConfigBlockManager;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\ArrayLib;
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\Security\PermissionProvider;
 use SilverStripe\Security\Permission;
-use SilverStripe\Security\Group;
 use SilverStripe\Forms\TreeMultiselectField;
 use SilverStripe\Forms\CheckboxField;
 use SilverStripe\Forms\HeaderField;

Indentation +2 added lines, -2 removed lines

@@ -89,8 +89,8 @@
         $fields->removeFieldFromTab('Root', 'Blocks');
 
         /**
-        * @todo - change relation editor back to the custom block manager config and fix issues when 'creating' Blocks from a BlockSet.
-		*/
+         * @todo - change relation editor back to the custom block manager config and fix issues when 'creating' Blocks from a BlockSet.
+         */
         $gridConfig = GridFieldConfig_RelationEditor::create();
         $gridConfig->addComponent(new GridFieldOrderableRows('Sort'));
         $gridConfig->addComponent(new GridFieldDeleteAction());

Spacing +4 added lines, -4 removed lines

@@ -78,7 +78,7 @@ 
         $fields->addFieldToTab('Root.Main', MultiValueCheckboxField::create('PageTypes', _t('BlockSet.OnlyApplyToThesePageTypes', 'Only apply to these Page Types:'), $this->pageTypeOptions())
                 ->setDescription(_t('BlockSet.OnlyApplyToThesePageTypesDescription', 'Selected Page Types will inherit this Block Set automatically. Leave all unchecked to apply to all page types.')));
         $fields->addFieldToTab('Root.Main', TreeMultiselectField::create('PageParents', _t('BlockSet.OnlyApplyToChildrenOfThesePages', 'Only apply to children of these Pages:'), 'SilverStripe\\CMS\\Model\\SiteTree'));
-        $fields->addFieldToTab('Root.Main', CheckboxField::create('IncludePageParent', _t('BlockSet.ApplyBlockSetToSelectedPageParentsAsWellAsChildren','Apply block set to selected page parents as well as children')));
+        $fields->addFieldToTab('Root.Main', CheckboxField::create('IncludePageParent', _t('BlockSet.ApplyBlockSetToSelectedPageParentsAsWellAsChildren', 'Apply block set to selected page parents as well as children')));
 
         if (!$this->ID) {
             $fields->addFieldToTab('Root.Main', LiteralField::create('NotSaved', "<p class='message warning'>"._t('BlockSet.YouCanAddBlocksToThisSetOnceYouHaveSavedIt', 'You can add Blocks to this set once you have saved it for the first time').'</p>'));
@@ -168,15 +168,15 @@ 
     {
         return [
             'BLOCKSET_EDIT' => [
-                'name' => _t('BlockSet.EditBlockSet','Edit a Block Set'),
+                'name' => _t('BlockSet.EditBlockSet', 'Edit a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
             'BLOCKSET_DELETE' => [
-                'name' => _t('BlockSet.DeleteBlockSet','Delete a Block Set'),
+                'name' => _t('BlockSet.DeleteBlockSet', 'Delete a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
             'BLOCKSET_CREATE' => [
-                'name' => _t('BlockSet.CreateBlockSet','Create a Block Set'),
+                'name' => _t('BlockSet.CreateBlockSet', 'Create a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
         ];

tests/BlockSetTest.php

Spacing +3 added lines, -3 removed lines

@@ -80,15 +80,15 @@
         $object = singleton(BlockSet::class);
         $expected = [
             'BLOCKSET_EDIT' => [
-                'name' => _t('BlockSet.EditBlockSet','Edit a Block Set'),
+                'name' => _t('BlockSet.EditBlockSet', 'Edit a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
             'BLOCKSET_DELETE' => [
-                'name' => _t('BlockSet.DeleteBlockSet','Delete a Block Set'),
+                'name' => _t('BlockSet.DeleteBlockSet', 'Delete a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
             'BLOCKSET_CREATE' => [
-                'name' => _t('BlockSet.CreateBlockSet','Create a Block Set'),
+                'name' => _t('BlockSet.CreateBlockSet', 'Create a Block Set'),
                 'category' => _t('Block.PermissionCategory', 'Blocks'),
             ],
         ];

src/model/ContentBlock.php

Indentation +10 added lines, -10 removed lines

@@ -4,7 +4,7 @@ 
 
 class ContentBlock extends Block
 {
-	private static $table_name = "ContentBlock";
+    private static $table_name = "ContentBlock";
 
     /**
      * If the singular name is set in a private static $singular_name, it cannot be changed using the translation files
@@ -30,13 +30,13 @@ 
         'Content' => 'HTMLText',
     ];
 
-	public function fieldLabels($includeRelations = true)
-	{
-		return array_merge(
-			parent::fieldLabels($includeRelations),
-			[
-				'Content' => _t('Block.Content', 'Content'),
-			]
-		);
-	}
+    public function fieldLabels($includeRelations = true)
+    {
+        return array_merge(
+            parent::fieldLabels($includeRelations),
+            [
+                'Content' => _t('Block.Content', 'Content'),
+            ]
+        );
+    }
 }

src/forms/GridfieldConfigBlockManager.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
                 'Title' => array('title' => _t('Block.Title', 'Title'), 'field' => 'Silverstripe\\Forms\\ReadonlyField'),
                 'BlockArea' => array(
                     'title' => _t('Block.BlockArea', 'Block Area'),
-                    'callback' => function () use ($areasFieldSource) {
+                    'callback' => function() use ($areasFieldSource) {
                             $areasField = DropdownField::create('BlockArea', 'Block Area', $areasFieldSource);
                             if (count($areasFieldSource) > 1) {
                                 $areasField->setHasEmptyDefault(true);
@@ -68,7 +68,7 @@ 
             if ($aboveOrBelow) {
                 $displayfields['AboveOrBelow'] = array(
                     'title' => _t('GridFieldConfigBlockManager.AboveOrBelow', 'Above or Below'),
-                    'callback' => function () {
+                    'callback' => function() {
                         return DropdownField::create('AboveOrBelow', _t('GridFieldConfigBlockManager.AboveOrBelow', 'Above or Below'), BlockSet::config()->get('above_or_below_options'));
                     },
                 );

src/extensions/BlockSiteConfigExtension.php

Indentation +10 added lines, -10 removed lines

@@ -13,15 +13,15 @@
  */
 class BlockSiteConfigExtension extends DataExtension
 {
-	private static $many_many = [
-		"Blocks" => Block::class,
-	];
+    private static $many_many = [
+        "Blocks" => Block::class,
+    ];
 
-	/**
-	 *
-	 **/
-	public function updateCMSFields(FieldList $fields)
-	{
-		$fields->removeByName('Blocks');
-	}
+    /**
+     *
+     **/
+    public function updateCMSFields(FieldList $fields)
+    {
+        $fields->removeByName('Blocks');
+    }
 }