SheaDawson\Blocks\Model\Block
Block Subclass this basic Block with your more interesting ones.
- Author: Shea Dawson <shea@silverstripe.com.au>
Synopsis
class Block
extends DataObject
implements
PermissionProvider
{
- // members
- private static string $table_name = 'Block';
- private static array $db = ;
- private static array $many_many = ;
- private static array $belongs_many_many = ;
- private static array $summary_fields = ;
- private static array $searchable_fields = ;
- private static array $default_sort = ;
- private static array $dependencies = ;
- public BlockManager $blockManager;
- protected BlockController $controller;
- // methods
- public void fieldLabels()
- public void getDefaultSearchContext()
- public mixed getTypeForGridfield()
- public void getCMSFields()
- public string forTemplate()
- public string BlockHTML()
- public void onAfterDelete()
- public void onAfterDuplicate()
- public void canView()
- public void canEdit()
- public void canDelete()
- public void canCreate()
- public void canPublish()
- public void providePermissions()
- public void onAfterWrite()
- public void pagesAffectedByChanges()
- public void UsageListAsString()
- public bool isPublished()
- public bool isPublishedNice()
- public DBHTMLText isPublishedIcon()
- public string CSSClasses()
- public Controller getCurrentPage()
- public BlockController getController()
Hierarchy
Extends
- SilverStripe\ORM\DataObject
Implements
- SilverStripe\Security\PermissionProvider
Members
private
- $belongs_many_many — array
- $db — array
- $default_sort — array
- $dependencies — array
- $many_many — array
- $searchable_fields
- $summary_fields
- $table_name
protected
- $controller — SheaDawson\Blocks\Model\BlockController
public
- $blockManager — SheaDawson\Blocks\BlockManager
Methods
public
- BlockHTML()
- CSSClasses() — CSS Classes to apply to block element in template.
- UsageListAsString()
- canCreate()
- canDelete()
- canEdit()
- canPublish()
- canView()
- fieldLabels()
- forTemplate() — Renders this block with appropriate templates looks for templates that match BlockClassName_AreaName falls back to BlockClassName.
- getCMSFields()
- getController()
- getCurrentPage() — Access current page scope from Block templates with $CurrentPage
- getDefaultSearchContext()
- getTypeForGridfield()
- isPublished() — Check if this block has been published.
- isPublishedIcon()
- isPublishedNice() — Check if this block has been published.
- onAfterDelete()
- onAfterDuplicate() — Remove relations onAfterDuplicate.
- onAfterWrite()
- pagesAffectedByChanges() — Get a list of URL's to republish when this block changes if using StaticPublisher module.
- providePermissions()