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
- 4.0.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\content_entity_example\Entity\Controller\ContactListBuilder extends \Drupal\Core\Entity\EntityListBuilder
Expanded class hierarchy of ContactListBuilder
Related topics
File
-
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 $entity \Drupal\content_entity_example\Entity\Contact */
$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 |
---|---|---|---|
ContactListBuilder::$urlGenerator | protected | property | The url generator. |
ContactListBuilder::buildHeader | public | function | Building the header and content lines for the contact list. |
ContactListBuilder::buildRow | public | function | |
ContactListBuilder::createInstance | public static | function | |
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. |
ContactListBuilder::__construct | public | function | Constructs a new ContactListBuilder object. |