class WebformEntityListBuilder in Webform 8.5
Same name and namespace in other branches
- 6.x src/WebformEntityListBuilder.php \Drupal\webform\WebformEntityListBuilder
Defines a class to build a listing of webform 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\webform\WebformEntityListBuilder
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of WebformEntityListBuilder
See also
\Drupal\webform\Entity\Webform
File
- src/
WebformEntityListBuilder.php, line 24
Namespace
Drupal\webformView source
class WebformEntityListBuilder extends ConfigEntityListBuilder {
/**
* The current request.
*
* @var \Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* Search keys.
*
* @var string
*/
protected $keys;
/**
* Search category.
*
* @var string
*/
protected $category;
/**
* Search state.
*
* @var string
*/
protected $state;
/**
* Bulk operations.
*
* @var bool
*/
protected $bulkOperations;
/**
* The webform submission storage.
*
* @var \Drupal\webform\WebformSubmissionStorageInterface
*/
protected $submissionStorage;
/**
* The user storage.
*
* @var \Drupal\user\UserStorageInterface
*/
protected $userStorage;
/**
* The role storage.
*
* @var \Drupal\user\RoleStorageInterface
*/
protected $roleStorage;
/**
* Constructs a new WebformListBuilder object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage class.
* @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
* The request stack.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The configuration factory.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RequestStack $request_stack, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, ConfigFactoryInterface $config_factory = NULL) {
parent::__construct($entity_type, $storage);
$this->request = $request_stack
->getCurrentRequest();
$this->currentUser = $current_user;
$query = $this->request->query;
$config = $config_factory
->get('webform.settings');
$this->keys = $query
->has('search') ? $query
->get('search') : '';
$this->category = $query
->has('category') ? $query
->get('category') : $config
->get('form.filter_category');
$this->state = $query
->has('state') ? $query
->get('state') : $config
->get('form.filter_state');
$this->bulkOperations = $config
->get('settings.webform_bulk_form') ?: FALSE;
$this->submissionStorage = $entity_type_manager
->getStorage('webform_submission');
$this->userStorage = $entity_type_manager
->getStorage('user');
$this->roleStorage = $entity_type_manager
->getStorage('user_role');
}
/**
* {@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('request_stack'), $container
->get('current_user'), $container
->get('entity_type.manager'), $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public function render() {
// Handler autocomplete redirect.
if ($this->keys && preg_match('#\\(([^)]+)\\)$#', $this->keys, $match)) {
if ($webform = $this
->getStorage()
->load($match[1])) {
return new RedirectResponse($webform
->toUrl()
->setAbsolute(TRUE)
->toString());
}
}
$build = [];
// Filter form.
$build['filter_form'] = $this
->buildFilterForm();
// Display info.
$build['info'] = $this
->buildInfo();
// Table.
$build += parent::render();
$build['table']['#sticky'] = TRUE;
$build['table']['#attributes']['class'][] = 'webform-forms';
// Bulk operations.
if ($this->bulkOperations && $this->currentUser
->hasPermission('administer webform')) {
$build['table'] = \Drupal::formBuilder()
->getForm('\\Drupal\\webform\\Form\\WebformEntityBulkForm', $build['table']);
}
// Attachments.
// Must preload libraries required by (modal) dialogs.
WebformDialogHelper::attachLibraries($build);
$build['#attached']['library'][] = 'webform/webform.admin';
return $build;
}
/**
* Build the filter form.
*
* @return array
* A render array representing the filter form.
*/
protected function buildFilterForm() {
// Add the filter by key(word) and/or state.
if ($this->currentUser
->hasPermission('administer webform')) {
$state_options = [
(string) $this
->t('Active') => [
'' => $this
->t('All [@total]', [
'@total' => $this
->getTotal(NULL, NULL),
]),
WebformInterface::STATUS_OPEN => $this
->t('Open [@total]', [
'@total' => $this
->getTotal(NULL, NULL, WebformInterface::STATUS_OPEN),
]),
WebformInterface::STATUS_CLOSED => $this
->t('Closed [@total]', [
'@total' => $this
->getTotal(NULL, NULL, WebformInterface::STATUS_CLOSED),
]),
WebformInterface::STATUS_SCHEDULED => $this
->t('Scheduled [@total]', [
'@total' => $this
->getTotal(NULL, NULL, WebformInterface::STATUS_SCHEDULED),
]),
],
(string) $this
->t('Inactive') => [
WebformInterface::STATUS_ARCHIVED => $this
->t('Archived [@total]', [
'@total' => $this
->getTotal(NULL, NULL, WebformInterface::STATUS_ARCHIVED),
]),
],
];
}
else {
$state_options = [
(string) $this
->t('Active') => [
'' => $this
->t('All'),
WebformInterface::STATUS_OPEN => $this
->t('Open'),
WebformInterface::STATUS_CLOSED => $this
->t('Closed'),
WebformInterface::STATUS_SCHEDULED => $this
->t('Scheduled'),
],
(string) $this
->t('Inactive') => [
WebformInterface::STATUS_ARCHIVED => $this
->t('Archived'),
],
];
}
return \Drupal::formBuilder()
->getForm('\\Drupal\\webform\\Form\\WebformEntityFilterForm', $this->keys, $this->category, $this->state, $state_options);
}
/**
* Build information summary.
*
* @return array
* A render array representing the information summary.
*/
protected function buildInfo() {
// Display info.
if ($this->currentUser
->hasPermission('administer webform') && ($total = $this
->getTotal($this->keys, $this->category, $this->state))) {
return [
'#markup' => $this
->formatPlural($total, '@total webform', '@total webforms', [
'@total' => $total,
]),
'#prefix' => '<div>',
'#suffix' => '</div>',
];
}
else {
return [];
}
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
$header['title'] = [
'data' => $this
->t('Title'),
'specifier' => 'title',
'field' => 'title',
'sort' => 'asc',
];
$header['description'] = [
'data' => $this
->t('Description'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
'specifier' => 'description',
'field' => 'description',
];
$header['category'] = [
'data' => $this
->t('Category'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
'specifier' => 'category',
'field' => 'category',
];
$header['status'] = [
'data' => $this
->t('Status'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
'specifier' => 'status',
'field' => 'status',
];
$header['owner'] = [
'data' => $this
->t('Author'),
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
'specifier' => 'uid',
'field' => 'uid',
];
$header['results'] = [
'data' => $this
->t('Results'),
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
'specifier' => 'results',
'field' => 'results',
];
$header['operations'] = [
'data' => $this
->t('Operations'),
];
return $header;
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
/* @var $entity \Drupal\webform\WebformInterface */
// Title.
//
// ISSUE: Webforms that the current user can't access are not being hidden via the EntityQuery.
// WORK-AROUND: Don't link to the webform.
// See: Access control is not applied to config entity queries
// https://www.drupal.org/node/2636066
$row['title']['data']['title'] = [
'#markup' => $entity
->access('submission_page') ? $entity
->toLink()
->toString() : $entity
->label(),
];
if ($entity
->isTemplate()) {
$row['title']['data']['template'] = [
'#markup' => ' <b>(' . $this
->t('Template') . ')</b>',
];
}
// Description.
$row['description']['data'] = WebformHtmlEditor::checkMarkup($entity
->get('description'));
// Category.
$row['category']['data']['#markup'] = $entity
->get('category');
// Status.
$t_args = [
'@label' => $entity
->label(),
];
if ($entity
->isArchived()) {
$row['status']['data'] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#value' => $this
->t('Archived'),
'#attributes' => [
'aria-label' => $this
->t('@label is archived', $t_args),
],
];
$row['status'] = $this
->t('Archived');
}
else {
switch ($entity
->get('status')) {
case WebformInterface::STATUS_OPEN:
$status = $this
->t('Open');
$aria_label = $this
->t('@label is open', $t_args);
break;
case WebformInterface::STATUS_CLOSED:
$status = $this
->t('Closed');
$aria_label = $this
->t('@label is closed', $t_args);
break;
case WebformInterface::STATUS_SCHEDULED:
$status = $this
->t('Scheduled (@state)', [
'@state' => $entity
->isOpen() ? $this
->t('Open') : $this
->t('Closed'),
]);
$aria_label = $this
->t('@label is scheduled and is @state', $t_args + [
'@state' => $entity
->isOpen() ? $this
->t('open') : $this
->t('closed'),
]);
break;
default:
return [];
}
if ($entity
->access('update')) {
$row['status']['data'] = $entity
->toLink($status, 'settings-form', [
'query' => $this
->getDestinationArray(),
])
->toRenderable() + [
'#attributes' => [
'aria-label' => $aria_label,
],
];
}
else {
$row['status']['data'] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#value' => $status,
'#attributes' => [
'aria-label' => $aria_label,
],
];
}
}
// Owner.
$row['owner'] = ($owner = $entity
->getOwner()) ? $owner
->toLink() : '';
// Results.
$result_total = $this->storage
->getTotalNumberOfResults($entity
->id());
$results_disabled = $entity
->isResultsDisabled();
$results_access = $entity
->access('submission_view_any');
if ($results_disabled || !$results_access) {
$row['results'] = ($result_total ? $result_total : '') . ($result_total && $results_disabled ? ' ' : '') . ($results_disabled ? $this
->t('(Disabled)') : '');
}
else {
$row['results'] = [
'data' => [
'#type' => 'link',
'#title' => $result_total,
'#attributes' => [
'aria-label' => $this
->formatPlural($result_total, '@count result for @label', '@count results for @label', [
'@label' => $entity
->label(),
]),
],
'#url' => $entity
->toUrl('results-submissions'),
],
];
}
// Operations.
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function buildOperations(EntityInterface $entity) {
return parent::buildOperations($entity) + [
'#prefix' => '<div class="webform-dropbutton">',
'#suffix' => '</div>',
];
}
/**
* {@inheritdoc}
*/
public function getDefaultOperations(EntityInterface $entity, $type = 'edit') {
/* @var $entity \Drupal\webform\WebformInterface */
$operations = [];
if ($entity
->access('update')) {
$operations['edit'] = [
'title' => $this
->t('Build'),
'url' => $this
->ensureDestination($entity
->toUrl('edit-form')),
'weight' => 0,
];
}
if ($entity
->access('submission_page')) {
$operations['view'] = [
'title' => $this
->t('View'),
'url' => $entity
->toUrl('canonical'),
'weight' => 10,
];
}
if ($entity
->access('test')) {
$operations['test'] = [
'title' => $this
->t('Test'),
'url' => $entity
->toUrl('canonical'),
'weight' => 20,
];
}
if ($entity
->access('submission_view_any') && !$entity
->isResultsDisabled()) {
$operations['results'] = [
'title' => $this
->t('Results'),
'url' => $entity
->toUrl('results-submissions'),
'weight' => 30,
];
}
if ($entity
->access('update')) {
$operations['settings'] = [
'title' => $this
->t('Settings'),
'url' => $entity
->toUrl('settings'),
'weight' => 40,
];
}
if ($entity
->access('duplicate')) {
$operations['duplicate'] = [
'title' => $this
->t('Duplicate'),
'url' => $entity
->toUrl('duplicate-form'),
'attributes' => WebformDialogHelper::getModalDialogAttributes(WebformDialogHelper::DIALOG_NARROW),
'weight' => 90,
];
}
if ($entity
->access('delete') && $entity
->hasLinkTemplate('delete-form')) {
$operations['delete'] = [
'title' => $this
->t('Delete'),
'url' => $this
->ensureDestination($entity
->toUrl('delete-form')),
'attributes' => WebformDialogHelper::getModalDialogAttributes(WebformDialogHelper::DIALOG_NARROW),
'weight' => 100,
];
}
return $operations;
}
/**
* {@inheritdoc}
*/
protected function getEntityIds() {
$header = $this
->buildHeader();
if ($this->request->query
->get('order') === (string) $header['results']['data']) {
// Get results totals for all returned entity ids.
$results_totals = $this
->getQuery($this->keys, $this->category, $this->state)
->execute();
foreach ($results_totals as $entity_id) {
$results_totals[$entity_id] = $this->storage
->getTotalNumberOfResults($entity_id);
}
// Sort results totals.
asort($results_totals, SORT_NUMERIC);
if ($this->request->query
->get('sort') === 'desc') {
$results_totals = array_reverse($results_totals, TRUE);
}
// Build an associative array of entity ids.
$entity_ids = array_keys($results_totals);
$entity_ids = array_combine($entity_ids, $entity_ids);
// Manually initialize and apply paging to the entity ids.
$page = $this->request->query
->get('page') ?: 0;
$total = count($entity_ids);
$limit = $this
->getLimit();
$start = $page * $limit;
\Drupal::service('pager.manager')
->createPager($total, $limit);
return array_slice($entity_ids, $start, $limit, TRUE);
}
else {
$query = $this
->getQuery($this->keys, $this->category, $this->state);
$query
->tableSort($header);
$query
->pager($this
->getLimit());
return $query
->execute();
}
}
/**
* Get the total number of submissions.
*
* @param string $keys
* (optional) Search key.
* @param string $category
* (optional) Category.
* @param string $state
* (optional) Webform state. Can be 'open' or 'closed'.
*
* @return int
* The total number of submissions.
*/
protected function getTotal($keys = '', $category = '', $state = '') {
return $this
->getQuery($keys, $category, $state)
->count()
->execute();
}
/**
* Get the base entity query filtered by webform and search.
*
* @param string $keys
* (optional) Search key.
* @param string $category
* (optional) Category.
* @param string $state
* (optional) Webform state. Can be 'open' or 'closed'.
*
* @return \Drupal\Core\Entity\Query\QueryInterface
* An entity query.
*/
protected function getQuery($keys = '', $category = '', $state = '') {
$query = $this
->getStorage()
->getQuery();
// Filter by key(word).
if ($keys) {
$or = $query
->orConditionGroup()
->condition('id', $keys, 'CONTAINS')
->condition('title', $keys, 'CONTAINS')
->condition('description', $keys, 'CONTAINS')
->condition('category', $keys, 'CONTAINS')
->condition('elements', $keys, 'CONTAINS');
// Users and roles we need to scan all webforms.
$access_value = NULL;
if ($accounts = $this->userStorage
->loadByProperties([
'name' => $keys,
])) {
$account = reset($accounts);
$access_type = 'users';
$access_value = $account
->id();
}
elseif ($role = $this->roleStorage
->load($keys)) {
$access_type = 'roles';
$access_value = $role
->id();
}
if ($access_value) {
// Collect the webform ids that the user or role has access to.
$webform_ids = [];
/** @var \Drupal\webform\WebformInterface $webforms */
$webforms = $this
->getStorage()
->loadMultiple();
foreach ($webforms as $webform) {
$access_rules = $webform
->getAccessRules();
foreach ($access_rules as $access_rule) {
if (!empty($access_rule[$access_type]) && in_array($access_value, $access_rule[$access_type])) {
$webform_ids[] = $webform
->id();
break;
}
}
}
if ($webform_ids) {
$or
->condition('id', $webform_ids, 'IN');
}
// Also check the webform's owner.
if ($access_type === 'users') {
$or
->condition('uid', $access_value);
}
}
$query
->condition($or);
}
// Filter by category.
if ($category) {
$query
->condition('category', $category);
}
// Filter by (form) state.
switch ($state) {
case WebformInterface::STATUS_OPEN:
case WebformInterface::STATUS_CLOSED:
case WebformInterface::STATUS_SCHEDULED:
$query
->condition('status', $state);
break;
}
// Always filter by archived state.
$query
->condition('archive', $state === WebformInterface::STATUS_ARCHIVED ? 1 : 0);
// Filter out templates if the webform_template.module is enabled.
if ($this
->moduleHandler()
->moduleExists('webform_templates') && $state !== WebformInterface::STATUS_ARCHIVED) {
$query
->condition('template', FALSE);
}
return $query;
}
/**
* {@inheritdoc}
*/
public function load() {
$entity_ids = $this
->getEntityIds();
/* @var $entities \Drupal\webform\WebformInterface[] */
$entities = $this->storage
->loadMultiple($entity_ids);
// If the user is not a webform admin, check access to each webform.
if (!$this
->isAdmin()) {
foreach ($entities as $entity_id => $entity) {
if (!$entity
->access('update', $this->currentUser) && !$entity
->access('submission_view_any', $this->currentUser)) {
unset($entities[$entity_id]);
}
}
}
return $entities;
}
/**
* Get number of entities to list per page.
*
* @return int|false
* The number of entities to list per page, or FALSE to list all entities.
*/
protected function getLimit() {
return $this
->isAdmin() ? $this->limit : FALSE;
}
/**
* Is the current user a webform administrator.
*
* @return bool
* TRUE if the current user has 'administer webform' or 'edit any webform'
* permission.
*/
protected function isAdmin() {
$account = $this->currentUser;
return $account
->hasPermission('administer webform') || $account
->hasPermission('edit any webform') || $account
->hasPermission('view any webform submission');
}
/**
* {@inheritdoc}
*/
protected function ensureDestination(Url $url) {
// Never add a destination to operation URLs.
return $url;
}
}
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:: |
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 |
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. | |
WebformEntityListBuilder:: |
protected | property | Bulk operations. | |
WebformEntityListBuilder:: |
protected | property | Search category. | |
WebformEntityListBuilder:: |
protected | property | The current user. | |
WebformEntityListBuilder:: |
protected | property | Search keys. | |
WebformEntityListBuilder:: |
protected | property | The current request. | |
WebformEntityListBuilder:: |
protected | property | The role storage. | |
WebformEntityListBuilder:: |
protected | property | Search state. | |
WebformEntityListBuilder:: |
protected | property | The webform submission storage. | |
WebformEntityListBuilder:: |
protected | property | The user storage. | |
WebformEntityListBuilder:: |
protected | function | Build the filter form. | |
WebformEntityListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
protected | function | Build information summary. | |
WebformEntityListBuilder:: |
public | function |
Builds a renderable list of operation links for the entity. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
protected | function |
Ensures that a destination is present on the given URL. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
public | function |
Gets this list's default operations. Overrides ConfigEntityListBuilder:: |
|
WebformEntityListBuilder:: |
protected | function |
Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
protected | function | Get number of entities to list per page. | |
WebformEntityListBuilder:: |
protected | function | Get the base entity query filtered by webform and search. | |
WebformEntityListBuilder:: |
protected | function | Get the total number of submissions. | |
WebformEntityListBuilder:: |
protected | function | Is the current user a webform administrator. | |
WebformEntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder:: |
|
WebformEntityListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder:: |
|
WebformEntityListBuilder:: |
public | function |
Constructs a new WebformListBuilder object. Overrides EntityListBuilder:: |