TopPageFluentElementExtension
class TopPageFluentElementExtension extends TopPageElementExtension (View source)
Use in place of TopPageElementExtension if you use the Fluent module for page localisation.
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| int | $TopPageID | from TopPageElementExtension | ||
| string | $TopPageLocale |
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.
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 TopPageElementExtension::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.
protected void
onAfterWrite()
Extension point in DataObject::onAfterWrite()
protected void
onBeforeDuplicate()
Extension point in DataObject::duplicate()
protected 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 TopPageElementExtension::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
updateCMSFields(FieldList $fields)
No description
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