DataExtension deprecated
class DataExtension extends DataExtension (View source)
deprecated
Class DataExtension
Provides a db-cached reference to the top-level page for improved read performance on projects with deeply nested block structures. Apply to BaseElement and ElementalArea.
Properties
protected | T | $owner | The object this extension is applied to. |
from Extension |
int | $TopPageID |
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']
Finds the top-level SiteTree 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
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
Registers the object for a TopPage update. Ensures that this operation is deferred to a point when all required relations have been written.
Clears top page relation, this is useful when duplicating object as the new object doesn't necessarily belong to the original page
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
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']
void
onBeforeDuplicate()
Extension point in DataObject::duplicate()
void
onAfterDuplicate()
Extension point in DataObject::duplicate()
SiteTree|null
getTopPage()
Finds the top-level SiteTree object for a Block / ElementalArea, using the cached TopPageID reference when possible.
void
setTopPage(SiteTree|null $page = null)
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
mixed
withFixedTopPage(int $topPageID, callable $callback)
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
protected int
getFixedTopPageID()
Get the ID of a page which is currently set as the fixed top page
protected void
updateTopPage()
Registers the object for a TopPage update. Ensures that this operation is deferred to a point when all required relations have been written.
protected void
assignTopPage(SiteTree $page)
Assigns top page relation
protected void
clearTopPage()
Clears top page relation, this is useful when duplicating object as the new object doesn't necessarily belong to the original page
protected void
assignFixedTopPage()
Assigns top page relation based on fixed id
protected void
saveChanges(array $extraData = [])
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)
protected SiteTree|null
getTopPageFromCachedData(int $id)
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
protected string
getTopPageTable()
Find table name which has the top page fields
SiteTree
TopPage()
No description