class BulkForm
Same name in other branches
- 9 core/modules/views/src/Plugin/views/field/BulkForm.php \Drupal\views\Plugin\views\field\BulkForm
- 8.9.x core/modules/views/src/Plugin/views/field/BulkForm.php \Drupal\views\Plugin\views\field\BulkForm
- 8.9.x core/modules/system/src/Plugin/views/field/BulkForm.php \Drupal\system\Plugin\views\field\BulkForm
- 10 core/modules/views/src/Plugin/views/field/BulkForm.php \Drupal\views\Plugin\views\field\BulkForm
Defines an actions-based bulk operation form element.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\views\Plugin\views\field\BulkForm extends \Drupal\views\Plugin\views\field\FieldPluginBase implements \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Form\WorkspaceDynamicSafeFormInterface uses \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\views\Plugin\views\field\UncacheableFieldHandlerTrait, \Drupal\views\Entity\Render\EntityTranslationRenderTrait, \Drupal\Core\Entity\Form\WorkspaceSafeFormTrait
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of BulkForm
4 files declare their use of BulkForm
- BulkFormTest.php in core/
modules/ views/ tests/ src/ Unit/ Plugin/ views/ field/ BulkFormTest.php - CommentBulkForm.php in core/
modules/ comment/ src/ Plugin/ views/ field/ CommentBulkForm.php - NodeBulkForm.php in core/
modules/ node/ src/ Plugin/ views/ field/ NodeBulkForm.php - UserBulkForm.php in core/
modules/ user/ src/ Plugin/ views/ field/ UserBulkForm.php
File
-
core/
modules/ views/ src/ Plugin/ views/ field/ BulkForm.php, line 30
Namespace
Drupal\views\Plugin\views\fieldView source
class BulkForm extends FieldPluginBase implements CacheableDependencyInterface, WorkspaceDynamicSafeFormInterface {
use RedirectDestinationTrait;
use UncacheableFieldHandlerTrait;
use EntityTranslationRenderTrait;
use WorkspaceSafeFormTrait;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The entity repository service.
*
* @var \Drupal\Core\Entity\EntityRepositoryInterface
*/
protected $entityRepository;
/**
* The action storage.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $actionStorage;
/**
* An array of actions that can be executed.
*
* @var \Drupal\system\ActionConfigEntityInterface[]
*/
protected $actions = [];
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* The messenger.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
protected $messenger;
/**
* The current route match service.
*
* @var \Drupal\Core\Routing\ResettableStackedRouteMatchInterface
*/
protected ResettableStackedRouteMatchInterface $routeMatch;
/**
* Constructs a new BulkForm object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger.
* @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
* The entity repository.
* @param \Drupal\Core\Routing\ResettableStackedRouteMatchInterface $route_match
* The current route match service.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, MessengerInterface $messenger, EntityRepositoryInterface $entity_repository, ResettableStackedRouteMatchInterface $route_match) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
$this->actionStorage = $entity_type_manager->getStorage('action');
$this->languageManager = $language_manager;
$this->messenger = $messenger;
$this->entityRepository = $entity_repository;
$this->routeMatch = $route_match;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('language_manager'), $container->get('messenger'), $container->get('entity.repository'), $container->get('current_route_match'));
}
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, ?array &$options = NULL) {
parent::init($view, $display, $options);
$entity_type = $this->getEntityType();
// Filter the actions to only include those for this entity type.
$this->actions = array_filter($this->actionStorage
->loadMultiple(), function ($action) use ($entity_type) {
return $action->getType() == $entity_type;
});
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
// @todo Consider making the bulk operation form cacheable. See
// https://www.drupal.org/node/2503009.
return 0;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
return $this->languageManager
->isMultilingual() ? $this->getEntityTranslationRenderer()
->getCacheContexts() : [];
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
/**
* {@inheritdoc}
*/
public function getEntityTypeId() {
return $this->getEntityType();
}
/**
* {@inheritdoc}
*/
protected function getEntityTypeManager() {
return $this->entityTypeManager;
}
/**
* {@inheritdoc}
*/
protected function getEntityRepository() {
return $this->entityRepository;
}
/**
* {@inheritdoc}
*/
protected function getLanguageManager() {
return $this->languageManager;
}
/**
* {@inheritdoc}
*/
protected function getView() {
return $this->view;
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['action_title'] = [
'default' => $this->t('Action'),
];
$options['include_exclude'] = [
'default' => 'exclude',
];
$options['selected_actions'] = [
'default' => [],
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
$form['action_title'] = [
'#type' => 'textfield',
'#title' => $this->t('Action title'),
'#default_value' => $this->options['action_title'],
'#description' => $this->t('The title shown above the actions dropdown.'),
];
$form['include_exclude'] = [
'#type' => 'radios',
'#title' => $this->t('Available actions'),
'#options' => [
'exclude' => $this->t('All actions, except selected'),
'include' => $this->t('Only selected actions'),
],
'#default_value' => $this->options['include_exclude'],
];
$form['selected_actions'] = [
'#type' => 'checkboxes',
'#title' => $this->t('Selected actions'),
'#options' => $this->getBulkOptions(FALSE),
'#default_value' => $this->options['selected_actions'],
];
parent::buildOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
parent::validateOptionsForm($form, $form_state);
$selected_actions = $form_state->getValue([
'options',
'selected_actions',
]);
$form_state->setValue([
'options',
'selected_actions',
], array_values(array_filter($selected_actions)));
}
/**
* {@inheritdoc}
*/
public function preRender(&$values) {
parent::preRender($values);
// If the view is using a table style, provide a placeholder for a
// "select all" checkbox.
if (!empty($this->view->style_plugin) && $this->view->style_plugin instanceof Table) {
// Add the tableselect css classes.
$this->options['element_label_class'] .= 'select-all';
// Hide the actual label of the field on the table header.
$this->options['label'] = '';
}
}
/**
* {@inheritdoc}
*/
public function getValue(ResultRow $row, $field = NULL) {
return '<!--form-item-' . $this->options['id'] . '--' . $row->index . '-->';
}
/**
* Form constructor for the bulk form.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function viewsForm(&$form, FormStateInterface $form_state) {
// Make sure we do not accidentally cache this form.
// @todo Evaluate this again in https://www.drupal.org/node/2503009.
$form['#cache']['max-age'] = 0;
// Add the tableselect javascript.
$form['#attached']['library'][] = 'core/drupal.tableselect';
$use_revision = array_key_exists('revision', $this->view
->getQuery()
->getEntityTableInfo());
// Only add the bulk form options and buttons if there are results.
if (!empty($this->view->result)) {
// Render checkboxes for all rows.
$form[$this->options['id']]['#tree'] = TRUE;
foreach ($this->view->result as $row_index => $row) {
$entity = $this->getEntity($row);
if ($entity !== NULL) {
$entity = $this->getEntityTranslationByRelationship($entity, $row);
$form[$this->options['id']][$row_index] = [
'#type' => 'checkbox',
// We are not able to determine a main "title" for each row, so we
// can only output a generic label.
'#title' => $this->t('Update this item'),
'#title_display' => 'invisible',
'#default_value' => !empty($form_state->getValue($this->options['id'])[$row_index]) ? 1 : NULL,
'#return_value' => $this->calculateEntityBulkFormKey($entity, $use_revision),
];
}
else {
$form[$this->options['id']][$row_index] = [];
}
}
// Replace the form submit button label.
$form['actions']['submit']['#value'] = $this->t('Apply to selected items');
// Ensure a consistent container for filters/operations in the view header.
$form['header'] = [
'#type' => 'container',
'#weight' => -100,
];
// Build the bulk operations action widget for the header.
// Allow themes to apply .container-inline on this separate container.
$form['header'][$this->options['id']] = [
'#type' => 'container',
];
$form['header'][$this->options['id']]['action'] = [
'#type' => 'select',
'#title' => $this->options['action_title'],
'#options' => $this->getBulkOptions(),
'#empty_option' => $this->t('- Select -'),
];
// Duplicate the form actions into the action container in the header.
$form['header'][$this->options['id']]['actions'] = $form['actions'];
}
else {
// Remove the default actions build array.
unset($form['actions']);
}
}
/**
* Returns the available operations for this form.
*
* @param bool $filtered
* (optional) Whether to filter actions to selected actions.
*
* @return array
* An associative array of operations, suitable for a select element.
*/
protected function getBulkOptions($filtered = TRUE) {
$options = [];
// Filter the action list.
foreach ($this->actions as $id => $action) {
if ($filtered) {
$in_selected = in_array($id, $this->options['selected_actions']);
// If the field is configured to include only the selected actions,
// skip actions that were not selected.
if ($this->options['include_exclude'] == 'include' && !$in_selected) {
continue;
}
elseif ($this->options['include_exclude'] == 'exclude' && $in_selected) {
continue;
}
}
$options[$id] = $action->label();
}
return $options;
}
/**
* Submit handler for the bulk form.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
* Thrown when the user tried to access an action without access to it.
*/
public function viewsFormSubmit(&$form, FormStateInterface $form_state) {
if ($form_state->get('step') == 'views_form_views_form') {
// Filter only selected checkboxes. Use the actual user input rather than
// the raw form values array, since the site data may change before the
// bulk form is submitted, which can lead to data loss.
$user_input = $form_state->getUserInput();
$selected = array_filter($user_input[$this->options['id']]);
$entities = [];
$action = $this->actions[$form_state->getValue('action')];
$count = 0;
foreach ($selected as $bulk_form_key) {
$entity = $this->loadEntityFromBulkFormKey($bulk_form_key);
// Skip execution if current entity does not exist.
if (empty($entity)) {
continue;
}
// Skip execution if the user did not have access.
if (!$action->getPlugin()
->access($entity, $this->view
->getUser())) {
$this->messenger
->addError($this->t('No access to execute %action on the @entity_type_label %entity_label.', [
'%action' => $action->label(),
'@entity_type_label' => $entity->getEntityType()
->getLabel(),
'%entity_label' => $entity->label(),
]));
continue;
}
$count++;
$entities[$bulk_form_key] = $entity;
}
// If there were entities selected but the action isn't allowed on any of
// them, we don't need to do anything further.
if (!$count) {
return;
}
$action->execute($entities);
$operation_definition = $action->getPluginDefinition();
if (!empty($operation_definition['confirm_form_route_name'])) {
$options = [
'query' => $this->getDestinationArray(),
];
$route_parameters = $this->routeMatch
->getRawParameters()
->all();
$form_state->setRedirect($operation_definition['confirm_form_route_name'], $route_parameters, $options);
}
else {
// Don't display the message unless there are some elements affected and
// there is no confirmation form.
$this->messenger
->addStatus($this->formatPlural($count, '%action was applied to @count item.', '%action was applied to @count items.', [
'%action' => $action->label(),
]));
}
}
}
/**
* Returns the message to be displayed when there are no selected items.
*
* @return string
* Message displayed when no items are selected.
*/
protected function emptySelectedMessage() {
return $this->t('No items selected.');
}
/**
* Returns the message that is displayed when no action is selected.
*
* @return \Drupal\Core\StringTranslation\TranslatableMarkup
* Message displayed when no action is selected.
*/
protected function emptyActionMessage() : TranslatableMarkup {
return $this->t('No %title option selected.', [
'%title' => $this->options['action_title'],
]);
}
/**
* {@inheritdoc}
*/
public function viewsFormValidate(&$form, FormStateInterface $form_state) {
$ids = $form_state->getValue($this->options['id']);
if (empty($ids) || empty(array_filter($ids))) {
$form_state->setErrorByName('', $this->emptySelectedMessage());
}
$action = $form_state->getValue('action');
if (empty($action)) {
$form_state->setErrorByName('', $this->emptyActionMessage());
}
}
/**
* {@inheritdoc}
*/
public function query() {
if ($this->languageManager
->isMultilingual()) {
$this->getEntityTranslationRenderer()
->query($this->query, $this->relationship);
}
}
/**
* {@inheritdoc}
*/
public function clickSortable() {
return FALSE;
}
/**
* Calculates a bulk form key.
*
* This generates a key that is used as the checkbox return value when
* submitting a bulk form. This key allows the entity for the row to be loaded
* totally independent of the executed view row.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to calculate a bulk form key for.
* @param bool $use_revision
* Whether the revision id should be added to the bulk form key. This should
* be set to TRUE only if the view is listing entity revisions.
*
* @return string
* The bulk form key representing the entity's id, language and revision (if
* applicable) as one string.
*
* @see self::loadEntityFromBulkFormKey()
*/
protected function calculateEntityBulkFormKey(EntityInterface $entity, $use_revision) {
$key_parts = [
$entity->language()
->getId(),
$entity->id(),
];
if ($entity instanceof RevisionableInterface && $use_revision) {
$key_parts[] = $entity->getRevisionId();
}
// An entity ID could be an arbitrary string (although they are typically
// numeric). JSON then Base64 encoding ensures the bulk_form_key is
// safe to use in HTML, and that the key parts can be retrieved.
$key = json_encode($key_parts);
return base64_encode($key);
}
/**
* Loads an entity based on a bulk form key.
*
* @param string $bulk_form_key
* The bulk form key representing the entity's id, language and revision (if
* applicable) as one string.
*
* @return \Drupal\Core\Entity\EntityInterface
* The entity loaded in the state (language, optionally revision) specified
* as part of the bulk form key.
*/
protected function loadEntityFromBulkFormKey($bulk_form_key) {
$key = base64_decode($bulk_form_key);
$key_parts = json_decode($key);
$revision_id = NULL;
// If there are 3 items, vid will be last.
if (count($key_parts) === 3) {
$revision_id = array_pop($key_parts);
}
// The first two items will always be langcode and ID.
$id = array_pop($key_parts);
$langcode = array_pop($key_parts);
// Load the entity or a specific revision depending on the given key.
$storage = $this->entityTypeManager
->getStorage($this->getEntityType());
if ($revision_id) {
/** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
$entity = $storage->loadRevision($revision_id);
}
else {
$entity = $storage->load($id);
}
if ($entity instanceof TranslatableInterface) {
$entity = $entity->getTranslation($langcode);
}
return $entity;
}
/**
* {@inheritdoc}
*/
public function isWorkspaceSafeForm(array $form, FormStateInterface $form_state) : bool {
$entity_type = $this->entityTypeManager
->getDefinition($this->getEntityTypeId());
return $this->isWorkspaceSafeEntityType($entity_type);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
BulkForm::$actions | protected | property | An array of actions that can be executed. | ||
BulkForm::$actionStorage | protected | property | The action storage. | ||
BulkForm::$entityRepository | protected | property | The entity repository service. | ||
BulkForm::$entityTypeManager | protected | property | The entity type manager. | ||
BulkForm::$languageManager | protected | property | The language manager. | ||
BulkForm::$messenger | protected | property | The messenger. | ||
BulkForm::$routeMatch | protected | property | The current route match service. | ||
BulkForm::buildOptionsForm | public | function | Default option form that provides label widget that all fields should have. | Overrides FieldPluginBase::buildOptionsForm | |
BulkForm::calculateEntityBulkFormKey | protected | function | Calculates a bulk form key. | ||
BulkForm::clickSortable | public | function | Determines if this field is click sortable. | Overrides FieldPluginBase::clickSortable | |
BulkForm::create | public static | function | Creates an instance of the plugin. | Overrides PluginBase::create | |
BulkForm::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides FieldPluginBase::defineOptions | |
BulkForm::emptyActionMessage | protected | function | Returns the message that is displayed when no action is selected. | ||
BulkForm::emptySelectedMessage | protected | function | Returns the message to be displayed when there are no selected items. | 3 | |
BulkForm::getBulkOptions | protected | function | Returns the available operations for this form. | ||
BulkForm::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | |
BulkForm::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
BulkForm::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | |
BulkForm::getEntityRepository | protected | function | |||
BulkForm::getEntityTypeId | public | function | Returns the entity type identifier. | Overrides EntityTranslationRenderTrait::getEntityTypeId | |
BulkForm::getEntityTypeManager | protected | function | |||
BulkForm::getLanguageManager | protected | function | Returns the language manager. | Overrides EntityTranslationRenderTrait::getLanguageManager | |
BulkForm::getValue | public | function | Gets the value that's supposed to be rendered. | Overrides UncacheableFieldHandlerTrait::getValue | |
BulkForm::getView | protected | function | Returns the top object of a view. | Overrides EntityTranslationRenderTrait::getView | |
BulkForm::init | public | function | Initialize the plugin. | Overrides FieldPluginBase::init | |
BulkForm::isWorkspaceSafeForm | public | function | Determines whether the form is safe to be submitted in a workspace. | Overrides WorkspaceDynamicSafeFormInterface::isWorkspaceSafeForm | |
BulkForm::loadEntityFromBulkFormKey | protected | function | Loads an entity based on a bulk form key. | ||
BulkForm::preRender | public | function | Runs before any fields are rendered. | Overrides FieldPluginBase::preRender | |
BulkForm::query | public | function | Called to add the field to a query. | Overrides FieldPluginBase::query | |
BulkForm::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | |
BulkForm::viewsForm | public | function | Form constructor for the bulk form. | 1 | |
BulkForm::viewsFormSubmit | public | function | Submit handler for the bulk form. | ||
BulkForm::viewsFormValidate | public | function | |||
BulkForm::__construct | public | function | Constructs a new BulkForm object. | Overrides HandlerBase::__construct | |
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
EntityTranslationRenderTrait::$entityTranslationRenderer | protected | property | The renderer to be used to render the entity row. | ||
EntityTranslationRenderTrait::getEntityTranslationByRelationship | public | function | Returns the entity translation matching the configured row language. | ||
EntityTranslationRenderTrait::getEntityTranslationRenderer | protected | function | Returns the current renderer. | ||
FieldPluginBase::$additional_fields | public | property | |||
FieldPluginBase::$aliases | public | property | |||
FieldPluginBase::$field_alias | public | property | |||
FieldPluginBase::$lastRenderIndex | protected | property | Keeps track of the last render index. | ||
FieldPluginBase::$last_render | public | property | |||
FieldPluginBase::$last_render_text | public | property | |||
FieldPluginBase::$last_tokens | public | property | |||
FieldPluginBase::$linkGenerator | protected | property | The link generator. | ||
FieldPluginBase::$original_value | public | property | |||
FieldPluginBase::$renderer | protected | property | Stores the render API renderer. | Overrides PluginBase::$renderer | 1 |
FieldPluginBase::addAdditionalFields | protected | function | Add 'additional' fields to the query. | ||
FieldPluginBase::addSelfTokens | protected | function | Add any special tokens this field might use for itself. | 4 | |
FieldPluginBase::adminLabel | public | function | Return a string representing this handler's name in the UI. | Overrides HandlerBase::adminLabel | |
FieldPluginBase::adminSummary | public | function | Provide extra data to the administration form. | Overrides HandlerBase::adminSummary | |
FieldPluginBase::advancedRender | public | function | Renders a field using advanced settings. | Overrides FieldHandlerInterface::advancedRender | |
FieldPluginBase::allowAdvancedRender | protected | function | Determine if this field can allow advanced rendering. | ||
FieldPluginBase::clickSort | public | function | Adds an ORDER BY clause to the query for click sort columns. | Overrides FieldHandlerInterface::clickSort | 1 |
FieldPluginBase::documentSelfTokens | protected | function | Document any special tokens this field might use for itself. | 3 | |
FieldPluginBase::elementClasses | public | function | Returns the class of the field. | Overrides FieldHandlerInterface::elementClasses | |
FieldPluginBase::elementLabelClasses | public | function | Returns the class of the field's label. | Overrides FieldHandlerInterface::elementLabelClasses | |
FieldPluginBase::elementLabelType | public | function | Returns an HTML element for the label based upon the field's element type. | Overrides FieldHandlerInterface::elementLabelType | |
FieldPluginBase::elementType | public | function | Returns an HTML element based upon the field's element type. | Overrides FieldHandlerInterface::elementType | 1 |
FieldPluginBase::elementWrapperClasses | public | function | Returns the class of the field's wrapper. | Overrides FieldHandlerInterface::elementWrapperClasses | |
FieldPluginBase::elementWrapperType | public | function | Returns a wrapper HTML element for the field.. | Overrides FieldHandlerInterface::elementWrapperType | |
FieldPluginBase::getElements | public | function | Provides a list of elements valid for field HTML. | Overrides FieldHandlerInterface::getElements | |
FieldPluginBase::getEntity | public | function | Gets the entity matching the current row and relationship. | Overrides FieldHandlerInterface::getEntity | |
FieldPluginBase::getPreviousFieldLabels | protected | function | Returns all field labels of fields before this field. | ||
FieldPluginBase::getRenderer | protected | function | Returns the render API renderer. | Overrides PluginBase::getRenderer | |
FieldPluginBase::getRenderTokens | public | function | Gets the 'render' tokens to use for advanced rendering. | Overrides FieldHandlerInterface::getRenderTokens | |
FieldPluginBase::getTokenValuesRecursive | protected | function | Recursive function to add replacements for nested query string parameters. | ||
FieldPluginBase::isValueEmpty | public | function | Checks if a field value is empty. | Overrides FieldHandlerInterface::isValueEmpty | |
FieldPluginBase::label | public | function | Gets this field's label. | Overrides FieldHandlerInterface::label | |
FieldPluginBase::linkGenerator | protected | function | Gets the link generator. | ||
FieldPluginBase::renderAltered | protected | function | Render this field as user-defined altered text. | ||
FieldPluginBase::renderAsLink | protected | function | Render this field as a link, with the info from a fieldset set by the user. | ||
FieldPluginBase::renderText | public | function | Performs an advanced text render for the item. | Overrides FieldHandlerInterface::renderText | |
FieldPluginBase::renderTrimText | protected | function | Trims the field down to the specified length. | ||
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY | constant | Indicator of the renderText() method for rendering the whole element. | |||
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY | constant | Indicator of the renderText() method for rendering the empty text. | |||
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM | constant | Indicator of the renderText() method for rendering a single item. | |||
FieldPluginBase::submitOptionsForm | public | function | Performs some cleanup tasks on the options array before saving it. | Overrides PluginBase::submitOptionsForm | 1 |
FieldPluginBase::theme | public | function | Renders row values using $this->themeFunctions() as #theme. | Overrides FieldHandlerInterface::theme | |
FieldPluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides PluginBase::themeFunctions | |
FieldPluginBase::tokenizeValue | public | function | Replaces a value with tokens from the last field. | Overrides FieldHandlerInterface::tokenizeValue | |
FieldPluginBase::trimText | public static | function | Trims the field down to the specified length. | ||
FieldPluginBase::useStringGroupBy | public | function | Determines if this field can be grouped in the results. | Overrides FieldHandlerInterface::useStringGroupBy | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$is_handler | public | property | |||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | |
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | |
HandlerBase::$realField | public | property | The real field. | ||
HandlerBase::$relationship | public | property | The relationship used for this field. | ||
HandlerBase::$table | public | property | The table this handler is attached to. | ||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | ||
HandlerBase::$viewsData | protected | property | The views data service. | ||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
HandlerBase::access | public | function | Check whether given user has access to this handler. | Overrides ViewsHandlerInterface::access | 5 |
HandlerBase::breakString | public static | function | Breaks x,y,z and x+y+z into an array. | Overrides ViewsHandlerInterface::breakString | |
HandlerBase::broken | public | function | Determines if the handler is considered 'broken'. | Overrides ViewsHandlerInterface::broken | |
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | |
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 2 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 11 |
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | |
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | ||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | |
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | ||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | ||
HandlerBase::ensureMyTable | public | function | Ensures that the main table for this handler is in the query. | Overrides ViewsHandlerInterface::ensureMyTable | 2 |
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | |
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | |
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | |
HandlerBase::getEntityType | public | function | Determines the entity type used by this handler. | Overrides ViewsHandlerInterface::getEntityType | |
HandlerBase::getField | public | function | Shortcut to get a handler's raw field value. | Overrides ViewsHandlerInterface::getField | |
HandlerBase::getJoin | public | function | Get the join object that should be used for this handler. | Overrides ViewsHandlerInterface::getJoin | |
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | ||
HandlerBase::getTableJoin | public static | function | Fetches a handler to join one table to a primary table from the data cache. | Overrides ViewsHandlerInterface::getTableJoin | |
HandlerBase::getViewsData | protected | function | Gets views data service. | ||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 2 | |
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | ||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | |
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | ||
HandlerBase::postExecute | public | function | Run after the view is executed, before the result is cached. | Overrides ViewsHandlerInterface::postExecute | |
HandlerBase::preQuery | public | function | Run before the view is built. | Overrides ViewsHandlerInterface::preQuery | 2 |
HandlerBase::sanitizeValue | public | function | Sanitize the value for output. | Overrides ViewsHandlerInterface::sanitizeValue | |
HandlerBase::setModuleHandler | public | function | Sets the module handler. | ||
HandlerBase::setRelationship | public | function | Sets up any needed relationship. | Overrides ViewsHandlerInterface::setRelationship | |
HandlerBase::setViewsData | public | function | |||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | |
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | |
HandlerBase::submitExposed | public | function | Submit the exposed handler form. | ||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. | ||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | |
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | |
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | ||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | |
HandlerBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | 2 |
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
PluginBase::$definition | public | property | Plugins' definition. | ||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | ||
PluginBase::$options | public | property | Options for this plugin will be held here. | ||
PluginBase::$position | public | property | The handler position. | ||
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::destroy | public | function | Clears a plugin. | Overrides ViewsPluginInterface::destroy | 2 |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | ||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | |
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | |
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | |
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | |
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | |||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | |||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | ||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | |
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | |
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | ||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | ||
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 |
PluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 6 |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | |
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | |
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | |||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
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. | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | |||
UncacheableFieldHandlerTrait::doRender | protected | function | Actually renders the field markup. | ||
UncacheableFieldHandlerTrait::getFieldTokenPlaceholder | abstract protected | function | |||
UncacheableFieldHandlerTrait::postRender | public | function | |||
UncacheableFieldHandlerTrait::render | public | function | |||
WorkspaceSafeFormTrait::$workspaceInfo | protected | property | The workspace information service. | ||
WorkspaceSafeFormTrait::getWorkspaceInfo | protected | function | Retrieves the workspace information service. | ||
WorkspaceSafeFormTrait::isWorkspaceSafeEntity | protected | function | Determines whether an entity used in a form is workspace-safe. | ||
WorkspaceSafeFormTrait::isWorkspaceSafeEntityType | protected | function | Determines whether an entity type used in a form is workspace-safe. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.