interface FrontendEnvironmentInterface in Build Hooks 3.x

Defines an interface for Frontend environment plugins.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\build_hooks\Plugin\FrontendEnvironmentInterface

2 files declare their use of FrontendEnvironmentInterface

FrontendEnvironmentForm.php in src/Form/FrontendEnvironmentForm.php

ResponseEvent.php in src/Event/ResponseEvent.php

File

src/Plugin/FrontendEnvironmentInterface.php, line 16

Namespace

Drupal\build_hooks\Plugin

interface FrontendEnvironmentInterface extends ConfigurableInterface, DependentPluginInterface, PluginFormInterface, PluginInspectionInterface {

  /**
   * Get the info to trigger the hook based on the configuration of the plugin.
   *
   * @return \Drupal\build_hooks\BuildHookDetails
   *   An object containing the details to trigger the hook.
   */
  public function getBuildHookDetails();

  /**
   * Allows the plugin to add elements to the deployment form.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current form state.
   *
   * @return array
   *   A form array to add to the deployment form.
   */
  public function getAdditionalDeployFormElements(FormStateInterface $form_state);

  /**
   * Determine if the deployment was triggered successfully.
   *
   * @param \Psr\Http\Message\ResponseInterface $response
   *   Response for the trigger request.
   *
   * @return bool
   *   TRUE if the deployment succeeded.
   */
  public function deploymentWasTriggered(ResponseInterface $response) : bool;

  /**
   * React before a build is triggered.
   *
   * @param \Drupal\build_hooks\Event\BuildTrigger $trigger
   *   The build trigger.
   */
  public function preDeploymentTrigger(BuildTrigger $trigger) : void;

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	20
FrontendEnvironmentInterface::deploymentWasTriggered	public	function	Determine if the deployment was triggered successfully.	1
FrontendEnvironmentInterface::getAdditionalDeployFormElements	public	function	Allows the plugin to add elements to the deployment form.	6
FrontendEnvironmentInterface::getBuildHookDetails	public	function	Get the info to trigger the hook based on the configuration of the plugin.	6
FrontendEnvironmentInterface::preDeploymentTrigger	public	function	React before a build is triggered.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2