SilverStripe\StaticPublishQueue\Extension\Engine\SiteTreePublishingEngine
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
Synopsis
class SiteTreePublishingEngine
extends SiteTreeExtension
implements
Resettable
{
- // members
- protected static QueuedJobService|null $queueService = NULL;
- private array $toUpdate = ;
- private array $toDelete = ;
- // methods
- public static void reset()
- public static void setQueueService()
- public array getToUpdate()
- public array getToDelete()
- public $this setToUpdate()
- public $this setToDelete()
- public void onAfterPublishRecursive()
- public void onBeforeUnpublish()
- public void onAfterUnpublish()
- public void collectChanges()
- public void flushChanges()
Hierarchy
Extends
- SilverStripe\CMS\Model\SiteTreeExtension
Implements
- SilverStripe\Core\Resettable
Members
private
- $toDelete
—
array
Queues the urls to be deleted as part of a next flush operation. - $toUpdate
—
array
Queues the urls to be flushed into the queue.
protected
- $queueService
—
SilverStripe\StaticPublishQueue\Extension\Engine\QueuedJobService|null
Queued job service injection property Used for unit tests only to cover edge cases where Injector doesn't cover
Methods
public
- collectChanges() — Collect all changes for the given context.
- flushChanges() — Execute URL deletions, enqueue URL updates.
- getToDelete()
- getToUpdate()
- onAfterPublishRecursive()
- onAfterUnpublish()
- onBeforeUnpublish()
- reset()
- setQueueService() — Force inject queue service Used for unit tests only to cover edge cases where Injector doesn't cover
- setToDelete()
- setToUpdate()