You are here

class FrontendEnvironmentLibraryController in Build Hooks 3.x

Same name and namespace in other branches
  1. 8.2 src/Controller/FrontendEnvironmentLibraryController.php \Drupal\build_hooks\Controller\FrontendEnvironmentLibraryController

Provides a list of frontend environment plugins.

Hierarchy

Expanded class hierarchy of FrontendEnvironmentLibraryController

File

src/Controller/FrontendEnvironmentLibraryController.php, line 13

Namespace

Drupal\build_hooks\Controller
View source
class FrontendEnvironmentLibraryController extends ControllerBase {

  /**
   * The frontend environment manager.
   *
   * @var \Drupal\build_hooks\Plugin\FrontendEnvironmentManager
   */
  protected $frontendEnvironmentManager;

  /**
   * FrontendEnvironmentLibraryController constructor.
   *
   * @param \Drupal\build_hooks\Plugin\FrontendEnvironmentManager $frontendEnvironmentManager
   *   The frontend environment manager.
   */
  public function __construct(FrontendEnvironmentManager $frontendEnvironmentManager) {
    $this->frontendEnvironmentManager = $frontendEnvironmentManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.frontend_environment'));
  }

  /**
   * Shows a list of frontend environments that can be added.
   *
   * @return array
   *   A render array as expected by the renderer.
   */
  public function listFrontendEnvironments() {
    $headers = [
      [
        'data' => $this
          ->t('Type'),
      ],
      [
        'data' => $this
          ->t('Description'),
      ],
      [
        'data' => $this
          ->t('Operations'),
      ],
    ];
    $definitions = $this->frontendEnvironmentManager
      ->getDefinitions();
    $rows = [];
    foreach ($definitions as $plugin_id => $plugin_definition) {
      $row = [];
      $row['title'] = $plugin_definition['label'];
      $row['description']['data'] = $plugin_definition['description'];
      $links['add'] = [
        'title' => $this
          ->t('Add new environment'),
        'url' => Url::fromRoute('build_hooks.admin_add', [
          'plugin_id' => $plugin_id,
        ]),
      ];
      $row['operations']['data'] = [
        '#type' => 'operations',
        '#links' => $links,
      ];
      $rows[] = $row;
    }
    $build['frontend_environments'] = [
      '#type' => 'table',
      '#header' => $headers,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No types available. Please enable one of the submodules or add your own custom plugin.'),
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
FrontendEnvironmentLibraryController::$frontendEnvironmentManager protected property The frontend environment manager.
FrontendEnvironmentLibraryController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
FrontendEnvironmentLibraryController::listFrontendEnvironments public function Shows a list of frontend environments that can be added.
FrontendEnvironmentLibraryController::__construct public function FrontendEnvironmentLibraryController constructor.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.