StatusCheckTrait.php

<?php

declare(strict_types = 1);

namespace Drupal\package_manager;

use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;

/**
 * Contains helper methods to run status checks on a stage.
 *
 * @internal
 *   This is an internal part of Package Manager and may be changed or removed
 *   at any time without warning. External code should not use or interact with
 *   this trait.
 */
trait StatusCheckTrait {

  /**
   * Runs a status check for a stage and returns the results, if any.
   *
   * @param \Drupal\package_manager\StageBase $stage
   *   The stage to run the status check for.
   * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   (optional) The event dispatcher service.
   *
   * @return \Drupal\package_manager\ValidationResult[]
   *   The results of the status check. If a readiness check was also done,
   *   its results will be included.
   */
  protected function runStatusCheck(StageBase $stage, EventDispatcherInterface $event_dispatcher = NULL): array {
    $event_dispatcher ??= \Drupal::service('event_dispatcher');
    try {
      $paths_to_exclude_event = new CollectPathsToExcludeEvent($stage);
      $event_dispatcher->dispatch($paths_to_exclude_event);
      $event = new StatusCheckEvent($stage, $paths_to_exclude_event->getAll());
    }
    catch (\Throwable $throwable) {
      // We can dispatch the status check event without the paths to exclude,
      // but it must be set explicitly to NULL, to allow those status checks to
      // run that do not need the paths to exclude.
      $event = new StatusCheckEvent($stage, NULL);
      // Add the error that was encountered so that regardless of any other
      // validation errors BaseRequirementsFulfilledValidator will stop the
      // event propagation after the base requirement validators have run.
      // @see \Drupal\package_manager\Validator\BaseRequirementsFulfilledValidator
      $event->addErrorFromThrowable($throwable, t('Unable to collect the paths to exclude.'));
    }

    $event_dispatcher->dispatch($event);
    return $event->getResults();
  }

}