BlogFilter
class BlogFilter extends Lumberjack (View source)
This class is responsible for filtering the SiteTree when necessary and also overlaps into filtering only published posts.
Properties
| protected | SS_Object | $owner | The object this extension is applied to. |
from Extension |
| protected | DataObject | $ownerBaseClass | The base class that this extension was applied to; $this->owner must be one of these |
from Extension |
| public | $class | from Extension |
Methods
Called when this extension is added to a particular class
Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().
Update the database schema as required by this extension.
Define extra database fields
This is responsible for adding the child pages tab and gridfield.
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
Hook called before the page's SiteTree::doPublish() action is completed
Hook called after the page's SiteTree::doPublish() action is completed
Hook called before the page's SiteTree::doUnpublish() action is completed
Hook called after the page's SiteTree::doUnpublish() action is completed
Hook called to determine if a user may add children to this SiteTree object
Hook called to modify the $base url of this page, with a given $action, before SiteTree::RelativeLink()} calls {@link Controller::join_links() on the $base and $action
Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.
Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.
Augments (@link Hierarchy::liveChildren()} by hiding excluded child classnames
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(SS_Object $owner, string $ownerBaseClass = null)
Set the owner of this extension.
clearOwner()
No description
SS_Object
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 thats passed to DataObject::$extensions or Object::add_extension().
static
get_extra_config($class, $extension, $args)
No description
static
unload_extra_statics($class, $extension)
No description
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLQuery $query)
Edit the given query object to support queries for this extension
augmentDatabase()
Update the database schema as required by this extension.
When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.
augmentWrite(array $manipulation)
Augment a write-record request.
onBeforeWrite()
No description
onAfterWrite()
No description
onBeforeDelete()
No description
onAfterDelete()
No description
requireDefaultRecords()
No description
populateDefaults()
No description
can($member)
No description
canEdit($member)
No description
canDelete($member)
No description
canCreate($member)
No description
array
extraStatics($class = null, $extension = null)
Define extra database fields
Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.
updateCMSFields(FieldList $fields)
This is responsible for adding the child pages tab and gridfield.
updateFrontEndFields(FieldList $fields)
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
Caution: Use FieldList->push() to add fields.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
updateSummaryFields(array $fields)
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
updateFieldLabels(array $labels)
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
onBeforePublish(SiteTree $original)
Hook called before the page's SiteTree::doPublish() action is completed
onAfterPublish(SiteTree $original)
Hook called after the page's SiteTree::doPublish() action is completed
onBeforeUnpublish()
Hook called before the page's SiteTree::doUnpublish() action is completed
onAfterUnpublish()
Hook called after the page's SiteTree::doUnpublish() action is completed
bool|null
canAddChildren(Member $member)
Hook called to determine if a user may add children to this SiteTree object
bool|null
canPublish(Member $member)
Hook called to determine if a user may publish this SiteTree object
updateRelativeLink(string $base, string|bool $action)
Hook called to modify the $base url of this page, with a given $action, before SiteTree::RelativeLink()} calls {@link Controller::join_links() on the $base and $action
array
getExcludedSiteTreeClassNames()
Loops through subclasses of the owner (intended to be SiteTree) and checks if they've been hidden.
DataList
stageChildren($showAll = false)
Augments (@link Hierarchy::stageChildren()}
protected DataList
excludeSiteTreeClassNames(DataList $list)
Excludes any hidden owner subclasses. Note that the returned DataList will be a different instance from the original.
SS_List
liveChildren(bool $showAll = false, bool $onlyDeletedFromStage = false)
Augments (@link Hierarchy::liveChildren()} by hiding excluded child classnames
protected string
getLumberjackTitle()
This returns the title for the tab and GridField. This can be overwritten in the owner class.
protected GridFieldConfig
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.
DataList
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.
protected bool
subclassForBlog()
No description
protected bool
isBlog()
No description