You are here

Home » API reference » Add To Head 8 » AddToHeadController.php

class AddToHeadController in Add To Head 8

Default controller for the add_to_head module.

Hierarchy

Expanded class hierarchy of AddToHeadController

File

src/Controller/AddToHeadController.php, line 13

Namespace

Drupal\add_to_head\Controller
View source 
class AddToHeadController extends ControllerBase {
  public function adminOverview() {

    // Get the defined profiles.
    $settings = add_to_head_get_settings();
    $add_profile_url = Url::fromRoute('add_to_head.add_profile');
    $link = Link::fromTextAndUrl($this
      ->t('Add one now'), $add_profile_url)
      ->toRenderable();
    $table = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Title'),
        $this
          ->t('Paths'),
        $this
          ->t('Roles'),
        $this
          ->t('Scope'),
        $this
          ->t('Operations'),
      ],
      '#empty' => $this
        ->t('No profiles configured yet. @link.', array(
        '@link' => \Drupal::service('renderer')
          ->render($link),
      )),
    ];
    $role_names = user_role_names();

    // List each profile on the overview page.
    foreach ($settings as $delta => $profile) {
      $key = $profile['name'];
      $path_list = [
        '#theme' => 'item_list',
        '#title' => \Drupal\Component\Utility\Unicode::ucfirst($profile['paths']['visibility']),
      ];
      foreach (explode("\n", $profile['paths']['paths']) as $path) {
        $path_list['#items'][] = [
          '#plain_text' => $path,
        ];
      }
      $role_list = [
        '#theme' => 'item_list',
        '#title' => \Drupal\Component\Utility\Unicode::ucfirst($profile['roles']['visibility']),
        '#items' => array_intersect_key($role_names, array_flip($profile['roles']['list'])),
      ];
      $table[$key] = [
        'name' => [
          '#plain_text' => $profile['name'],
        ],
        'paths' => $path_list,
        'roles' => $role_list,
        'scope' => [
          '#plain_text' => \Drupal\Component\Utility\Unicode::ucfirst($profile['scope']),
        ],
      ];

      // Show all possible operations on the profile.
      // @FIXME - Check if profile is code or in settings.
      //      if (in_array($settings, \Drupal::config('add_to_head.settings')->get('add_to_head_profiles'))) {
      if (TRUE) {

        // This profile is in the DB. It can be modified through the Web UI.
        $params = [
          'profile' => $profile['name'],
        ];
        $table[$key]['ops'] = [
          '#type' => 'operations',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('add_to_head.edit_profile', $params),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('add_to_head.delete_profile', $params),
            ],
          ],
        ];
      }
      else {

        // The profile is in code only. It cannot be edited from here so show a message.
        $table[$key]['ops']['#plain_text'] = $this
          ->t('None (in code)');
      }
    }
    return $table;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddToHeadController::adminOverview public function
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::$entityManager protected property The entity manager.
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.