You are here

Home » API reference » Zircon Profile 8 » PathController.php

class PathController in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/path/src/Controller/PathController.php \Drupal\path\Controller\PathController

Controller routines for path routes.

Hierarchy

Expanded class hierarchy of PathController

File

core/modules/path/src/Controller/PathController.php, line 21
Contains \Drupal\path\Controller\PathController.

Namespace

Drupal\path\Controller
View source 
class PathController extends ControllerBase {

  /**
   * The path alias storage.
   *
   * @var \Drupal\Core\Path\AliasStorageInterface
   */
  protected $aliasStorage;

  /**
   * The path alias manager.
   *
   * @var \Drupal\Core\Path\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * Constructs a new PathController.
   *
   * @param \Drupal\Core\Path\AliasStorageInterface $alias_storage
   *   The path alias storage.
   * @param \Drupal\Core\Path\AliasManagerInterface $alias_manager
   *   The path alias manager.
   */
  public function __construct(AliasStorageInterface $alias_storage, AliasManagerInterface $alias_manager) {
    $this->aliasStorage = $alias_storage;
    $this->aliasManager = $alias_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('path.alias_storage'), $container
      ->get('path.alias_manager'));
  }

  /**
   * Displays the path administration overview page.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function adminOverview(Request $request) {
    $keys = $request->query
      ->get('search');

    // Add the filter form above the overview table.
    $build['path_admin_filter_form'] = $this
      ->formBuilder()
      ->getForm('Drupal\\path\\Form\\PathFilterForm', $keys);

    // Enable language column if language.module is enabled or if we have any
    // alias with a language.
    $multilanguage = $this
      ->moduleHandler()
      ->moduleExists('language') || $this->aliasStorage
      ->languageAliasExists();
    $header = array();
    $header[] = array(
      'data' => $this
        ->t('Alias'),
      'field' => 'alias',
      'sort' => 'asc',
    );
    $header[] = array(
      'data' => $this
        ->t('System'),
      'field' => 'source',
    );
    if ($multilanguage) {
      $header[] = array(
        'data' => $this
          ->t('Language'),
        'field' => 'langcode',
      );
    }
    $header[] = $this
      ->t('Operations');
    $rows = array();
    $destination = $this
      ->getDestinationArray();
    foreach ($this->aliasStorage
      ->getAliasesForAdminListing($header, $keys) as $data) {
      $row = array();

      // @todo Should Path module store leading slashes? See
      //   https://www.drupal.org/node/2430593.
      $row['data']['alias'] = $this
        ->l(Unicode::truncate($data->alias, 50, FALSE, TRUE), Url::fromUserInput($data->source, array(
        'attributes' => array(
          'title' => $data->alias,
        ),
      )));
      $row['data']['source'] = $this
        ->l(Unicode::truncate($data->source, 50, FALSE, TRUE), Url::fromUserInput($data->source, array(
        'alias' => TRUE,
        'attributes' => array(
          'title' => $data->source,
        ),
      )));
      if ($multilanguage) {
        $row['data']['language_name'] = $this
          ->languageManager()
          ->getLanguageName($data->langcode);
      }
      $operations = array();
      $operations['edit'] = array(
        'title' => $this
          ->t('Edit'),
        'url' => Url::fromRoute('path.admin_edit', [
          'pid' => $data->pid,
        ], [
          'query' => $destination,
        ]),
      );
      $operations['delete'] = array(
        'title' => $this
          ->t('Delete'),
        'url' => Url::fromRoute('path.delete', [
          'pid' => $data->pid,
        ], [
          'query' => $destination,
        ]),
      );
      $row['data']['operations'] = array(
        'data' => array(
          '#type' => 'operations',
          '#links' => $operations,
        ),
      );

      // If the system path maps to a different URL alias, highlight this table
      // row to let the user know of old aliases.
      if ($data->alias != $this->aliasManager
        ->getAliasByPath($data->source, $data->langcode)) {
        $row['class'] = array(
          'warning',
        );
      }
      $rows[] = $row;
    }
    $build['path_table'] = array(
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No URL aliases available. <a href=":link">Add URL alias</a>.', array(
        ':link' => $this
          ->url('path.admin_add'),
      )),
    );
    $build['path_pager'] = array(
      '#type' => 'pager',
    );
    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::$entityManager protected property The entity manager. 1
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 3
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. 1
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 3
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::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
PathController::$aliasManager protected property The path alias manager.
PathController::$aliasStorage protected property The path alias storage.
PathController::adminOverview public function Displays the path administration overview page.
PathController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
PathController::__construct public function Constructs a new PathController.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
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 protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.