class WorkspacePrePublishEvent

Same name and namespace in other branches

Defines the pre-publish event class.

class \Drupal\Component\EventDispatcher\Event implements \Symfony\Contracts\EventDispatcher\Event
- class \Drupal\workspaces\Event\WorkspacePublishEvent implements \Drupal\Component\EventDispatcher\Event
  - class \Drupal\workspaces\Event\WorkspacePrePublishEvent implements \Drupal\workspaces\Event\WorkspacePublishEvent

2 files declare their use of WorkspacePrePublishEvent

WorkspacePublisher.php in core/modules/workspaces/src/WorkspacePublisher.php
WorkspaceSubscriber.php in core/modules/content_moderation/src/EventSubscriber/WorkspaceSubscriber.php

View source

class WorkspacePrePublishEvent extends WorkspacePublishEvent {

}

Title Sort descending	Modifiers	Object type	Summary
WorkspacePublishEvent::$publishedRevisionIds	protected	property	The IDs of the entities that are being published.
WorkspacePublishEvent::$publishingStopped	protected	property	Whether an event subscriber requested the publishing to be stopped.
WorkspacePublishEvent::$publishingStoppedReason	protected	property	The reason why publishing stopped. For use in messages.
WorkspacePublishEvent::getPublishedRevisionIds	public	function	Gets the entity IDs that are being published as part of the workspace.
WorkspacePublishEvent::getPublishingStoppedReason	public	function	Gets the reason for stopping the workspace publication.
WorkspacePublishEvent::getWorkspace	public	function	Gets the workspace.
WorkspacePublishEvent::isPublishingStopped	public	function	Determines whether a subscriber requested the publishing to be stopped.
WorkspacePublishEvent::setPublishingStoppedReason	public	function	Sets the reason for stopping the workspace publication.
WorkspacePublishEvent::stopPublishing	public	function	Signals that the workspace publishing should be aborted.
WorkspacePublishEvent::__construct	public	function	Constructs a new WorkspacePublishEvent.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb