class PostUpdateEvent in Automatic Updates 8

Defines the post update event.

Hierarchy

• class \Drupal\automatic_updates\Event\PostUpdateEvent extends \Symfony\Component\EventDispatcher\Event

See also

\Drupal\automatic_updates\Event\UpdateEvents

3 files declare their use of PostUpdateEvent

InPlaceUpdate.php in src/Services/InPlaceUpdate.php

NotifyTest.php in tests/src/Functional/NotifyTest.php

PostUpdateSubscriber.php in src/EventSubscriber/PostUpdateSubscriber.php

File

src/Event/PostUpdateEvent.php, line 13

Namespace

Drupal\automatic_updates\Event

class PostUpdateEvent extends Event {

  /**
   * The update metadata.
   *
   * @var \Drupal\automatic_updates\UpdateMetadata
   */
  protected $updateMetadata;

  /**
   * The update success status.
   *
   * @var bool
   */
  protected $success;

  /**
   * Constructs a new PostUpdateEvent.
   *
   * @param \Drupal\automatic_updates\UpdateMetadata $metadata
   *   The update metadata.
   * @param bool $success
   *   TRUE if update succeeded, FALSE otherwise.
   */
  public function __construct(UpdateMetadata $metadata, $success) {
    $this->updateMetadata = $metadata;
    $this->success = $success;
  }

  /**
   * Get the update metadata.
   *
   * @return \Drupal\automatic_updates\UpdateMetadata
   *   The update metadata.
   */
  public function getUpdateMetadata() {
    return $this->updateMetadata;
  }

  /**
   * Gets the update success status.
   *
   * @return bool
   *   TRUE if update succeeded, FALSE otherwise.
   */
  public function success() {
    return $this->success;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PostUpdateEvent::$success	protected	property	The update success status.
PostUpdateEvent::$updateMetadata	protected	property	The update metadata.
PostUpdateEvent::getUpdateMetadata	public	function	Get the update metadata.
PostUpdateEvent::success	public	function	Gets the update success status.
PostUpdateEvent::__construct	public	function	Constructs a new PostUpdateEvent.