class AdminController
Controller for admin section.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait- class \Drupal\system\Controller\AdminController extends \Drupal\Core\Controller\ControllerBase
 
Expanded class hierarchy of AdminController
File
- 
              core/modules/ system/ src/ Controller/ AdminController.php, line 12 
Namespace
Drupal\system\ControllerView source
class AdminController extends ControllerBase {
  
  /**
   * The module extension list.
   *
   * @var \Drupal\Core\Extension\ModuleExtensionList
   */
  protected $moduleExtensionList;
  
  /**
   * AdminController constructor.
   *
   * @param \Drupal\Core\Extension\ModuleExtensionList|null $extension_list_module
   *   The module extension list. This is left optional for BC reasons, but the
   *   optional usage is deprecated and will become required in Drupal 9.0.0.
   */
  public function __construct(ModuleExtensionList $extension_list_module = NULL) {
    if ($extension_list_module === NULL) {
      @trigger_error('Calling AdminController::__construct() with the $module_extension_list argument is supported in drupal:8.8.0 and will be required before drupal:9.0.0. See https://www.drupal.org/node/2709919.', E_USER_DEPRECATED);
      $extension_list_module = \Drupal::service('extension.list.module');
    }
    $this->moduleExtensionList = $extension_list_module;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container->get('extension.list.module'));
  }
  
  /**
   * Prints a listing of admin tasks, organized by module.
   *
   * @return array
   *   A render array containing the listing.
   */
  public function index() {
    $module_info = $this->moduleExtensionList
      ->getAllInstalledInfo();
    foreach ($module_info as $module => $info) {
      $module_info[$module] = new \stdClass();
      $module_info[$module]->info = $info;
    }
    uasort($module_info, 'system_sort_modules_by_info_name');
    $menu_items = [];
    foreach ($module_info as $module => $info) {
      // Only display a section if there are any available tasks.
      if ($admin_tasks = system_get_module_admin_tasks($module, $info->info)) {
        // Sort links by title.
        uasort($admin_tasks, [
          '\\Drupal\\Component\\Utility\\SortArray',
          'sortByTitleElement',
        ]);
        // Move 'Configure permissions' links to the bottom of each section.
        $permission_key = "user.admin_permissions.{$module}";
        if (isset($admin_tasks[$permission_key])) {
          $permission_task = $admin_tasks[$permission_key];
          unset($admin_tasks[$permission_key]);
          $admin_tasks[$permission_key] = $permission_task;
        }
        $menu_items[$info->info['name']] = [
          $info->info['description'],
          $admin_tasks,
        ];
      }
    }
    $output = [
      '#theme' => 'system_admin_index',
      '#menu_items' => $menu_items,
    ];
    return $output;
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AdminController::$moduleExtensionList | protected | property | The module extension list. | |||
| AdminController::create | public static | function | Instantiates a new instance of this class. | Overrides ControllerBase::create | ||
| AdminController::index | public | function | Prints a listing of admin tasks, organized by module. | |||
| AdminController::__construct | public | function | AdminController constructor. | |||
| 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::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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
