class PreApplyEvent

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

Hierarchy

  • class \Drupal\package_manager\Event\StageEvent extends \Symfony\Contracts\EventDispatcher\Event
    • class \Drupal\package_manager\Event\PreOperationStageEvent extends \Drupal\package_manager\Event\StageEvent
      • class \Drupal\package_manager\Event\PreApplyEvent extends \Drupal\package_manager\Event\PreOperationStageEvent

Expanded class hierarchy of PreApplyEvent

39 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 PreOperationStageEvent {
    
    /**
     * 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\StageBase $stage
     *   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(StageBase $stage, PathListInterface $excluded_paths) {
        parent::__construct($stage);
        $this->excludedPaths = new ImmutablePathList($excluded_paths);
    }

}

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