SiteTreeSubsites
class SiteTreeSubsites extends DataExtension (View source)
Extension for the SiteTree object to add subsites support
Properties
protected | T | $owner | The object this extension is applied to. |
from Extension |
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.
Update any requests to limit the results to the current site
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.
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']
Does the basic duplication, but doesn't write anything this means we can subclass this easier and do more complex relation duplication.
Create a duplicate of this page and save it to another subsite
Duplicate relations using a static property to define which ones we want to duplicate
Use the CMS domain for iframed CMS previews to prevent single-origin violations and SSL cert problems. Always set SubsiteID to avoid errors because a page doesn't exist on the CMS domain.
Inject the subsite ID into the content so it can be used by frontend scripts.
Ensure that valid url segments are checked within the correct subsite of the owner object, even if the current subsiteID is set to some other subsite.
Return a piece of text to keep DataObject cache keys appropriately specific
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)
Update any requests to limit the results to the current site
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()
Extend the owner's onAfterWrite() logic
See DataObject::onAfterWrite() for context.
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 = null)
Only allow editing of a page if the member satisfies one of the following conditions:
- Is in a group which has access to the subsite this page belongs to
- Is in a group with edit permissions on the "main site"
If there are no subsites configured yet, this logic is skipped.
bool|null
canDelete(Member $member = null)
No description
bool|null
canCreate(Member $member = null)
No description
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']
isMainSite()
No description
SiteTree
duplicateToSubsitePrep(Subsite|int $subsiteID, bool $includeChildren)
Does the basic duplication, but doesn't write anything this means we can subclass this easier and do more complex relation duplication.
Note that when duplicating including children, everything is written.
onBeforeDuplicate()
When duplicating a page, assign the current subsite ID from the state
SiteTree
duplicateToSubsite(Subsite|int $subsiteID = null, bool $includeChildren = false)
Create a duplicate of this page and save it to another subsite
duplicateSubsiteRelations(SiteTree $originalPage)
Duplicate relations using a static property to define which ones we want to duplicate
It may be that some relations are not diostinct to sub site so can stay whereas others may need to be duplicated
This was originally deprecated - Use the "cascade_duplicates" config API instead Ideally this would be re-deprecated
SiteConfig
alternateSiteConfig()
No description
bool
canAddChildren(null $member = null)
No description
bool|null
canPublish(Member|null $member = null)
No description
static
contentcontrollerInit($controller)
Called by ContentController::init();
string
alternateAbsoluteLink(null $action = null)
No description
string
updatePreviewLink(string $link, string|null $action = null)
Use the CMS domain for iframed CMS previews to prevent single-origin violations and SSL cert problems. Always set SubsiteID to avoid errors because a page doesn't exist on the CMS domain.
string
MetaTags($tags)
Inject the subsite ID into the content so it can be used by frontend scripts.
augmentSyncLinkTracking()
No description
null|bool
augmentValidURLSegment()
Ensure that valid url segments are checked within the correct subsite of the owner object, even if the current subsiteID is set to some other subsite.
cacheKeyComponent()
Return a piece of text to keep DataObject cache keys appropriately specific
void
ManyManyList() $SiteTree> CrossSubsiteLinkTracking()
No description
Subsite
Subsite()
No description