class BuildTrigger in Build Hooks 3.x

Defines a class for triggering a build.

Hierarchy

• class \Drupal\build_hooks\Event\BuildTrigger extends \Symfony\Component\EventDispatcher\Event

5 files declare their use of BuildTrigger

EventSubscriber.php in tests/modules/build_hooks_test/src/EventSubscriber.php

FrontendEnvironmentBase.php in src/Plugin/FrontendEnvironmentBase.php

FrontendEnvironmentInterface.php in src/Plugin/FrontendEnvironmentInterface.php

TestEnvironment.php in tests/modules/build_hooks_test/src/Plugin/FrontendEnvironment/TestEnvironment.php

Trigger.php in src/Trigger.php

File

src/Event/BuildTrigger.php, line 15

Namespace

Drupal\build_hooks\Event

class BuildTrigger extends Event {

  /**
   * Build hook details.
   *
   * @var \Drupal\build_hooks\BuildHookDetails
   */
  protected $buildHookDetails;

  /**
   * Front-end environment.
   *
   * @var \Drupal\build_hooks\Entity\FrontendEnvironmentInterface
   */
  protected $frontendEnvironment;

  /**
   * TRUE if should build.
   *
   * @var bool
   */
  protected $build = TRUE;

  /**
   * Reason not to build.
   *
   * @var \Drupal\Core\StringTranslation\TranslatableMarkup
   */
  protected $reason;

  /**
   * Response.
   *
   * @var \Psr\Http\Message\ResponseInterface
   */
  protected $response;

  /**
   * Current deployment.
   *
   * @var \Drupal\build_hooks\Entity\DeploymentInterface
   */
  protected $deployment;

  /**
   * Constructs a new BuildTriggerEvent.
   *
   * @param \Drupal\build_hooks\BuildHookDetails $buildHookDetails
   *   Build hook details.
   * @param \Drupal\build_hooks\Entity\FrontendEnvironmentInterface $frontendEnvironment
   *   Front-end environment.
   * @param \Drupal\build_hooks\Entity\DeploymentInterface $deployment
   *   Deployment.
   */
  public function __construct(BuildHookDetails $buildHookDetails, FrontendEnvironmentInterface $frontendEnvironment, DeploymentInterface $deployment) {
    $this->buildHookDetails = $buildHookDetails;
    $this->frontendEnvironment = $frontendEnvironment;
    $this->deployment = $deployment;
  }

  /**
   * Sets if the build should occur.
   *
   * @return $this
   */
  public function setShouldBuild() : BuildTrigger {
    $this->build = TRUE;
    return $this;
  }

  /**
   * Sets should not build.
   *
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $reason
   *   The reason not to build.
   *
   * @return $this
   */
  public function setShouldNotBuild(TranslatableMarkup $reason) : BuildTrigger {
    $this->build = FALSE;
    $this->reason = $reason;
    return $this;
  }

  /**
   * Check if the build should occur.
   *
   * @return bool
   *   TRUE if should build.
   */
  public function shouldBuild() : bool {
    return $this->build;
  }

  /**
   * Gets value of reason not to build.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Reason not to build.
   */
  public function getReason() : TranslatableMarkup {
    return $this->reason;
  }

  /**
   * Sets response.
   *
   * @param \Psr\Http\Message\ResponseInterface $response
   *   Response.
   */
  public function setResponse(ResponseInterface $response) : BuildTrigger {
    $this->response = $response;
    return $this;
  }

  /**
   * Gets build hook details.
   *
   * @return \Drupal\build_hooks\BuildHookDetails
   *   Build hook details.
   */
  public function getBuildHookDetails() : BuildHookDetails {
    return $this->buildHookDetails;
  }

  /**
   * Gets front-end environment.
   *
   * @return \Drupal\build_hooks\Entity\FrontendEnvironmentInterface
   *   Front-end environment.
   */
  public function getFrontendEnvironment() : FrontendEnvironmentInterface {
    return $this->frontendEnvironment;
  }

  /**
   * Gets value of Response.
   *
   * @return \Psr\Http\Message\ResponseInterface|null
   *   Value of Response.
   */
  public function getResponse() : ?ResponseInterface {
    return $this->response;
  }

  /**
   * Gets current deployment.
   *
   * @return \Drupal\build_hooks\Entity\DeploymentInterface
   *   Current deployment.
   */
  public function getDeployment() : DeploymentInterface {
    return $this->deployment;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BuildTrigger::$build	protected	property	TRUE if should build.
BuildTrigger::$buildHookDetails	protected	property	Build hook details.
BuildTrigger::$deployment	protected	property	Current deployment.
BuildTrigger::$frontendEnvironment	protected	property	Front-end environment.
BuildTrigger::$reason	protected	property	Reason not to build.
BuildTrigger::$response	protected	property	Response.
BuildTrigger::getBuildHookDetails	public	function	Gets build hook details.
BuildTrigger::getDeployment	public	function	Gets current deployment.
BuildTrigger::getFrontendEnvironment	public	function	Gets front-end environment.
BuildTrigger::getReason	public	function	Gets value of reason not to build.
BuildTrigger::getResponse	public	function	Gets value of Response.
BuildTrigger::setResponse	public	function	Sets response.
BuildTrigger::setShouldBuild	public	function	Sets if the build should occur.
BuildTrigger::setShouldNotBuild	public	function	Sets should not build.
BuildTrigger::shouldBuild	public	function	Check if the build should occur.
BuildTrigger::__construct	public	function	Constructs a new BuildTriggerEvent.