class PreApplyEvent

Event fired before staged changes are synced to the active directory.

Hierarchy

Expanded class hierarchy of PreApplyEvent

45 files declare their use of PreApplyEvent
AllowedScaffoldPackagesValidator.php in core/modules/package_manager/src/Validator/AllowedScaffoldPackagesValidator.php
AllowedScaffoldPackagesValidatorTest.php in core/modules/package_manager/tests/src/Kernel/AllowedScaffoldPackagesValidatorTest.php
BaseRequirementsFulfilledValidator.php in core/modules/package_manager/src/Validator/BaseRequirementsFulfilledValidator.php
BaseRequirementsFulfilledValidatorTest.php in core/modules/package_manager/tests/src/Kernel/BaseRequirementsFulfilledValidatorTest.php
BaseRequirementValidatorTrait.php in core/modules/package_manager/src/Validator/BaseRequirementValidatorTrait.php

... See full list

File

core/modules/package_manager/src/Event/PreApplyEvent.php, line 14

Namespace

Drupal\package_manager\Event
View source
final class PreApplyEvent extends SandboxValidationEvent {
  
  /**
   * The list of paths to ignore in the active and stage directories.
   *
   * @var \Drupal\package_manager\ImmutablePathList
   */
  public readonly ImmutablePathList $excludedPaths;
  
  /**
   * Constructs a PreApplyEvent object.
   *
   * @param \Drupal\package_manager\SandboxManagerBase $sandboxManager
   *   The stage which fired this event.
   * @param \PhpTuf\ComposerStager\API\Path\Value\PathListInterface $excluded_paths
   *   The list of paths to exclude. These will not be copied from the stage
   *   directory to the active directory, nor be deleted from the active
   *   directory if they exist, when the stage directory is copied back into
   *   the active directory.
   */
  public function __construct(SandboxManagerBase $sandboxManager, PathListInterface $excluded_paths) {
    parent::__construct($sandboxManager);
    $this->excludedPaths = new ImmutablePathList($excluded_paths);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PreApplyEvent::$excludedPaths public property The list of paths to ignore in the active and stage directories.
PreApplyEvent::__construct public function Constructs a PreApplyEvent object. Overrides SandboxEvent::__construct
SandboxValidationEvent::$results protected property The validation results.
SandboxValidationEvent::addError public function Convenience method to flag a validation error.
SandboxValidationEvent::addErrorFromThrowable public function Convenience method, adds an error validation result from a throwable.
SandboxValidationEvent::addResult public function Adds a validation result to the event. 1
SandboxValidationEvent::getResults public function Gets the validation results.
SandboxValidationEvent::stopPropagation public function

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