SilverStripe\Lumberjack\Model\Lumberjack
Class Lumberjack
Add this classes to SiteTree classes which children should be hidden.
- Author: Michael Strong <mstrong@silverstripe.org>
Synopsis
class Lumberjack
extends SiteTreeExtension
{
- // methods
- public array getExcludedSiteTreeClassNames()
- public void updateCMSFields()
- public DataList stageChildren()
- protected DataList excludeSiteTreeClassNames()
- public DataList liveChildren()
- protected string getLumberjackTitle()
- protected GridFieldConfig_Lumberjack getLumberjackGridFieldConfig()
- protected bool shouldFilter()
- public DataList getLumberjackPagesForGridfield()
Hierarchy
Extends
- SilverStripe\CMS\Model\SiteTreeExtension
Methods
protected
- excludeSiteTreeClassNames() — Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.
- getLumberjackGridFieldConfig() — This returns the gird field config for the lumberjack gridfield.
- getLumberjackTitle() — This returns the title for the tab and GridField. This can be overwritten in the owner class.
- shouldFilter() — Checks if we're on a controller where we should filter. ie. Are we loading the SiteTree? NB: This only checks the current controller. See https://github.com/silverstripe/silverstripe-lumberjack/pull/60 for a discussion around this.
public
- getExcludedSiteTreeClassNames() — Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.
- getLumberjackPagesForGridfield() — Returns list of pages for the CMS gridfield
- liveChildren() — Return children in the live site, if it exists.
- stageChildren() — Return children in the stage site.
- updateCMSFields() — This is responsible for adding the child pages tab and gridfield.