DataExtension

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

No description

Hook for extension-specific validation.

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.

Extension point in DataObject::onAfterWrite()

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

Extension point in DataObject::duplicate()

Extension point in DataObject::duplicate()

Finds the top-level Page object for a Block / ElementalArea, using the cached TopPageID reference when possible.

Set top page to an object If no page is provided as an argument nor as a fixed id via DataExtension::withFixedTopPage() automatic page determination will be attempted Note that this may not always succeed as your model may not be attached to parent object at the time of this call

No description

Global flag manipulation - enable automatic top page determination Useful for unit tests as you may want to enable / disable this feature based on need

Global flag manipulation - disable automatic top page determination Useful for unit tests as you may want to enable / disable this feature based on need

Use this to wrap any code which is supposed to run with desired top page update setting Useful for unit tests as you may want to enable / disable this feature based on need

Use this to wrap any code which is supposed to run with fixed top page Useful when top page is known upfront and doesn't need to be determined For example: model duplication where parent is assigned and saved only after the duplication is done It's not possible to determine top page in such case however it might be possible to know the top page even before the operation starts from the specific context Setting the page id to 0 disables this feature

Get the ID of a page which is currently set as the fixed top page

Registers the object for a TopPage update. Ensures that this operation is deferred to a point when all required relations have been written.

Assigns top page relation

Clears top page relation, this is useful when duplicating object as the new object doesn't necessarily belong to the original page

Assigns top page relation based on fixed id

Save top page changes without using write() Using raw query here because:

• this is already called during write() and triggering more write() related extension points is undesirable
• we don't want to create a new version if object is versioned
• using writeWithoutVersion() produces some weird edge cases were data is not written because the fields are not recognised as changed (using forceChange() introduces a new set of issues)

Perform a page lookup based on cached data This function allows more extensibility as it can be fully overridden unlike an extension point Various projects may decide to alter this by injecting features like tracking, feature flags and even completely different data lookups This is a performance driven functionality so extension points are not great as they only allow adding features on top of existing ones not replacing them

Find table name which has the top page fields

No description