class MappedObjectList in Salesforce Suite 8.3
Provides a list controller for salesforce_mapping entity.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\salesforce_mapping\MappedObjectList
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of MappedObjectList
File
- modules/
salesforce_mapping/ src/ MappedObjectList.php, line 17
Namespace
Drupal\salesforce_mappingView source
class MappedObjectList extends EntityListBuilder {
/**
* The url generator.
*
* @var \Drupal\Core\Routing\UrlGeneratorInterface
*/
protected $urlGenerator;
/**
* Set entityIds to show a partial listing of mapped objects.
*
* @var array
*/
protected $entityIds;
/**
* {@inheritdoc}
*/
public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
return new static($entity_type, $container
->get('entity.manager')
->getStorage($entity_type
->id()), $container
->get('url_generator'));
}
/**
* Constructs a new MappedObjectList object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage class.
* @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
* The url generator.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, UrlGeneratorInterface $url_generator) {
parent::__construct($entity_type, $storage);
$this->urlGenerator = $url_generator;
}
/**
* {@inheritdoc}
*
* We override ::render() so that we can add our own content above the table.
* parent::render() is where EntityListBuilder creates the table using our
* buildHeader() and buildRow() implementations.
*/
public function render() {
$build['description'] = [
'#markup' => $this
->t('Manage the fields on the <a href="@adminlink">Mappings</a>.', [
'@adminlink' => $this->urlGenerator
->generateFromRoute('entity.salesforce_mapping.list'),
]),
];
$build['table'] = parent::render();
return $build;
}
/**
* {@inheritdoc}
*
* Building the header and content lines for the SF Mapped Object list.
*
* Calling the parent::buildHeader() adds a column for the possible actions
* and inserts the 'edit' and 'delete' links as defined for the entity type.
*/
public function buildHeader() {
$header['id'] = [
'data' => $this
->t('ID'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
];
$header['mapped_entity'] = $this
->t('Entity');
$header['salesforce_link'] = $this
->t('Salesforce Record');
$header['mapping'] = [
'data' => $this
->t('Mapping'),
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
];
$header['changed'] = [
'data' => $this
->t('Last Updated'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
];
return $header + parent::buildHeader();
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
$row['id'] = $entity
->id();
$row['mapped_entity']['data'] = $entity->drupal_entity
->first()
->view();
$row['salesforce_link']['data'] = $entity->salesforce_link
->first()
->view();
$row['mapping']['data'] = $entity->salesforce_mapping
->first()
->view();
$row['changed'] = \Drupal::service('date.formatter')
->format($entity->changed->value);
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function getOperations(EntityInterface $entity) {
$operations['view'] = [
'title' => $this
->t('View'),
'weight' => -100,
'url' => $entity
->urlInfo('canonical'),
];
$operations += parent::getDefaultOperations($entity);
return $operations;
}
/**
* Set the given entity ids to show only those in a listing of mapped objects.
*
* @param array $ids
* The entity ids.
*
* @return $this
*/
public function setEntityIds(array $ids) {
$this->entityIds = $ids;
return $this;
}
/**
* {@inheritdoc}
*/
protected function getEntityIds() {
// If we're building a partial list, only query for those entities.
if (!empty($this->entityIds)) {
return $this->entityIds;
}
return parent::getEntityIds();
}
}
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 | Gets this list's default operations. | 2 |
EntityListBuilder:: |
protected | function | Gets the label of an entity. | |
EntityListBuilder:: |
public | function |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
EntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface:: |
4 |
MappedObjectList:: |
protected | property | Set entityIds to show a partial listing of mapped objects. | |
MappedObjectList:: |
protected | property | The url generator. | |
MappedObjectList:: |
public | function |
Building the header and content lines for the SF Mapped Object list. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
protected | function |
Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
public | function |
We override ::render() so that we can add our own content above the table.
parent::render() is where EntityListBuilder creates the table using our
buildHeader() and buildRow() implementations. Overrides EntityListBuilder:: |
|
MappedObjectList:: |
public | function | Set the given entity ids to show only those in a listing of mapped objects. | |
MappedObjectList:: |
public | function |
Constructs a new MappedObjectList 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. |