RecursivePublishable
class RecursivePublishable extends Extension (View source)
Provides owns / owned_by and recursive publishing API for all objects.
This extension is added to DataObject by default
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
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 DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Find objects which own this object.
Find a list of classes, each of which with a list of methods to invoke to lookup owners.
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
Make sure to flush cached data in case the data changes Extension point in DataObject::onAfterWrite()
Make sure to flush cached data in case the data changes Extension point in DataObject::onAfterDelete()
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
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()
T
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 DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
bool
publishRecursive()
Publish this object and all owned objects to Live
bool
deleteFromChangeSets()
Remove this item from any changesets
DataObject&static>
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
DataObject>
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.
DataObject>
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.
protected array
lookupReverseOwners()
Find a list of classes, each of which with a list of methods to invoke to lookup owners.
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)
protected
onBeforeDuplicate(DataObject $original, bool $doWrite, array|null|false $relations)
If cascade_duplications is empty, default to owns config
protected void
onAfterWrite()
Make sure to flush cached data in case the data changes Extension point in DataObject::onAfterWrite()
protected void
onAfterDelete()
Make sure to flush cached data in case the data changes Extension point in DataObject::onAfterDelete()