class GroupListBuilder in Group 8
Same name and namespace in other branches
- 2.0.x src/Entity/Controller/GroupListBuilder.php \Drupal\group\Entity\Controller\GroupListBuilder
Provides a list controller for group entities.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
- class \Drupal\group\Entity\Controller\GroupListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of GroupListBuilder
File
- src/
Entity/ Controller/ GroupListBuilder.php, line 21
Namespace
Drupal\group\Entity\ControllerView source
class GroupListBuilder extends EntityListBuilder {
/**
* The redirect destination service.
*
* @var \Drupal\Core\Routing\RedirectDestinationInterface
*/
protected $redirectDestination;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The router.
*
* @var \Symfony\Component\Routing\RouterInterface
*/
protected $router;
/**
* Constructs a new GroupListBuilder 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\RedirectDestinationInterface $redirect_destination
* The redirect destination service.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Symfony\Component\Routing\RouterInterface $router
* The router.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RedirectDestinationInterface $redirect_destination, AccountInterface $current_user, ModuleHandlerInterface $module_handler, RouterInterface $router) {
parent::__construct($entity_type, $storage);
$this->redirectDestination = $redirect_destination;
$this->currentUser = $current_user;
$this->moduleHandler = $module_handler;
$this->router = $router;
}
/**
* {@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('redirect.destination'), $container
->get('current_user'), $container
->get('module_handler'), $container
->get('router.no_access_checks'));
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
$header = [
'gid' => [
'data' => $this
->t('Group ID'),
'specifier' => 'id',
'field' => 'id',
],
'label' => [
'data' => $this
->t('Name'),
'specifier' => 'label',
'field' => 'label',
],
'type' => [
'data' => $this
->t('Type'),
'specifier' => 'type',
'field' => 'type',
],
'status' => [
'data' => $this
->t('Status'),
'specifier' => 'status',
'field' => 'status',
],
'uid' => [
'data' => $this
->t('Owner'),
],
];
return $header + parent::buildHeader();
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
/** @var \Drupal\group\Entity\GroupInterface $entity */
$row['id'] = $entity
->id();
// EntityListBuilder sets the table rows using the #rows property, so we
// need to add the render array using the 'data' key.
$row['name']['data'] = $entity
->toLink()
->toRenderable();
$row['type'] = $entity
->getGroupType()
->label();
$row['status'] = $entity
->isPublished() ? $this
->t('Published') : $this
->t('Unpublished');
$row['uid'] = $entity
->getOwner()
->label();
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function render() {
$build = parent::render();
$build['table']['#empty'] = $this
->t('There are no groups yet.');
return $build;
}
/**
* {@inheritdoc}
*/
protected function getEntityIds() {
$query = $this
->getStorage()
->getQuery();
// Add a simple table sort by header, see ::buildHeader().
$header = $this
->buildHeader();
$query
->tableSort($header);
// Only add the pager if a limit is specified.
if ($this->limit) {
$query
->pager($this->limit);
}
return $query
->execute();
}
/**
* {@inheritdoc}
*/
protected function getDefaultOperations(EntityInterface $entity) {
$operations = parent::getDefaultOperations($entity);
/** @var \Drupal\group\Entity\GroupInterface $entity */
if ($this->moduleHandler
->moduleExists('views') && $entity
->hasPermission('administer members', $this->currentUser)) {
if ($this->router
->getRouteCollection()
->get('view.group_members.page_1') !== NULL) {
$operations['members'] = [
'title' => $this
->t('Members'),
'weight' => 15,
'url' => Url::fromRoute('view.group_members.page_1', [
'group' => $entity
->id(),
]),
];
}
}
if ($entity
->getGroupType()
->shouldCreateNewRevision() && $entity
->hasPermission('view group revisions', $this->currentUser)) {
$operations['revisions'] = [
'title' => $this
->t('Revisions'),
'weight' => 20,
'url' => $entity
->toUrl('version-history'),
];
}
// Add the current path or destination as a redirect to the operation links.
$destination = $this->redirectDestination
->getAsArray();
foreach ($operations as $key => $operation) {
$operations[$key]['query'] = $destination;
}
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 | 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 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 |
EntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface:: |
4 |
GroupListBuilder:: |
protected | property | The current user. | |
GroupListBuilder:: |
protected | property |
The module handler. Overrides EntityHandlerBase:: |
|
GroupListBuilder:: |
protected | property |
The redirect destination service. Overrides RedirectDestinationTrait:: |
|
GroupListBuilder:: |
protected | property | The router. | |
GroupListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
protected | function |
Gets this list's default operations. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
protected | function |
Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder:: |
|
GroupListBuilder:: |
public | function |
Constructs a new GroupListBuilder object. Overrides EntityListBuilder:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
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. |