SiteTreeExtension deprecated
class SiteTreeExtension extends SiteTreeExtension (View source)
deprecated
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
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.
Edit the given query object to support queries for this extension
Update the database schema as required by this extension.
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.
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.
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.
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.
Define extra database 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().
This function is used to provide modifications to the Validators used on a DataObject.
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 Versioned::publishSingle() action is completed
Hook called after the page's Versioned::publishSingle() action is completed
Hook called before the page's Versioned::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
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.
Find currently duplicated page note: this doesn't change any stored data
Update top page reference during duplication process
Relevant only for duplicated object that were not written at the time of duplication
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
        
                            
    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.
        
                            
    validate(ValidationResult $validationResult)
        
    
    Hook for extension-specific validation.
        
                            
    augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
        
    
    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()
        
    
    Extend the owner's onBeforeWrite() logic
See DataObject::onBeforeWrite() for context.
        
                            
    onAfterWrite()
        
    
    Extension point in DataObject::onAfterWrite()
        
                            
    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.
        
                            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.
        
                            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.
        
                            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.
        
                            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.
        
                            
    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.
        
                            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.
        
                            
    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 Versioned::publishSingle() action is completed
        
                            
    onAfterPublish(SiteTree $original)
        
    
    Hook called after the page's Versioned::publishSingle() action is completed
        
                            
    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
        
                            bool|null
    canPublish(Member $member)
        
    
    Hook called to determine if a user may publish this SiteTree object
        
                            
    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
        
                            void
    onBeforeDuplicate(SiteTree $original)
        
    
    Extension point in DataObject::duplicate()
        
                            void
    onAfterDuplicate(SiteTree $original, bool $doWrite)
        
    
    Extension point in DataObject::duplicate()
        
                            string|null
    getDuplicationKey()
        
    
    Generates a unique key for the page
        
                            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.
        
                    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