class SiteTreeSubsites extends DataExtension (View source)

Extension for the SiteTree object to add subsites support

Properties

DataObject $owner from  DataExtension

Methods

public
__construct()

No description

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

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

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

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

public
clearOwner()

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

public
object
getOwner()

Returns the owner of this extension.

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

public static 
unload_extra_statics($class, $extension) deprecated

No description

public
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

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

Update any requests to limit the results to the current site

public
augmentDatabase()

Update the database schema as required by this extension.

public
augmentWrite(array $manipulation)

Augment a write-record request.

public
onBeforeWrite()

Extend the owner's onBeforeWrite() logic

public
onAfterWrite()

Extend the owner's onAfterWrite() logic

public
onBeforeDelete()

Extend the owner's onBeforeDelete() logic

public
onAfterDelete()

Extend the owner's onAfterDelete() logic

public
requireDefaultRecords()

Extend the owner's requireDefaultRecords() logic

public
populateDefaults()

Extend the owner's populateDefaults() logic

public
onAfterBuild()

Extend the owner's onAfterBuild() logic

public
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.

public
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"

public
bool|null
canDelete(Member $member = null)

No description

public
bool|null
canCreate(Member $member = null)

No description

public
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

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

public
void
updateCMSCompositeValidator(CompositeValidator $compositeValidator)

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

public
updateFrontEndFields(FieldList $fields)

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

public
updateCMSActions(FieldList $actions)

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

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

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

public
isMainSite()

No description

public
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.

public
onBeforeDuplicate()

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

public
duplicateToSubsite(Subsite|int $subsiteID = null, bool $includeChildren = false)

Create a duplicate of this page and save it to another subsite

public
duplicateSubsiteRelations(SiteTree $originalPage)

Duplicate relations using a static property to define which ones we want to duplicate

public
alternateSiteConfig()

No description

public
bool
canAddChildren(null $member = null)

No description

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

No description

public static 
contentcontrollerInit($controller)

Called by ContentController::init();

public
string
alternateAbsoluteLink(null $action = null)

No description

public
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.

public
string
alternatePreviewLink(string|null $action = null) deprecated

This function is marked as deprecated for removal in 5.0.0 in silverstripe/cms so now simply passes execution to where the functionality exists for backwards compatiblity.

public
string
MetaTags($tags)

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

public
augmentSyncLinkTracking()

No description

public
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.

public
cacheKeyComponent()

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

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 DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

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

Return Value

string

Extension classname, e.g. "Versioned"

static unload_extra_statics($class, $extension) deprecated

deprecated 4.7.0 Will be removed without equivalent functionality

No description

Parameters

$class
$extension

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

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)

No description

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member = null)

No description

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

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

Caution: Use 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. 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()

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.

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

No description

Return Value

SiteConfig

bool canAddChildren(null $member = null)

No description

Parameters

null $member

Return Value

bool

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

No description

Parameters

Member|null $member

Return Value

bool|null

static contentcontrollerInit($controller)

Called by ContentController::init();

Parameters

$controller

No description

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

deprecated 2.2.0 Use updatePreviewLink() instead

This function is marked as deprecated for removal in 5.0.0 in silverstripe/cms so now simply passes execution to where the functionality exists for backwards compatiblity.

CMS 4.0.0 SiteTree already throws a SilverStripe deprecation error before calling this function.

Parameters

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

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.

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