1. class
  2. SilverStripe
  3. \
  4. Versioned
  5. \
  6. RecursivePublishable

RecursivePublishable

class RecursivePublishable extends DataExtension

Provides owns / owned_by and recursive publishing API for all objects.

This extension is added to DataObject by default

Config options

owns array List of relationships on this object that are "owned" by this object.

Properties

DataObject|RecursivePublishable $owner

Methods

__construct()

No description

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

Called when this extension is added to a particular class

from Extension
setOwner(object $owner)

Set the owner of this extension.

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

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

from Extension
clearOwner()

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

from Extension
Object
getOwner()

Returns the owner of this extension.

from 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()}.

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

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

from Extension
static 
unload_extra_statics($class, $extension)

No description

from DataExtension
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

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

Edit the given query object to support queries for this extension

from DataExtension
augmentDatabase()

Update the database schema as required by this extension.

from DataExtension
augmentWrite(array $manipulation)

Augment a write-record request.

from DataExtension
onBeforeWrite()

No description

from DataExtension
onAfterWrite()

No description

from DataExtension
onBeforeDelete()

No description

from DataExtension
onAfterDelete()

No description

from DataExtension
requireDefaultRecords()

No description

from DataExtension
populateDefaults()

No description

from DataExtension
can($member)

No description

from DataExtension
canEdit($member)

No description

from DataExtension
canDelete($member)

No description

from DataExtension
canCreate($member)

No description

from DataExtension
array
extraStatics(string $class = null, string $extension = null)

Define extra database fields

from DataExtension
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()}.

from DataExtension
updateFrontEndFields(FieldList $fields)

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

from DataExtension
updateCMSActions(FieldList $actions)

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

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

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

from DataExtension
bool
publishRecursive()

Publish this object and all owned objects to Live

bool
deleteFromChangeSets()

Remove this item from any changesets

ArrayList
findOwned(bool $recursive = true, ArrayList $list = null)

Find all objects owned by the current object.

bool
hasOwned()

Returns true if the record has any owned relationships that exist

ArrayList
findOwners(bool $recursive = true, ArrayList $list = null)

Find objects which own this object.

ArrayList
findOwnersRecursive(bool $recursive, ArrayList $list, array $lookup)

Find objects which own this object.

unlinkDisownedObjects(string|int|DataObject $source, string $targetStage)

Set foreign keys of has_many objects to 0 where those objects were disowned as a result of a partial publish / unpublish.

unlinkDisownedRelationship(string|int|DataObject $source, string $targetStage, string $relationship)

Unlink an object with a specific named relationship against the owner.

onBeforeDuplicate(DataObject $original, bool $doWrite, array|null|false $relations)

If cascade_duplications is empty, default to owns config

Details

in Extension at line 39
__construct()

in Extension at line 50
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

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner The owner object

in Extension at line 74
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

in Extension at line 87
clearOwner()

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

in Extension at line 100
Object getOwner()

Returns the owner of this extension.

Return Value

Object

in Extension at line 113
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"

in Extension at line 128
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 &...$arguments

Return Value

mixed

in DataExtension at line 19
static unload_extra_statics($class, $extension)

Parameters

$class
$extension

in DataExtension at line 30
validate(ValidationResult $validationResult)

Hook for extension-specific validation.

Parameters

ValidationResult $validationResult Local validation result

Exceptions

ValidationException

in DataExtension at line 40
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)

Edit the given query object to support queries for this extension

Parameters

SQLSelect $query Query to augment.
DataQuery $dataQuery Container DataQuery for this SQLSelect

in DataExtension at line 50
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.

in DataExtension at line 59
augmentWrite(array $manipulation)

Augment a write-record request.

Parameters

array $manipulation Array of operations to augment.

in DataExtension at line 63
onBeforeWrite()

in DataExtension at line 67
onAfterWrite()

in DataExtension at line 71
onBeforeDelete()

in DataExtension at line 75
onAfterDelete()

in DataExtension at line 79
requireDefaultRecords()

in DataExtension at line 83
populateDefaults()

in DataExtension at line 87
can($member)

Parameters

$member

in DataExtension at line 91
canEdit($member)

Parameters

$member

in DataExtension at line 95
canDelete($member)

Parameters

$member

in DataExtension at line 99
canCreate($member)

Parameters

$member

in DataExtension at line 114
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.

in DataExtension at line 132
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

in DataExtension at line 144
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

in DataExtension at line 154
updateCMSActions(FieldList $actions)

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

Parameters

FieldList $actions FieldList

in DataExtension at line 166
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

in DataExtension at line 189
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

at line 58
bool publishRecursive()

Publish this object and all owned objects to Live

Return Value

bool

at line 107
bool deleteFromChangeSets()

Remove this item from any changesets

Return Value

bool

at line 136
ArrayList findOwned(bool $recursive = true, ArrayList $list = null)

Find all objects owned by the current object.

Note that objects will only be searched in the same stage as the given record.

Parameters

bool $recursive True if recursive
ArrayList $list Optional list to add items to

Return Value

ArrayList list of objects

at line 146
bool hasOwned()

Returns true if the record has any owned relationships that exist

Return Value

bool

at line 172
ArrayList findOwners(bool $recursive = true, ArrayList $list = null)

Find objects which own this object.

Note that objects will only be searched in the same stage as the given record.

Parameters

bool $recursive True if recursive
ArrayList $list Optional list to add items to

Return Value

ArrayList list of objects

at line 195
ArrayList findOwnersRecursive(bool $recursive, ArrayList $list, array $lookup)

Find objects which own this object.

Note that objects will only be searched in the same stage as the given record.

Parameters

bool $recursive True if recursive
ArrayList $list List to add items to
array $lookup List of reverse lookup rules for owned objects

Return Value

ArrayList list of objects

at line 293
unlinkDisownedObjects(string|int|DataObject $source, string $targetStage)

Set foreign keys of has_many objects to 0 where those objects were disowned as a result of a partial publish / unpublish.

I.e. this object and its owned objects were recently written to $targetStage, but deleted objects were not.

Note that this operation does not create any new Versions

Parameters

string|int|DataObject $source Objects in this stage / version / record will not be unlinked. Provide number if saving records from a version, or string if saving records from a stage
string $targetStage Objects which exist in this stage but not $sourceVersion will be unlinked. This parameter only supports stage name, as you cannot modify specific versions

Exceptions

InvalidArgumentException

at line 344
unlinkDisownedRelationship(string|int|DataObject $source, string $targetStage, string $relationship)

Unlink an object with a specific named relationship against the owner.

Note: The owner object should be queried in the correct stage / view mode that includes objects that should NOT be unlinked. E.g. if disowning objects from live, the owner object should be queried in draft, and vice versa (or some other source version ID)

Parameters

string|int|DataObject $source Objects in this stage / version / record will not be unlinked. Provide number if saving records from a version, or string if saving records from a stage
string $targetStage Objects which exist in this stage but not $sourceVersion will be unlinked. This parameter only supports stage name, as you cannot modify specific versions
string $relationship Name of has_many relationship to unlink

at line 404
onBeforeDuplicate(DataObject $original, bool $doWrite, array|null|false $relations)

If cascade_duplications is empty, default to owns config

Parameters

DataObject $original
bool $doWrite
array|null|false $relations