class SiteTreeSubsites extends DataExtension (View source)

Extension for the SiteTree object to add subsites support

Properties

DataObject $owner from  DataExtension

Methods

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

object
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 {@link DataObject::$extensions} or {@link 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.

augmentWrite(array $manipulation)

Augment a write-record request.

onBeforeWrite()

Extend the owner's onBeforeWrite() logic

onAfterWrite()

Extend the owner's onAfterWrite() logic

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

onAfterDelete()

Extend the owner's onAfterDelete() logic

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

populateDefaults()

Extend the owner's populateDefaults() logic

onAfterBuild()

Extend the owner's onAfterBuild() logic

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.

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"

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

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. {@link DataObject->getCMSFields()}.

void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

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

updateFrontEndFields(FieldList $fields)

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

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. {@link 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

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.

onBeforeDuplicate()

When duplicating a page, assign the current subsite ID from the state

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

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

Details

__construct()

static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to {@link DataObject::$extensions} or {@link Object::add_extension()}.

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult

Local validation result

Exceptions

ValidationException

augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Update any requests to limit the results to the current site

Parameters

SQLSelect $query

Query to augment.

DataQuery $dataQuery

Container DataQuery for this SQLSelect

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 {@link Versioned->augmentDatabase} for an example.

augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation

Array of operations to augment.

onBeforeWrite()

Extend the owner's onBeforeWrite() logic

See {@link DataObject::onBeforeWrite()} for context.

onAfterWrite()

Extend the owner's onAfterWrite() logic

See {@link DataObject::onAfterWrite()} for context.

onBeforeDelete()

Extend the owner's onBeforeDelete() logic

See {@link DataObject::onBeforeDelete()} for context.

onAfterDelete()

Extend the owner's onAfterDelete() logic

See {@link DataObject::onAfterDelete()} for context.

requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

See {@link DataObject::requireDefaultRecords()} for context.

populateDefaults()

Extend the owner's populateDefaults() logic

See {@link DataObject::populateDefaults()} for context.

onAfterBuild()

Extend the owner's onAfterBuild() logic

See {@link 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 {@link DataObject::can()} and {@link DataObject::extendedCan()} for context.

Parameters

Member $member

Return Value

bool|null

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.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member = null)

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member = null)

Parameters

Member $member

Return Value

bool|null

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.

Parameters

string $class

since this method might be called on the class directly

string $extension

since this can help to extract parameters to help set indexes

Return Value

array

Returns 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. {@link DataObject->getCMSFields()}.

Please consider using {@link updateFormFields()} to globally add formfields to the record. The method {@link updateCMSFields()} should just be used to add or modify tabs, or fields which are specific to the CMS-context.

Caution: Use {@link FieldList->addFieldToTab()} to add fields.

Parameters

FieldList $fields

FieldList with a contained TabSet

void updateCMSCompositeValidator(CompositeValidator $compositeValidator)

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

Caution: Use {@link CompositeValidator->addValidator()} to add Validators.

Parameters

CompositeValidator $compositeValidator

Return Value

void

updateFrontEndFields(FieldList $fields)

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

Caution: Use {@link FieldList->push()} to add fields.

Parameters

FieldList $fields

FieldList without TabSet nesting

updateCMSActions(FieldList $actions)

This is used to provide modifications to the form actions used in the CMS. {@link DataObject->getCMSActions()}.

Parameters

FieldList $actions

FieldList

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

Parameters

array $fields

Array of field names

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

Parameters

array $labels

Array of field labels

isMainSite()

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.

Parameters

Subsite|int $subsiteID
bool $includeChildren

Return Value

SiteTree

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

Parameters

Subsite|int $subsiteID

The Subsite to copy to, or its ID

bool $includeChildren

Whether to duplicate child pages too

Return Value

SiteTree

The duplicated page

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

Parameters

SiteTree $originalPage

SiteConfig alternateSiteConfig()

Return Value

SiteConfig

bool canAddChildren(null $member = null)

Parameters

null $member

Return Value

bool

bool|null canPublish(Member|null $member = null)

Parameters

Member|null $member

Return Value

bool|null

static contentcontrollerInit($controller)

Called by ContentController::init();

Parameters

$controller

Parameters

null $action

Return Value

string

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.

Parameters

string $link
string|null $action

Return Value

string

string MetaTags($tags)

Inject the subsite ID into the content so it can be used by frontend scripts.

Parameters

$tags

Return Value

string

augmentSyncLinkTracking()

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.

Return Value

null|bool

Either true or false, or null to not influence result

cacheKeyComponent()

Return a piece of text to keep DataObject cache keys appropriately specific