You are here

Home » API reference » GatherContent 8 » GathercontentMappingListBuilder.php

class GathercontentMappingListBuilder in GatherContent 8

Provides a listing of GatherContent Mapping entities.

Hierarchy

Expanded class hierarchy of GathercontentMappingListBuilder

File

src/GathercontentMappingListBuilder.php, line 14

Namespace

Drupal\gathercontent
View source 
class GathercontentMappingListBuilder extends ConfigEntityListBuilder {
  protected $templates;

  /**
   * {@inheritdoc}
   */
  public function load() {

    /** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface|\Drupal\Core\Entity\Query\QueryInterface $entity_query */
    $entity_query = \Drupal::service('entity.query')
      ->get('gathercontent_mapping');
    $query_string = \Drupal::request()->query;
    $headers = $this
      ->buildHeader();
    $entity_query
      ->pager(100);
    if ($query_string
      ->has('order')) {
      foreach ($headers as $header) {
        if (is_array($header) && $header['data'] === $query_string
          ->get('order')) {
          $sort = 'ASC';
          if ($query_string
            ->has('sort') && $query_string
            ->get('sort') === 'asc' || $query_string
            ->get('sort') === 'desc') {
            $sort = Unicode::strtoupper($query_string
              ->get('sort'));
          }
          $entity_query
            ->sort($header['field'], $sort);
        }
      }
    }
    $entity_query
      ->tableSort($headers);
    $entity_ids = $entity_query
      ->execute();
    return $this->storage
      ->loadMultiple($entity_ids);
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    return [
      'gathercontent_project' => [
        'data' => $this
          ->t('GatherContent Project'),
        'field' => 'gathercontent_project',
        'specifier' => 'gathercontent_project',
      ],
      'gathercontent_template' => [
        'data' => $this
          ->t('GatherContent Template'),
        'field' => 'gathercontent_template',
        'specifier' => 'gathercontent_template',
      ],
      'content_type_name' => [
        'data' => $this
          ->t('Content type'),
        'field' => 'content_type_name',
        'specifier' => 'content_type_name',
      ],
      'updated_gathercontent' => [
        'data' => $this
          ->t('Last updated in GatherContent'),
      ],
      'updated_drupal' => [
        'data' => $this
          ->t('Updated in Drupal'),
        'field' => 'updated_drupal',
        'specifier' => 'updated_drupal',
      ],
    ] + parent::buildHeader();
  }

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

    /** @var \Drupal\gathercontent\Entity\GathercontentMapping $entity */
    $exists = isset($this->templates[$entity
      ->getGathercontentTemplateId()]);
    $row['project'] = $entity
      ->getGathercontentProject();
    $row['gathercontent_template'] = $entity
      ->getGathercontentTemplate();
    $row['content_type'] = $entity
      ->getFormattedContentType();
    $row['updated_gathercontent'] = $exists ? \Drupal::service('date.formatter')
      ->format($this->templates[$entity
      ->getGathercontentTemplateId()], 'custom', 'M d, Y - H:i') : t("Deleted");
    $row['updated_drupal'] = $entity
      ->getFormatterUpdatedDrupal();
    if ($exists) {
      $row = $row + parent::buildRow($entity);
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $project_obj = new Project();
    $projects = $project_obj
      ->getProjectObjects();
    $temp_obj = new Template();
    foreach ($projects as $project) {
      $remote_templates = $temp_obj
        ->getTemplatesObject($project->id);
      foreach ($remote_templates as $remote_template) {
        $this->templates[$remote_template->id] = $remote_template->updated_at;
      }
    }
    return parent::render();
  }
  public function getDefaultOperations(EntityInterface $entity) {
    if ($entity
      ->access('update') && $entity
      ->hasLinkTemplate('edit-form')) {
      $operations['edit'] = array(
        'title' => $entity
          ->hasMapping() ? $this
          ->t('Edit') : $this
          ->t('Setup'),
        'weight' => 10,
        'url' => $entity
          ->urlInfo('edit-form'),
      );
    }
    if ($entity
      ->access('delete') && $entity
      ->hasLinkTemplate('delete-form')) {
      $operations['delete'] = array(
        'title' => $this
          ->t('Delete'),
        'weight' => 100,
        'url' => $entity
          ->urlInfo('delete-form'),
      );
    }
    return $operations;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 property The module handler to invoke hooks on. 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::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::getLabel Deprecated protected function Gets the label of an entity.
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
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 16
GathercontentMappingListBuilder::$templates protected property
GathercontentMappingListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
GathercontentMappingListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
GathercontentMappingListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
GathercontentMappingListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
GathercontentMappingListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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.