class XmlSitemapListBuilder in XML sitemap 8

Same name and namespace in other branches

2.x src/XmlSitemapListBuilder.php \Drupal\xmlsitemap\XmlSitemapListBuilder

Provides a listing of XmlSitemap.

View source

class XmlSitemapListBuilder extends ConfigEntityListBuilder {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The language manager.
   *
   * @var \Drupal\language\ConfigurableLanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Constructs a XmlSitemapListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ModuleHandlerInterface $module_handler, LanguageManagerInterface $language_manager) {
    parent::__construct($entity_type, $storage);
    $this->moduleHandler = $module_handler;
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('module_handler'), $container
      ->get('language_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    xmlsitemap_check_status();
    return parent::render();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('XmlSitemap');
    if ($this->moduleHandler
      ->moduleExists('language')) {
      $header['language'] = $this
        ->t('Language');
    }
    $header['id'] = $this
      ->t('Sitemap ID');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\xmlsitemap\XmlSitemapInterface $entity */
    $row['label'] = $entity
      ->label();
    if ($this->moduleHandler
      ->moduleExists('language')) {
      if (isset($entity
        ->getContext()['language'])) {
        $language = $this->languageManager
          ->getLanguage($entity
          ->getContext()['language']);

        // In some cases ::getLanguage() can return NULL value.
        if (!is_null($language) && $language instanceof LanguageInterface) {
          $row['language'] = $language
            ->getName();
        }
        else {
          \Drupal::logger('xmlsitemap')
            ->notice('Cannot determine language for sitemap @id', [
            '@id' => $entity
              ->id(),
          ]);

          // Set as default row value.
          $row['language'] = $this
            ->t('Undefined');
        }
      }
      else {
        $row['language'] = $this
          ->t('Undefined');
      }
    }
    $row['id'] = $entity
      ->id();

    // You probably want a few more properties here...
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {

    /** @var \Drupal\xmlsitemap\XmlSitemapInterface $entity */
    $operations = parent::getOperations($entity);
    if (isset($operations['translate'])) {
      unset($operations['translate']);
    }
    return $operations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
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.
XmlSitemapListBuilder::$languageManager	protected	property	The language manager.
XmlSitemapListBuilder::$moduleHandler	protected	property	The module handler. Overrides EntityHandlerBase::$moduleHandler
XmlSitemapListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
XmlSitemapListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
XmlSitemapListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
XmlSitemapListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
XmlSitemapListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
XmlSitemapListBuilder::__construct	public	function	Constructs a XmlSitemapListBuilder object. Overrides EntityListBuilder::__construct

You are here

class XmlSitemapListBuilder in XML sitemap 8

Hierarchy

File

Namespace

Members

API Navigation