class RecursivePublishable extends DataExtension (View source)

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

This extension is added to DataObject by default

Properties

DataObject|RecursivePublishable $owner

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)

Edit the given query object to support queries for this extension

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)

Influence the owner's canEdit() 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
canDelete(Member $member)

Influence the owner's canDelete() 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
canCreate(Member $member)

Influence the owner's canCreate() 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
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
bool
publishRecursive()

Publish this object and all owned objects to Live

public
bool
deleteFromChangeSets()

Remove this item from any changesets

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

Find all objects owned by the current object.

public
bool
hasOwned()

Returns true if the record has any owned relationships that exist

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

Find objects which own this object.

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

Find objects which own this object.

protected
array
lookupReverseOwners()

Find a list of classes, each of which with a list of methods to invoke to lookup owners.

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

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

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

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

If cascade_duplications is empty, default to owns config

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)

Edit the given query object to support queries for this extension

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)

Influence the owner's canEdit() 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::canEdit()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canDelete(Member $member)

Influence the owner's canDelete() 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::canDelete()} and {@link DataObject::extendedCan() for context.

Parameters

Member $member

Return Value

bool|null

bool|null canCreate(Member $member)

Influence the owner's canCreate() 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::canCreate()} and {@link DataObject::extendedCan() for context.

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

bool publishRecursive()

Publish this object and all owned objects to Live

Return Value

bool

bool deleteFromChangeSets()

Remove this item from any changesets

Return Value

bool

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

bool hasOwned()

Returns true if the record has any owned relationships that exist

Return Value

bool

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

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

protected array lookupReverseOwners()

Find a list of classes, each of which with a list of methods to invoke to lookup owners.

Return Value

array

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

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

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