class FlaggingCollectionBulkForm in Flag Lists 4.0.x
Defines a flagging Collection operations bulk form element.
Note that actions are not used but instead the ActionLinks.
Plugin annotation
@ViewsField("flagging_collection_bulk_form");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\field\FieldPluginBase implements FieldHandlerInterface
- class \Drupal\views\Plugin\views\field\BulkForm implements CacheableDependencyInterface uses RedirectDestinationTrait, EntityTranslationRenderTrait, UncacheableFieldHandlerTrait
- class \Drupal\flag_lists\Plugin\views\field\FlaggingCollectionBulkForm
- class \Drupal\views\Plugin\views\field\BulkForm implements CacheableDependencyInterface uses RedirectDestinationTrait, EntityTranslationRenderTrait, UncacheableFieldHandlerTrait
- class \Drupal\views\Plugin\views\field\FieldPluginBase implements FieldHandlerInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of FlaggingCollectionBulkForm
File
- src/
Plugin/ views/ field/ FlaggingCollectionBulkForm.php, line 20
Namespace
Drupal\flag_lists\Plugin\views\fieldView source
class FlaggingCollectionBulkForm extends BulkForm {
/**
* Flag Lists Service injected.
*
* @var \Drupal\flag_lists\FlagListsService
*/
private $flagListsService;
/**
* Flag Service injected.
*
* @var \Drupal\flag\FlagService
*/
private $flagService;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, LanguageManagerInterface $language_manager, MessengerInterface $messenger, EntityRepositoryInterface $entity_repository) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $language_manager, $messenger);
$this->entityManager = $entity_type_manager;
$this->actionStorage = $entity_type_manager
->getStorage('action');
$this->languageManager = $language_manager;
$this->messenger = $messenger;
$this->entityRepository = $entity_repository;
$this->flagListsService = \Drupal::service('flaglists');
$this->flagService = \Drupal::service('flag');
}
/**
* {@inheritdoc}
*/
protected function emptySelectedMessage() {
return $this
->t('Please select one or more Entities to work on.');
}
/**
* {@inheritdoc}
*/
protected function getBulkOptions($filtered = TRUE) {
// Remove all existing actions and replace with our own.
$options = [];
$all_options['flag'] = $this
->t('Flag the entities in the list');
$all_options['unflag'] = $this
->t('Unflag the entities in the list');
foreach ($all_options 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] = $all_options[$id];
}
return $options;
}
/**
* {@inheritdoc}
*/
public function viewsForm(&$form, FormStateInterface $form_state) {
parent::viewsForm($form, $form_state);
$form['header'][$this->options['id']]['action']['#title'] = $this
->t('Flag action');
$options = [
'0' => '- Create Flagging Collection -',
];
foreach ($this->flagListsService
->getUsersFlaggingCollections() as $entity_id => $entity) {
// Check for right Flagging Collection is done during Validation.
$options[$entity_id] = $entity
->getName();
}
$form['header'][$this->options['id']]['flaglist'] = [
'#type' => 'select',
'#title' => $this
->t('Use this Flagging Collection'),
'#options' => $options,
];
$form['header'][$this->options['id']]['newlistFieldSet'] = [
'#type' => 'fieldset',
'#title' => $this
->t('New Flagging Collection'),
'#states' => [
'visible' => [
':input[name="flaglist"]' => [
'value' => '0',
],
],
],
];
$form['header'][$this->options['id']]['newlistFieldSet']['newlist'] = [
'#type' => 'textfield',
'#title' => $this
->t('Name'),
'#states' => [
'visible' => [
':input[name="flaglist"]' => [
'value' => '0',
],
],
],
];
$options = [];
foreach ($this->flagListsService
->getAllFlagForList() as $list_id => $list) {
$options[$list_id] = $list
->get('label');
// Dig out if this is the right template.
}
$form['header'][$this->options['id']]['newlistFieldSet']['template'] = [
'#type' => 'select',
'#title' => $this
->t('Template flag'),
'#options' => $options,
'#states' => [
'visible' => [
':input[name="flaglist"]' => [
'value' => '0',
],
],
],
];
$options = [];
$count = 0;
foreach ($this->flagListsService
->getAllFlaggingCollectionTypes() as $list_id => $list) {
$options[$list_id] = $list
->get('label');
$count = $count + 1;
}
$count > 1 ? $form['header'][$this->options['id']]['newlistFieldSet']['type'] = [
'#type' => 'select',
'#title' => $this
->t('Flagging Collection Type'),
'#options' => $options,
] : ($form['header'][$this->options['id']]['newlistFieldSet']['type'] = [
'#type' => 'hidden',
'#title' => $this
->t('Flagging Collection Type'),
'#value' => array_key_first($options),
]);
}
/**
* {@inheritdoc}
*/
public function viewsFormSubmit(&$form, FormStateInterface $form_state) {
if ($form_state
->get('step') == 'views_form_views_form') {
$user_input = $form_state
->getUserInput();
$baseFlag = $this->flagListsService
->getFlagForListById($user_input['template'])
->getBaseFlag();
if ($user_input['flaglist'] == 0) {
// Create a new flaglist with name $newlist.
// No cleaning of input?
$id = strtolower($user_input['newlist']);
$id = preg_replace("/[^a-z0-9_]/", "_", $id);
$template = [
'id' => $id,
'name' => $user_input['newlist'],
'type' => $user_input['type'],
];
$flaggingCollection = $this->entityTypeManager
->getStorage('flagging_collection')
->create($template);
$flaggingCollection
->setBaseFlag($user_input['template']);
$flaggingCollection
->setRelatedFlag($baseFlag);
$flaggingCollection
->save();
$flag = $flaggingCollection
->getRelatedFlag();
$flagList = $flaggingCollection
->id();
}
else {
$flag = $this->flagListsService
->getFlaggingCollectionById($user_input['flaglist'])
->getRelatedFlag();
$flagList = $user_input['flaglist'];
}
// Find the entities to execute the action on.
$selected = array_filter($user_input[$this->options['id']]);
$entities = [];
$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;
}
if ($user_input['action'] == 'flag' && !empty($this->flagListsService
->getFlagListItemIds($flag
->id(), $flagList, $entity
->id()))) {
// Skip execution if the entity is already in the collection.
continue;
}
elseif ($user_input['action'] == 'unflag' && empty($this->flagListsService
->getFlagListItemIds($flag
->id(), $flagList, $entity
->id()))) {
// Skip execution if the entity isn't in the collection.
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) {
// Maybe call the parent?
// parent::viewsFormSubmit($form, $form_state).
return;
}
// Execute the action via its link.
//
// Due to the following
// https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Action%21ActionInterface.php/interface/ActionInterface/8.9.x
// it is not implemented as an Action as it might break Drupal 9.
foreach ($entities as $entity_id => $entity) {
$actionLink = new ActionLinkController(\Drupal::service('flag'), $this->flagListsService, \Drupal::service('renderer'));
switch ($user_input['action']) {
case 'flag':
$actionLink
->flag($flag, $entity
->id(), $flagList);
break;
case 'unflag':
$actionLink
->unflag($flag, $entity
->id(), $flagList);
break;
default:
break;
}
}
$this->messenger
->addStatus($this
->formatPlural($count, '@count entity affected in %flaglists.', '@count entities affected in %flaglist.', [
'%flaglist' => $this->flagListsService
->getFlaggingCollectionById($flagList)
->getName(),
]));
}
}
/**
* {@inheritdoc}
*/
public function viewsFormValidate(&$form, FormStateInterface $form_state) {
if ($form_state
->getValue('flaglist') == 0 && empty($form_state
->getValue('newlist')) && $form_state
->getValue('action') == 'flag') {
// A new Flagging Collection must have a name.
$form_state
->setErrorByName('newlist', $this
->t('Please set a name for the new Flagging Collection.'));
}
if (!empty($form_state
->getValue('newlist'))) {
$listName = $this->flagListsService
->getFlaggingCollectionIdByName($form_state
->getValue('newlist'));
if (!empty($listName)) {
// The new name must not already exist.
$form_state
->setErrorByName('newlist', $this
->t('The new Flagging Collection name exists already.'));
}
}
if ($form_state
->getValue('flaglist') == 0 && $form_state
->getvalue('action') != 'flag') {
// It is only possible to unflag from existing Collections.
$form_state
->setErrorByName('flaglist', $this
->t('Please select an existing Flagging Collection.'));
}
$selected = $form_state
->getValue($this->options['id']);
if (empty($selected) || empty(array_filter($selected))) {
// The action must have some target Entities.
$form_state
->setErrorByName('', $this
->emptySelectedMessage());
}
$user_input = $form_state
->getUserInput();
if ($user_input['flaglist'] != 0) {
// This is an existing flag.
$flagEntityType = $this->flagListsService
->getFlaggingCollectionById($user_input['flaglists'])
->getRelatedFlag()
->get('entity_type');
}
else {
// This is a just created flag.
$flagEntityType = $this->flagService
->getFlagById($user_input['template'])
->get('entity_type');
}
foreach ($selected as $bulk_form_key) {
// Skip execution if current entity does not exist.
if (empty($bulk_form_key)) {
continue;
}
$entity = $this
->loadEntityFromBulkFormKey($bulk_form_key);
if ($entity
->getEntityTypeId() != $flagEntityType) {
// Flagging Collection Entitiy must match the Listed ones.
$form_state
->setErrorByName('flaglist', $this
->t('Incorrect target Flagging Collection chosen for the listed entity type.'));
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BulkForm:: |
protected | property | An array of actions that can be executed. | |
BulkForm:: |
protected | property | The action storage. | |
BulkForm:: |
protected | property | The entity repository service. | |
BulkForm:: |
protected | property | The entity type manager. | |
BulkForm:: |
protected | property | The language manager. | |
BulkForm:: |
protected | property |
The messenger. Overrides MessengerTrait:: |
|
BulkForm:: |
public | function |
Default options form that provides the label widget that all fields
should have. Overrides FieldPluginBase:: |
|
BulkForm:: |
protected | function | Calculates a bulk form key. | |
BulkForm:: |
public | function |
Determines if this field is click sortable. Overrides FieldPluginBase:: |
|
BulkForm:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
BulkForm:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides FieldPluginBase:: |
|
BulkForm:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
BulkForm:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
BulkForm:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
BulkForm:: |
protected | function | ||
BulkForm:: |
public | function |
Returns the entity type identifier. Overrides EntityTranslationRenderTrait:: |
|
BulkForm:: |
protected | function | ||
BulkForm:: |
protected | function |
Returns the language manager. Overrides EntityTranslationRenderTrait:: |
|
BulkForm:: |
public | function |
Gets the value that's supposed to be rendered. Overrides UncacheableFieldHandlerTrait:: |
|
BulkForm:: |
protected | function |
Returns the top object of a view. Overrides EntityTranslationRenderTrait:: |
|
BulkForm:: |
public | function |
Initialize the plugin. Overrides FieldPluginBase:: |
|
BulkForm:: |
protected | function | Loads an entity based on a bulk form key. | |
BulkForm:: |
public | function |
Runs before any fields are rendered. Overrides FieldPluginBase:: |
|
BulkForm:: |
public | function |
Called to add the field to a query. Overrides FieldPluginBase:: |
|
BulkForm:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityTranslationRenderTrait:: |
protected | property | The renderer to be used to render the entity row. | |
EntityTranslationRenderTrait:: |
public | function | Returns the entity translation matching the configured row language. | |
EntityTranslationRenderTrait:: |
protected | function | Returns the current renderer. | |
FieldPluginBase:: |
public | property | Stores additional fields which get added to the query. | |
FieldPluginBase:: |
public | property | ||
FieldPluginBase:: |
public | property | ||
FieldPluginBase:: |
protected | property | Keeps track of the last render index. | |
FieldPluginBase:: |
protected | property | The link generator. | |
FieldPluginBase:: |
public | property | The field value prior to any rewriting. | |
FieldPluginBase:: |
protected | property |
Stores the render API renderer. Overrides PluginBase:: |
1 |
FieldPluginBase:: |
protected | function | Add 'additional' fields to the query. | |
FieldPluginBase:: |
protected | function | Add any special tokens this field might use for itself. | 4 |
FieldPluginBase:: |
public | function |
Return a string representing this handler's name in the UI. Overrides HandlerBase:: |
|
FieldPluginBase:: |
public | function |
Provide extra data to the administration form. Overrides HandlerBase:: |
|
FieldPluginBase:: |
public | function |
Renders a field using advanced settings. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
protected | function | Determine if this field can allow advanced rendering. | |
FieldPluginBase:: |
public | function |
Adds an ORDER BY clause to the query for click sort columns. Overrides FieldHandlerInterface:: |
1 |
FieldPluginBase:: |
protected | function | Document any special tokens this field might use for itself. | 3 |
FieldPluginBase:: |
public | function |
Returns the class of the field. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Returns the class of the field's label. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Returns an HTML element for the label based upon the field's element type. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Returns an HTML element based upon the field's element type. Overrides FieldHandlerInterface:: |
1 |
FieldPluginBase:: |
public | function |
Returns the class of the field's wrapper. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Returns an HTML element for the wrapper based upon the field's element type. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Provides a list of elements valid for field HTML. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Gets the entity matching the current row and relationship. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
protected | function | Returns all field labels of fields before this field. | |
FieldPluginBase:: |
protected | function |
Returns the render API renderer. Overrides PluginBase:: |
|
FieldPluginBase:: |
public | function |
Gets the 'render' tokens to use for advanced rendering. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
protected | function | Recursive function to add replacements for nested query string parameters. | |
FieldPluginBase:: |
public | function |
Checks if a field value is empty. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Gets this field's label. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
protected | function | Gets the link generator. | |
FieldPluginBase:: |
protected | function | Render this field as user-defined altered text. | |
FieldPluginBase:: |
protected | function | Render this field as a link, with the info from a fieldset set by the user. | |
FieldPluginBase:: |
public | function |
Performs an advanced text render for the item. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
protected | function | Trims the field down to the specified length. | |
FieldPluginBase:: |
constant | Indicator of the renderText() method for rendering the whole element. (if no render_item() method is available). | ||
FieldPluginBase:: |
constant | Indicator of the renderText() method for rendering the empty text. | ||
FieldPluginBase:: |
constant | Indicator of the renderText() method for rendering a single item. (If no render_item() is present). | ||
FieldPluginBase:: |
public | function |
Performs some cleanup tasks on the options array before saving it. Overrides PluginBase:: |
1 |
FieldPluginBase:: |
public | function |
Passes values to drupal_render() using $this->themeFunctions() as #theme. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides PluginBase:: |
|
FieldPluginBase:: |
public | function |
Replaces a value with tokens from the last field. Overrides FieldHandlerInterface:: |
|
FieldPluginBase:: |
public static | function | Trims the field down to the specified length. | |
FieldPluginBase:: |
public | function |
Determines if this field will be available as an option to group the result
by in the style settings. Overrides FieldHandlerInterface:: |
|
FlaggingCollectionBulkForm:: |
private | property | Flag Lists Service injected. | |
FlaggingCollectionBulkForm:: |
private | property | Flag Service injected. | |
FlaggingCollectionBulkForm:: |
protected | function |
Returns the message to be displayed when there are no selected items. Overrides BulkForm:: |
|
FlaggingCollectionBulkForm:: |
protected | function |
Returns the available operations for this form. Overrides BulkForm:: |
|
FlaggingCollectionBulkForm:: |
public | function |
Form constructor for the bulk form. Overrides BulkForm:: |
|
FlaggingCollectionBulkForm:: |
public | function |
Submit handler for the bulk form. Overrides BulkForm:: |
|
FlaggingCollectionBulkForm:: |
public | function |
Overrides BulkForm:: |
|
FlaggingCollectionBulkForm:: |
public | function |
Constructs a new BulkForm object. Overrides BulkForm:: |
|
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
protected | property | The module handler. | 3 |
HandlerBase:: |
public | property | Where the $query object will reside. | 7 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
protected | property | The views data service. | |
HandlerBase:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function |
Check whether given user has access to this handler. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public static | function |
Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Determines if the handler is considered 'broken', meaning it's a
placeholder used when a handler can't be found. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
HandlerBase:: |
public | function | Form for exposed handler options. | 2 |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
10 |
HandlerBase:: |
public | function | Determine if a handler can be exposed. | 2 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function |
Ensure the main table for this handler is in the query. This is used
a lot. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | 2 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | 2 |
HandlerBase:: |
public | function |
Determines the entity type used by this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Get the join object that should be used for this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets the module handler. | |
HandlerBase:: |
public static | function |
Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets views data service. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function |
Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Run before the view is built. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function |
Sanitize the value for output. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Sets the module handler. | |
HandlerBase:: |
public | function |
Called just prior to query(), this lets a handler set up any relationship
it needs. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | ||
HandlerBase:: |
public | function | Shortcut to display the expose/hide button. | 2 |
HandlerBase:: |
public | function |
Shortcut to display the exposed options form. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
HandlerBase:: |
public | function | Submit the exposed handler form. | |
HandlerBase:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Calculates options stored on the handler. | 1 |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 13 |
HandlerBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
2 |
HandlerBase:: |
public | function | Validate the exposed handler form. | 4 |
HandlerBase:: |
public | function | Validate the options form. | 2 |
HandlerBase:: |
public | function | Validate the options form. | |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
6 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
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. | 4 |
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. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
UncacheableFieldHandlerTrait:: |
protected | function | Actually renders the field markup. | |
UncacheableFieldHandlerTrait:: |
abstract protected | function | ||
UncacheableFieldHandlerTrait:: |
public | function | ||
UncacheableFieldHandlerTrait:: |
public | function |