TriggerInterface.php in Build Hooks 3.x

Namespace

Drupal\build_hooks

File

src/TriggerInterface.php

<?php

namespace Drupal\build_hooks;

use Drupal\build_hooks\Entity\FrontendEnvironmentInterface;

/**
 * Defines an interface for triggering build hooks.
 */
interface TriggerInterface {
  const DEPLOYMENT_STRATEGY_CRON = 'cron';
  const DEPLOYMENT_STRATEGY_ENTITYSAVE = 'entitysave';
  const BUILD_HOOKS_TOOLBAR_CACHE_TAG = 'build_hooks_toolbar';
  const DEPLOYMENT_STRATEGY_MANUAL = 'manual';

  /**
   * Deploy frontend environments.
   *
   * @return mixed
   *   Mixed.
   */
  public function deployFrontendCronEnvironments();

  /**
   * Triggers a build hook for an environment.
   *
   * @param \Drupal\build_hooks\Entity\FrontendEnvironmentInterface $frontend_environment
   *   The Environment to trigger the deployment for.
   *
   * @return mixed
   *   Mixed.
   */
  public function triggerBuildHookForEnvironment(FrontendEnvironmentInterface $frontend_environment);

  /**
   * Whether to show the menu.
   */
  public function showMenu();

  /**
   * Utility function to retrieve the cache tag to apply to the toolbar.
   *
   * @return string
   *   The toolbar cache tag.
   */
  public function getToolbarCacheTag();

  /**
   * Invalidates the toolbar cache tag.
   */
  public function invalidateToolbarCacheTag();

}

Interfaces

Name	Description
TriggerInterface	Defines an interface for triggering build hooks.