Lumberjack
class Lumberjack extends Extension (View source)
Class Lumberjack
Add this classes to SiteTree classes which children should be hidden.
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.
This is responsible for adding the child pages tab and gridfield.
Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.
Return children in the live site, if it exists.
This returns the title for the tab and GridField. This can be overwritten in the owner class.
This returns the gird field config for the lumberjack gridfield.
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.
Returns list of pages for the CMS gridfield
Details
__construct()
No description
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
array
getExcludedSiteTreeClassNames()
Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.
protected
updateCMSFields(FieldList $fields)
This is responsible for adding the child pages tab and gridfield.
SiteTree>
stageChildren(bool $showAll = false)
Return children in the stage site.
protected SiteTree>
excludeSiteTreeClassNames(DataList $list)
Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.
SiteTree>
liveChildren(bool $showAll = false, bool $onlyDeletedFromStage = false)
Return children in the live site, if it exists.
protected string
getLumberjackTitle()
This returns the title for the tab and GridField. This can be overwritten in the owner class.
protected GridFieldConfig_Lumberjack
getLumberjackGridFieldConfig()
This returns the gird field config for the lumberjack gridfield.
protected bool
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.
SiteTree>
getLumberjackPagesForGridfield($excluded = array())
Returns list of pages for the CMS gridfield
This also allows the owner class to override this method, e.g. to provide custom ordering.