You are here

class XmlSitemapCustomListController in XML sitemap 8

Same name and namespace in other branches
  1. 2.x xmlsitemap_custom/src/Controller/XmlSitemapCustomListController.php \Drupal\xmlsitemap_custom\Controller\XmlSitemapCustomListController

Builds the list table for all custom links.

Hierarchy

Expanded class hierarchy of XmlSitemapCustomListController

File

xmlsitemap_custom/src/Controller/XmlSitemapCustomListController.php, line 17

Namespace

Drupal\xmlsitemap_custom\Controller
View source
class XmlSitemapCustomListController extends ControllerBase {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * XmlSitemapCustomListController constructor.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   */
  public function __construct(Connection $connection) {
    $this->connection = $connection;
  }

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

  /**
   * Renders a list with all custom links.
   *
   * @return array
   *   The list to be rendered.
   */
  public function render() {
    $build['xmlsitemap_add_custom'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Add custom link'),
      '#href' => 'admin/config/search/xmlsitemap/custom/add',
    ];
    $header = [
      'loc' => [
        'data' => $this
          ->t('Location'),
        'field' => 'loc',
        'sort' => 'asc',
      ],
      'priority' => [
        'data' => $this
          ->t('Priority'),
        'field' => 'priority',
      ],
      'changefreq' => [
        'data' => $this
          ->t('Change frequency'),
        'field' => 'changefreq',
      ],
      'language' => [
        'data' => $this
          ->t('Language'),
        'field' => 'language',
      ],
      'operations' => [
        'data' => $this
          ->t('Operations'),
      ],
    ];
    $rows = [];
    $query = $this->connection
      ->select('xmlsitemap');
    $query
      ->fields('xmlsitemap');
    $query
      ->condition('type', 'custom');
    $query
      ->extend(PagerSelectExtender::class)
      ->limit(50);
    $query
      ->extend(TableSortExtender::class)
      ->orderByHeader($header);
    $result = $query
      ->execute();
    foreach ($result as $link) {
      $language = $this
        ->languageManager()
        ->getLanguage($link->language);
      $row = [];
      $row['loc'] = Link::fromTextAndUrl($link->loc, Url::fromUri('internal:' . $link->loc));
      $row['priority'] = number_format($link->priority, 1);
      $row['changefreq'] = $link->changefreq ? Unicode::ucfirst(xmlsitemap_get_changefreq($link->changefreq)) : $this
        ->t('None');
      if (isset($header['language'])) {
        $row['language'] = $language
          ->getName();
      }
      $operations['edit'] = [
        'title' => $this
          ->t('Edit'),
        'url' => Url::fromRoute('xmlsitemap_custom.edit', [
          'link' => $link->id,
        ]),
      ];
      $operations['delete'] = [
        'title' => $this
          ->t('Delete'),
        'url' => Url::fromRoute('xmlsitemap_custom.delete', [
          'link' => $link->id,
        ]),
      ];
      $row['operations'] = [
        'data' => [
          '#type' => 'operations',
          '#links' => $operations,
        ],
      ];
      $rows[] = $row;
    }

    // @todo Convert to tableselect
    $build['xmlsitemap_custom_table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No custom links available. <a href="@custom_link">Add custom link</a>', [
        '@custom_link' => Url::fromRoute('xmlsitemap_custom.add', [], [
          'query' => $this
            ->getDestinationArray(),
        ])
          ->toString(),
      ]),
    ];
    $build['xmlsitemap_custom_pager'] = [
      '#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.
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.
XmlSitemapCustomListController::$connection protected property The database connection.
XmlSitemapCustomListController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
XmlSitemapCustomListController::render public function Renders a list with all custom links.
XmlSitemapCustomListController::__construct public function XmlSitemapCustomListController constructor.