class MappingListBuilder in GatherContent 8.5
Same name and namespace in other branches
- 8.4 gathercontent_ui/src/MappingListBuilder.php \Drupal\gathercontent_ui\MappingListBuilder
Provides a listing of GatherContent Mapping entities.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\gathercontent_ui\MappingListBuilder uses StringTranslationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of MappingListBuilder
File
- gathercontent_ui/
src/ MappingListBuilder.php, line 19
Namespace
Drupal\gathercontent_uiView source
class MappingListBuilder extends ConfigEntityListBuilder {
use StringTranslationTrait;
/**
* Templates array.
*
* @var array
*/
protected $templates;
/**
* Client for querying the GatherContent API.
*
* @var \Drupal\gathercontent\DrupalGatherContentClient
*/
protected $client;
/**
* Entity query service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* Request service.
*
* @var \Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* {@inheritdoc}
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, GatherContentClientInterface $client, EntityTypeManagerInterface $entityTypeManager, Request $request) {
parent::__construct($entity_type, $storage);
$this->client = $client;
$this->entityTypeManager = $entityTypeManager;
$this->request = $request;
}
/**
* {@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('gathercontent.client'), $container
->get('entity_type.manager'), $container
->get('request_stack')
->getCurrentRequest());
}
/**
* {@inheritdoc}
*/
public function load() {
$entity_query = $this->entityTypeManager
->getStorage('gathercontent_mapping')
->getQuery();
$query_string = $this->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 = mb_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',
],
'entity_type' => [
'data' => $this
->t('Entity type'),
'field' => 'entity_type',
'specifier' => 'entity_type',
],
'content_type_name' => [
'data' => $this
->t('Bundle'),
'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\Mapping $entity */
$exists = isset($this->templates[$entity
->getGathercontentTemplateId()]);
$row['project'] = $entity
->getGathercontentProject();
$row['gathercontent_template'] = $entity
->getGathercontentTemplate();
$row['entity_type'] = $entity
->getFormattedEntityType();
$row['content_type'] = $entity
->getFormattedContentType();
$row['updated_gathercontent'] = $exists ? \Drupal::service('date.formatter')
->format($this->templates[$entity
->getGathercontentTemplateId()], 'custom', 'M d, Y - H:i') : $this
->t("Deleted");
$row['updated_drupal'] = $entity
->getFormatterUpdatedDrupal();
$row = $row + parent::buildRow($entity);
return $row;
}
/**
* {@inheritdoc}
*/
public function render() {
$account_id = DrupalGatherContentClient::getAccountId();
if (!$account_id) {
return parent::render();
}
$entityStorage = $this->entityTypeManager
->getStorage('gathercontent_mapping');
$projects = $this->client
->getActiveProjects($account_id);
foreach ($projects['data'] as $project) {
$mappings = $entityStorage
->loadByProperties([
'gathercontent_project_id' => $project->id,
]);
if (!$mappings) {
continue;
}
$remote_templates = $this->client
->templatesGet($project->id);
foreach ($remote_templates['data'] as $remote_template) {
$this->templates[$remote_template->id] = strtotime($remote_template->updatedAt);
}
}
return parent::render();
}
/**
* {@inheritdoc}
*/
public function getDefaultOperations(EntityInterface $entity) {
$exists = isset($this->templates[$entity
->getGathercontentTemplateId()]);
$operations = [];
if ($exists && $entity
->access('update') && $entity
->hasLinkTemplate('edit-form')) {
$operations['edit'] = [
'title' => $entity
->hasMapping() ? $this
->t('Edit') : $this
->t('Create'),
'weight' => 10,
'url' => $entity
->toUrl('edit-form'),
];
}
if ($entity
->access('delete') && $entity
->hasLinkTemplate('delete-form')) {
$operations['delete'] = [
'title' => $this
->t('Delete'),
'weight' => 100,
'url' => $entity
->toUrl('delete-form'),
];
}
return $operations;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 2 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 2 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityListBuilder:: |
protected | property | Information about the entity type. | |
EntityListBuilder:: |
protected | property | The entity type ID. | |
EntityListBuilder:: |
protected | property | The number of entities to list per page, or FALSE to list all entities. | 3 |
EntityListBuilder:: |
protected | property | The entity storage class. | 1 |
EntityListBuilder:: |
public | function | Builds a renderable list of operation links for the entity. | 2 |
EntityListBuilder:: |
protected | function | Ensures that a destination is present on the given URL. | |
EntityListBuilder:: |
protected | function | Loads entity IDs using a pager sorted by the entity id. | 4 |
EntityListBuilder:: |
protected | function | Gets the label of an entity. | |
EntityListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface:: |
2 |
EntityListBuilder:: |
public | function |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
MappingListBuilder:: |
protected | property | Client for querying the GatherContent API. | |
MappingListBuilder:: |
protected | property | Entity query service. | |
MappingListBuilder:: |
protected | property | Request service. | |
MappingListBuilder:: |
protected | property | Templates array. | |
MappingListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
MappingListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
MappingListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
MappingListBuilder:: |
public | function |
Gets this list's default operations. Overrides ConfigEntityListBuilder:: |
|
MappingListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder:: |
|
MappingListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder:: |
|
MappingListBuilder:: |
public | function |
Constructs a new EntityListBuilder object. Overrides EntityListBuilder:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |