class ContactListBuilder
Same name in other branches
- 3.x modules/content_entity_example/src/Entity/Controller/ContactListBuilder.php \Drupal\content_entity_example\Entity\Controller\ContactListBuilder
Provides a list controller for content_entity_example entity.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityListBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityListBuilderInterface, \Drupal\Core\Entity\EntityHandlerInterface uses \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait
- class \Drupal\content_entity_example\Entity\Controller\ContactListBuilder extends \Drupal\Core\Entity\EntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityListBuilderInterface, \Drupal\Core\Entity\EntityHandlerInterface uses \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait
Expanded class hierarchy of ContactListBuilder
Related topics
File
-
modules/
content_entity_example/ src/ Entity/ Controller/ ContactListBuilder.php, line 17
Namespace
Drupal\content_entity_example\Entity\ControllerView source
class ContactListBuilder extends EntityListBuilder {
/**
* The url generator.
*
* @var \Drupal\Core\Routing\UrlGeneratorInterface
*/
protected $urlGenerator;
/**
* {@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('url_generator'));
}
/**
* Constructs a new ContactListBuilder 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('Content Entity Example implements a Contacts model. These contacts are fieldable entities. You can manage the fields on the <a href="@adminlink">Contacts admin page</a>.', [
'@adminlink' => $this->urlGenerator
->generateFromRoute('content_entity_example.contact_settings'),
]),
];
$build['table'] = parent::render();
return $build;
}
/**
* {@inheritdoc}
*
* Building the header and content lines for the contact 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'] = $this->t('ContactID');
$header['name'] = $this->t('Name');
$header['first_name'] = $this->t('First Name');
$header['role'] = $this->t('Role');
return $header + parent::buildHeader();
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
/** @var \Drupal\content_entity_example\Entity\Contact $entity */
$row['id'] = $entity->id();
$row['name'] = $entity->toLink()
->toString();
$row['first_name'] = $entity->first_name->value;
$row['role'] = $entity->role->value;
return $row + parent::buildRow($entity);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContactListBuilder::$urlGenerator | protected | property | The url generator. | ||
ContactListBuilder::buildHeader | public | function | Building the header and content lines for the contact list. | Overrides EntityListBuilder::buildHeader | |
ContactListBuilder::buildRow | public | function | Builds a row for an entity in the entity listing. | Overrides EntityListBuilder::buildRow | |
ContactListBuilder::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides EntityListBuilder::createInstance | |
ContactListBuilder::render | 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::render | |
ContactListBuilder::__construct | public | function | Constructs a new ContactListBuilder object. | Overrides EntityListBuilder::__construct | |
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
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. | 2 | |
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. | 1 | |
EntityListBuilder::getDefaultOperations | protected | function | Gets this list's default operations. | 3 | |
EntityListBuilder::getEntityIds | protected | function | Loads entity IDs using a pager sorted by the entity id. | 5 | |
EntityListBuilder::getEntityListQuery | protected | function | Returns a query object for loading entity IDs from the storage. | ||
EntityListBuilder::getOperations | public | function | Provides an array of information to build a list of operation links. | Overrides EntityListBuilderInterface::getOperations | 3 |
EntityListBuilder::getStorage | public | function | Gets the entity storage. | Overrides EntityListBuilderInterface::getStorage | 1 |
EntityListBuilder::getTitle | protected | function | Gets the title of the page. | 1 | |
EntityListBuilder::load | public | function | Loads entities of this type from storage for listing. | Overrides EntityListBuilderInterface::load | 4 |
MessengerTrait::$messenger | protected | property | The messenger. | 16 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 16 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 2 | |
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. | 3 | |
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. |