You are here

Home » API reference » Simple XML sitemap 4.x » SimpleSitemapListBuilder.php

class SimpleSitemapListBuilder in Simple XML sitemap 4.x

Class SimpleSitemapListBuilder

Hierarchy

Expanded class hierarchy of SimpleSitemapListBuilder

File

src/SimpleSitemapListBuilder.php, line 16

Namespace

Drupal\simple_sitemap
View source 
class SimpleSitemapListBuilder extends DraggableListBuilder {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'simple_sitemap_overview_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['name'] = $this
      ->t('Sitemap');
    $header['type'] = $this
      ->t('Type');
    $header['status'] = $this
      ->t('Status');
    $header['count'] = $this
      ->t('Link count');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['name']['#markup'] = '<span title="' . $this
      ->t((string) $entity
      ->get('description')) . '">' . $this
      ->t($entity
      ->label()) . '</span>';
    $row['type']['#markup'] = '<span title="' . $this
      ->t((string) $entity
      ->getType()
      ->get('description')) . '">' . $this
      ->t($entity
      ->getType()
      ->label()) . '</span>';
    $row['status']['#markup'] = $this
      ->t('pending');
    $row['count']['#markup'] = '';

    /** @var \Drupal\simple_sitemap\Entity\SimpleSitemapInterface $entity */
    if (!empty($entity
      ->fromPublishedAndUnpublished()
      ->getChunkCount())) {
      switch ($entity
        ->contentStatus()) {
        case SimpleSitemap::SITEMAP_UNPUBLISHED:
          $row['status']['#markup'] = $this
            ->t('generating');
          break;
        case SimpleSitemap::SITEMAP_PUBLISHED:
        case SimpleSitemap::SITEMAP_PUBLISHED_GENERATING:
          $row['name']['#markup'] = '<a title ="' . $this
            ->t((string) $entity
            ->get('description')) . '" href="' . $entity
            ->toUrl()
            ->toString() . '" target="_blank">' . $this
            ->t($entity
            ->label()) . '</a>';
          $row['status']['#markup'] = $this
            ->t($entity
            ->contentStatus() === SimpleSitemap::SITEMAP_PUBLISHED ? 'published on @time' : 'published on @time, regenerating', [
            '@time' => \Drupal::service('date.formatter')
              ->format($entity
              ->fromPublished()
              ->getCreated()),
          ]);
          $row['count']['#markup'] = $entity
            ->fromPublished()
            ->getLinkCount();
          break;
      }
    }
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) : array {
    return [
      [
        'title' => $this
          ->t('Edit'),
        'url' => $entity
          ->toUrl('edit-form'),
      ],
      [
        'title' => $this
          ->t('Delete'),
        'url' => $entity
          ->toUrl('delete-form'),
      ],
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form = \Drupal::formBuilder()
      ->getForm(StatusForm::class) + $form;
    $form['entities']['#empty'] = $this
      ->t('No sitemaps have been defined yet. <a href="@url">Add a new one</a>.', [
      '@url' => Url::fromRoute('simple_sitemap.add')
        ->toString(),
    ]);
    $form['#prefix'] = FormHelper::getDonationText();
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 1
DraggableListBuilder::submitForm public function Form submission handler. Overrides FormInterface::submitForm 5
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
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.
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::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
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::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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.
SimpleSitemapListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
SimpleSitemapListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
SimpleSitemapListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
SimpleSitemapListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
SimpleSitemapListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.