class SiteTreeExtension extends SiteTreeExtension (View source)

deprecated 5.4.0 Will be replaced with DNADesign\Elemental\Extensions\TopPageSiteTreeExtension

Class SiteTreeExtension

This extension must be present on pagetypes that need to support Elemental TopPage functionality. It can be applied directly to Page, as it only takes effect in the presence of a ElementalArea.

Properties

protected T $owner

The object this extension is applied to.

from  Extension
protected array $duplicatedPages

List of pages currently undergoing duplication

protected array $duplicatedObjects

List of objects that need to udate their top page reference

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

public 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().

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

public
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

Extend the owner's onBeforeWrite() logic

public
onAfterWrite()

Extension point in DataObject::onAfterWrite()

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

Extend the owner's populateDefaults() logic

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
bool|null
can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
bool|null
canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

public
updateCMSFields(FieldList $fields)

This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

public
updateFrontEndFields(FieldList $fields)

This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()

public
updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

public
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']

public
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']

public
onBeforePublish(SiteTree $original)

Hook called before the page's Versioned::publishSingle() action is completed

public
onAfterPublish(SiteTree $original)

Hook called after the page's Versioned::publishSingle() action is completed

public
onBeforeUnpublish()

Hook called before the page's Versioned::doUnpublish() action is completed

public
onAfterUnpublish()

Hook called after the page's SiteTree::doUnpublish() action is completed

public
bool|null
canAddChildren(Member $member)

Hook called to determine if a user may add children to this SiteTree object

public
bool|null
canPublish(Member $member)

Hook called to determine if a user may publish this SiteTree object

public
updateRelativeLink(string $link, 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

public
void
onBeforeDuplicate(SiteTree $original)

Extension point in DataObject::duplicate()

public
void
onAfterDuplicate(SiteTree $original, bool $doWrite)

Extension point in DataObject::duplicate()

public
string|null
getDuplicationKey()

Generates a unique key for the page

public
void
addDuplicatedObject(DataObject $object)

Registers the given object to receive an updated TopPage reference after the duplication operation completes, ensuring the new Page is written to the database beforehand.

protected
string|null
getDuplicatedPageKey()

Find currently duplicated page note: this doesn't change any stored data

protected
void
initDuplication(SiteTree $original)

No description

protected
void
processDuplication(SiteTree $original, bool $written)

Update top page reference during duplication process

protected
void
processDuplicationFromOriginal()

Relevant only for duplicated object that were not written at the time of duplication

protected
void
writeDuplication(SiteTree $original)

No description

protected
void
setTopPageForElementalArea()

Elemental area is created before related page is written so we have to set top page explicitly after page is written and the relations are available

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

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

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().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

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.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

Extend the owner's onBeforeWrite() logic

See DataObject::onBeforeWrite() for context.

onAfterWrite()

Extension point in DataObject::onAfterWrite()

Exceptions

ValidationException

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

populateDefaults()

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

onAfterBuild()

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

bool|null can(Member $member)

Influence the owner's can() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::can()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canEdit(Member $member)

Influence the owner's canEdit() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canEdit()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() permission check value to be disallowed (false), allowed (true) if no other processed results are to disallow, or open (null) to not affect the outcome.

See DataObject::canCreate()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

array extraStatics(string $class = null, string $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.

Parameters

string $class

since this method might be called on the class directly

string $extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.

updateCMSFields(FieldList $fields)

This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().

Please consider using updateFormFields() to globally add formfields to the record. The method updateCMSFields() should just be used to add or modify tabs, or fields which are specific to the CMS-context.

Caution: Use FieldList->addFieldToTab() to add fields.

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

This function is used to provide modifications to the Validators used on a DataObject.

Caution: Use CompositeValidator->addValidator() to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

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.

Parameters

FieldList $fields

FieldList without TabSet nesting

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().

Parameters

FieldList $actions FieldList

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']

Parameters

array $fields

Array of field names

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']

Parameters

array $labels

Array of field labels

onBeforePublish(SiteTree $original)

Hook called before the page's Versioned::publishSingle() action is completed

Parameters

SiteTree $original

The current Live SiteTree record prior to publish

onAfterPublish(SiteTree $original)

Hook called after the page's Versioned::publishSingle() action is completed

Parameters

SiteTree $original

The current Live SiteTree record prior to publish

onBeforeUnpublish()

Hook called before the page's Versioned::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

Parameters

Member $member

The member to check permission against, or the currently logged in user

Return Value

bool|null

Return false to deny rights, or null to yield to default

See also

SiteTree::canAddChildren

bool|null canPublish(Member $member)

Hook called to determine if a user may publish this SiteTree object

Parameters

Member $member

The member to check permission against, or the currently logged in user

Return Value

bool|null

Return false to deny rights, or null to yield to default

See also

SiteTree::canPublish

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

Parameters

string $link

The URL of this page relative to siteroot including the action

string $base

The URL of this page relative to siteroot, not including the action

string|bool $action

The action or subpage called on this page. (Legacy support) If this is true, then do not reduce the 'home' urlsegment to an empty link

void onBeforeDuplicate(SiteTree $original)

Extension point in DataObject::duplicate()

Parameters

SiteTree $original

Return Value

void

void onAfterDuplicate(SiteTree $original, bool $doWrite)

Extension point in DataObject::duplicate()

Parameters

SiteTree $original
bool $doWrite

Return Value

void

Exceptions

ValidationException

string|null getDuplicationKey()

Generates a unique key for the page

Return Value

string|null

void addDuplicatedObject(DataObject $object)

Registers the given object to receive an updated TopPage reference after the duplication operation completes, ensuring the new Page is written to the database beforehand.

The registry uses a stack-like structure to allow accurate tracking of objects during duplication operations that include nested pages.

Parameters

DataObject $object

Return Value

void

protected string|null getDuplicatedPageKey()

Find currently duplicated page note: this doesn't change any stored data

Return Value

string|null

protected void initDuplication(SiteTree $original)

No description

Parameters

SiteTree $original

Return Value

void

protected void processDuplication(SiteTree $original, bool $written)

Update top page reference during duplication process

Parameters

SiteTree $original
bool $written

Return Value

void

Exceptions

ValidationException

protected void processDuplicationFromOriginal()

Relevant only for duplicated object that were not written at the time of duplication

Return Value

void

Exceptions

ValidationException

protected void writeDuplication(SiteTree $original)

No description

Parameters

SiteTree $original

Return Value

void

Exceptions

ValidationException

protected void setTopPageForElementalArea()

Elemental area is created before related page is written so we have to set top page explicitly after page is written and the relations are available

Return Value

void

Exceptions

ValidationException