RecursivePublishable
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 | ||
static private array | $owns | List of relationships on this object that are "owned" by this object. |
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 {@link DataObject::$extensions} or {@link Object::add_extension()}.
Invoke extension point. This will prefer explicit extend
prefixed
methods.
Edit the given query object to support queries for this extension
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. {@link DataObject->getCMSFields()}.
This function is used to provide modifications to the form used for front end forms. {@link DataObject->getFrontEndFields()}
This is used to provide modifications to the form actions used in the CMS. {@link 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']
Publish this object and all owned objects to Live
Remove this item from any changesets
Returns true if the record has any owned relationships that exist
Find objects which own this object.
Set foreign keys of has_many objects to 0 where those objects were disowned as a result of a partial publish / unpublish.
Unlink an object with a specific named relationship against the owner.
If cascade_duplications
is empty, default to owns
config
Details
__construct()
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.
static
unload_extra_statics($class, $extension)
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLSelect $query, DataQuery $dataQuery = null)
Edit the given query object to support queries for this extension
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.
onBeforeWrite()
onAfterWrite()
onBeforeDelete()
onAfterDelete()
requireDefaultRecords()
populateDefaults()
can($member)
canEdit($member)
canDelete($member)
canCreate($member)
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. {@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.
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.
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']
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.
Note that objects will only be searched in the same stage as the given record.
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.
Note that objects will only be searched in the same stage as the given record.
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.
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
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)
onBeforeDuplicate(DataObject $original, bool $doWrite, array|null|false $relations)
If cascade_duplications
is empty, default to owns
config