Hierarchy

No description

Called when this extension is added to a particular class

Set the owner of this extension.

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

Returns the owner of this extension.

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.

Validate the owner object - check for existence of infinite loops.

Edit the given query object to support queries for this extension

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.

Augment a write-record request.

Extend the owner's onBeforeWrite() logic

See DataObject::onBeforeWrite() for context.

Extend the owner's onAfterWrite() logic

See DataObject::onAfterWrite() for context.

Extend the owner's onBeforeDelete() logic

See DataObject::onBeforeDelete() for context.

Extend the owner's onAfterDelete() logic

See DataObject::onAfterDelete() for context.

Extend the owner's requireDefaultRecords() logic

See DataObject::requireDefaultRecords() for context.

Extend the owner's populateDefaults() logic

See DataObject::populateDefaults() for context.

Extend the owner's onAfterBuild() logic

See DataObject::onAfterBuild() for context.

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.

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.

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.

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.

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.

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.

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

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

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

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

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

No description

Get a list of this DataObject's and all it's descendants IDs.

Get a list of this DataObject's and all it's descendants ID, and put them in $idList.

Get the children for this DataObject filtered by canView()

Return all children, including those 'not in menus'.

Return all children, including those that have been deleted but are still in live.

• Deleted children will be marked as "DeletedFromStage"
• Added children will be marked as "AddedToStage"
• Modified children will be marked as "ModifiedOnStage"
• Everything else has "SameOnStage" set, as an indicator that this information has been looked up.

Return all the children that this page had, including pages that were deleted from both stage & live.

Return the number of children that this page ever had, including pages that were deleted.

Return the number of direct children. By default, values are cached after the first invocation. Can be augmented by augmentNumChildrenCountQuery().

Pre-populate any appropriate caches prior to rendering a tree.

This is used to allow for the efficient rendering of tree views, notably in the CMS. In the case of Hierarchy, it caches numChildren values. Other extensions can provide an onPrepopulateTreeDataCache(DataList $recordList = null, array $options) methods to hook into this event as well.

Pre-populate the cache for Versioned::get_versionnumber_by_stage() for a list of record IDs, for more efficient database querying. If $idList is null, then every record will be pre-cached.

Checks if we're on a controller where we should filter. ie. Are we loading the SiteTree?

Return children in the stage site.

Return children in the live site, if it exists.

Get this object's parent, optionally filtered by an SQL clause. If the clause doesn't match the parent, nothing is returned.

Return all the parents of this class in a set ordered from the closest to furtherest parent.

Returns a human-readable, flattened representation of the path to the object, using its Title attribute.

Flush all Hierarchy caches:

• Children (instance)
• NumChildren (instance)

No description