class PreCreateEvent

Event fired before a stage directory is created.

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\PreCreateEvent extends \Drupal\package_manager\Event\PreOperationStageEvent

Expanded class hierarchy of PreCreateEvent

35 files declare their use of PreCreateEvent
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/PreCreateEvent.php, line 14

Namespace

Drupal\package_manager\Event
View source 
final class PreCreateEvent extends PreOperationStageEvent {
    
    /**
     * The list of paths to exclude from the stage directory.
     *
     * @var \Drupal\package_manager\ImmutablePathList
     */
    public readonly ImmutablePathList $excludedPaths;
    
    /**
     * Constructs a PreCreateEvent 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 into the stage
     *   directory when it is created.
     */
    public function __construct(StageBase $stage, PathListInterface $excluded_paths) {
        parent::__construct($stage);
        $this->excludedPaths = new ImmutablePathList($excluded_paths);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
PreCreateEvent::$excludedPaths public property The list of paths to exclude from the stage directory.
PreCreateEvent::__construct public function Constructs a PreCreateEvent object. Overrides StageEvent::__construct
PreOperationStageEvent::$results protected property The validation results.
PreOperationStageEvent::addError public function Convenience method to flag a validation error.
PreOperationStageEvent::addErrorFromThrowable public function Convenience method, adds an error validation result from a throwable.
PreOperationStageEvent::addResult public function Adds a validation result to the event. 1
PreOperationStageEvent::getResults public function Gets the validation results.
PreOperationStageEvent::stopPropagation public function

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