UpdateEvent.php in Automatic Updates 8.2

Namespace

Drupal\automatic_updates\Event

File

src/Event/UpdateEvent.php

<?php

namespace Drupal\automatic_updates\Event;

use Drupal\automatic_updates\Validation\ValidationResult;
use Drupal\Component\EventDispatcher\Event;
use Drupal\package_manager\ComposerUtility;

/**
 * Event fired when a site is updating.
 *
 * Subscribers to this event should call ::addValidationResult().
 *
 * @see \Drupal\automatic_updates\AutomaticUpdatesEvents
 */
class UpdateEvent extends Event {

  /**
   * The validation results.
   *
   * @var \Drupal\automatic_updates\Validation\ValidationResult[]
   */
  protected $results = [];

  /**
   * The Composer utility object for the active directory.
   *
   * @var \Drupal\package_manager\ComposerUtility
   */
  protected $activeComposer;

  /**
   * Constructs a new UpdateEvent object.
   *
   * @param \Drupal\package_manager\ComposerUtility $active_composer
   *   A Composer utility object for the active directory.
   */
  public function __construct(ComposerUtility $active_composer) {
    $this->activeComposer = $active_composer;
  }

  /**
   * Returns a Composer utility object for the active directory.
   *
   * @return \Drupal\package_manager\ComposerUtility
   *   The Composer utility object for the active directory.
   */
  public function getActiveComposer() : ComposerUtility {
    return $this->activeComposer;
  }

  /**
   * Adds a validation result.
   *
   * @param \Drupal\automatic_updates\Validation\ValidationResult $validation_result
   *   The validation result.
   */
  public function addValidationResult(ValidationResult $validation_result) : void {
    $this->results[] = $validation_result;
  }

  /**
   * Gets the validation results.
   *
   * @param int|null $severity
   *   (optional) The severity for the results to return. Should be one of the
   *   SystemManager::REQUIREMENT_* constants.
   *
   * @return \Drupal\automatic_updates\Validation\ValidationResult[]
   *   The validation results.
   */
  public function getResults(?int $severity = NULL) : array {
    if ($severity !== NULL) {
      return array_filter($this->results, function ($result) use ($severity) {
        return $result
          ->getSeverity() === $severity;
      });
    }
    return $this->results;
  }

}

Classes

Name	Description
UpdateEvent	Event fired when a site is updating.