SiteTreePublishingEngine
class SiteTreePublishingEngine extends Extension implements Resettable (View source)
This extension couples to the StaticallyPublishable and StaticPublishingTrigger implementations on the SiteTree objects and makes sure the actual change to SiteTree is triggered/enqueued.
Provides the following information as a context to StaticPublishingTrigger:
- action - name of the executed action: publish or unpublish
Constants
| ACTION_PUBLISH |
|
| ACTION_UNPUBLISH |
|
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| protected static | QueuedJobService|null | $queueService | Queued job service injection property Used for unit tests only to cover edge cases where Injector doesn't cover |
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.
Force inject queue service Used for unit tests only to cover edge cases where Injector doesn't cover
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.
static
reset()
Reset the local cache of this object
static void
setQueueService(QueuedJobService $service)
Force inject queue service Used for unit tests only to cover edge cases where Injector doesn't cover
protected
onBeforePublishRecursive(SiteTree|SiteTreePublishingEngine|null $original)
No description
protected
onAfterPublishRecursive(SiteTree|SiteTreePublishingEngine|null $original)
No description
protected
onBeforeUnpublish()
No description
protected
onAfterUnpublish()
No description
void
collectChanges(array $context)
Collect all changes for the given context.
flushChanges()
Execute URL deletions, enqueue URL updates.