class EREFNodeTitles in Entity Reference Exposed Filters 8
Filters by given list of related content title options.
Plugin annotation
@ViewsFilter("eref_node_titles");
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\filter\FilterPluginBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\filter\InOperator
- class \Drupal\views\Plugin\views\filter\ManyToOne
- class \Drupal\entity_reference_exposed_filters\Plugin\views\filter\EREFNodeTitles implements PluginInspectionInterface, ContainerFactoryPluginInterface uses StringTranslationTrait
- class \Drupal\views\Plugin\views\filter\ManyToOne
- class \Drupal\views\Plugin\views\filter\InOperator
- class \Drupal\views\Plugin\views\filter\FilterPluginBase implements CacheableDependencyInterface
- 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 EREFNodeTitles
File
- src/
Plugin/ views/ filter/ EREFNodeTitles.php, line 30
Namespace
Drupal\entity_reference_exposed_filters\Plugin\views\filterView source
class EREFNodeTitles extends ManyToOne implements PluginInspectionInterface, ContainerFactoryPluginInterface {
use StringTranslationTrait;
// TODO this doesn't work for tax terms or users. separate filter.
/**
* Options to sort by.
*
* @var sortByOptions
*/
private $sortByOptions;
/**
* Order options.
*
* @var sortOrderOptions
*/
private $sortOrderOptions;
/**
* Order bundle options.
*
* @var sortBundleOrder
*/
private $sortBundleOrder;
/**
* Unpublished options.
*
* @var getUnpublishedOptions
*/
private $getUnpublishedOptions;
/**
* Option to filter out no results.
*
* @var getFilterNoResultsOptions
*/
private $getFilterNoResultsOptions;
/**
* Get relationships to use.
*
* @var getRelationships
*/
private $getRelationships;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The dbconnection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $Connection;
/**
* The entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The entity type bundle info.
*
* @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
*/
protected $entityTypeBundleInfo;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, Connection $connection, EntityFieldManagerInterface $entity_field_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityTypeManager = $entity_type_manager;
$this->Connection = $connection;
$this->entityFieldManager = $entity_field_manager;
$this->entityTypeBundleInfo = $entity_type_bundle_info;
}
/**
* {@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('database'), $container
->get('entity_field.manager'), $container
->get('entity_type.bundle.info'));
}
/**
* {@inheritdoc}
*/
public function validate() {
if (empty($this->getRelationships)) {
$this
->broken();
}
}
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$this->getRelationships = $this->view
->getHandlers('relationship');
if ($this->getRelationships === NULL) {
$this->getRelationships = [];
}
// Check for existence of relationship and
// Remove non-standard and non-node relationships
// TODO Can I get the relationship type from the handler?
$invalid_relationships = [
'cid',
'comment_cid',
'last_comment_uid',
'uid',
'vid',
'nid',
];
foreach ($this->getRelationships as $key => $relationship) {
// $is_node = strpos($relationship['table'], 'ode__');.
$is_target = strpos($relationship['id'], 'target_id');
if ($relationship['plugin_id'] != 'standard' || in_array($key, $invalid_relationships) || $is_target !== FALSE) {
unset($this->getRelationships[$key]);
}
}
// Set the sort options.
$this->sortByOptions = [
'nid',
'title',
];
$this->sortOrderOptions = [
'DESC',
'ASC',
];
$this->sortBundleOrder = [
'DESC',
'ASC',
];
$this->getUnpublishedOptions = [
'Unpublished',
'Published',
'All',
];
$this->getFilterNoResultsOptions = [
'Yes',
"No",
];
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
if (!isset($this->options['expose']['identifier'])) {
$this->options['expose']['identifier'] = $form_state
->get('id');
}
parent::buildOptionsForm($form, $form_state);
$form['relationship']['#options'] = array_intersect_key($form['relationship']['#options'], $this->getRelationships);
}
/**
* Define the sort params as extra options.
*/
public function hasExtraOptions() {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function buildExtraOptionsForm(&$form, FormStateInterface $form_state) {
$form['sort_by'] = [
'#type' => 'radios',
'#title' => $this
->t('Sort by'),
'#default_value' => $this->options['sort_by'],
'#options' => $this->sortByOptions,
'#description' => $this
->t('On what attribute do you want to sort the node titles?'),
'#required' => TRUE,
];
$form['sort_order'] = [
'#type' => 'radios',
'#title' => $this
->t('Sort by'),
'#default_value' => $this->options['sort_order'],
'#options' => $this->sortOrderOptions,
'#description' => $this
->t('In what order do you want to sort the node titles?'),
'#required' => TRUE,
];
$form['sort_bundle_order'] = [
'#type' => 'radios',
'#title' => $this
->t('Sort bundles'),
'#default_value' => $this->options['sort_bundle_order'],
'#options' => $this->sortOrderOptions,
'#description' => $this
->t('In what order do you want to sort the node bundles? (only relevant if there are multiple)'),
'#required' => TRUE,
];
$form['get_unpublished'] = [
'#type' => 'radios',
'#title' => $this
->t('Published Status'),
'#default_value' => $this->options['get_unpublished'],
'#options' => $this->getUnpublishedOptions,
'#description' => $this
->t('Do you want Published, Unpublished or All?'),
'#required' => TRUE,
];
$form['get_filter_no_results'] = [
'#type' => 'radios',
'#title' => $this
->t('Filter Out Options With No Results'),
'#default_value' => $this->options['get_filter_no_results'],
'#options' => $this->getFilterNoResultsOptions,
'#description' => $this
->t('Do you want to filter out options that will give no results?'),
'#required' => TRUE,
];
}
/**
* {@inheritdoc}
*/
public function submitExtraOptionsForm($form, FormStateInterface $form_state) {
// Define and regenerate the options if we change the sort.
$this
->defineOptions();
$this
->generateOptions();
}
/**
* {@inheritdoc}
*/
public function valueForm(&$form, FormStateInterface $form_state) {
parent::valueForm($form, $form_state);
// Reduce duplicates does not work. Do we need it?
$form['reduce_duplicates']['#default_value'] = 0;
$form['reduce_duplicates'] = [
'#disabled' => TRUE,
];
// Disable the none option. we have to have a relationship.
unset($form['relationship']['#options']['none']);
// Disable the expose button. this should be an exposed filter.
$form['expose_button'] = [
'#disabled' => TRUE,
];
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
// Always exposed.
$options['exposed'] = [
'default' => 1,
];
// Get the relationships. set the first as the default.
if (isset($this->getRelationships)) {
$relationship_field_names = array_keys($this->getRelationships);
$options['relationship'] = [
'default' => $relationship_field_names[0],
$this->getRelationships,
];
// Set the sort defaults. always numeric.
// Compare with sort options private arrays to get value for sort.
$options['sort_order'] = [
'default' => 0,
];
$options['sort_by'] = [
'default' => 1,
];
$options['get_unpublished'] = [
'default' => 1,
];
$options['get_filter_no_results'] = [
'default' => 1,
];
}
return $options;
}
/**
* {@inheritdoc}
*/
public function getValueOptions() {
// Generate the values from the helper function.
// TODO? - regenerate the list every time the relationship field is changed.
$this->valueOptions = $this
->generateOptions();
return $this->valueOptions;
}
/**
* Helper function that generates the options.
*/
public function generateOptions() {
$res = [];
$relationships = $this->getRelationships;
$relationship_fields = array_keys($relationships);
if (!empty($relationships) && isset($relationship_fields[0])) {
// Get the relationship of this Views handler
$relationship = $this->view
->getHandler($this->view->current_display, 'filter', $this->options['id']);
if (isset($relationship['relationship']) && $relationship['relationship'] != 'none') {
$relationship_field_name = $relationship['relationship'];
}
else {
// We need this as a default.
$relationship_field_name = $relationship_fields[0];
}
// Get the base view. we need it for bundle info and field defs.
$entity_type_id = explode('__', $relationships[$relationship_field_name]['table'])[0];
// Get bundles from a field name.
$all_bundles = $this->entityTypeBundleInfo
->getBundleInfo($entity_type_id);
// If that didn't work, attempt again as an entity revision reference table
if (empty($all_bundles)) {
$entity_type_id = rtrim($entity_type_id, '_revision');
$all_bundles = $this->entityTypeBundleInfo
->getBundleInfo($entity_type_id);
}
// Run through the bundles.
foreach (array_keys($all_bundles) as $bundle) {
foreach ($this->entityFieldManager
->getFieldDefinitions($entity_type_id, $bundle) as $field_definition) {
if ($field_definition
->getType() == 'entity_reference' && $field_definition
->getName() == $relationship_field_name) {
if ($field_definition
->getName() == 'uid') {
continue;
}
$field_obj = FieldConfig::loadByName($entity_type_id, $bundle, $field_definition
->getName());
$target_entity_type_id = explode(':', $field_obj
->getSetting('handler'));
// Convert an entity reference view to node or user.
if (in_array('views', $target_entity_type_id)) {
$target_entity_type_id = [
'default',
$entity_type_id,
];
}
// Will tell us node, user etc.
if ($target_entity_type_id[0] == 'default') {
$target_entity_type_id = $target_entity_type_id[1];
}
// Filter out entity reference views.
if (($handler_settings = $field_obj
->getSetting('handler_settings')) && !empty($handler_settings['view'])) {
\Drupal::messenger()
->addError($this
->t('This is targeting a field filtered by a view. Cannot get bundle.'), 'error');
\Drupal::messenger()
->addError($this
->t('Please use a field filtered by content type only.'), 'error');
return [];
}
// Get all the targets (content types etc) that this might hit.
foreach (array_keys($field_obj
->getSetting('handler_settings')['target_bundles']) as $bundle) {
$target_bundles[] = $bundle;
}
$bundles_needed[] = $bundle;
// Get the options together.
$gen_options = [];
$gen_options = [
'field' => $field_definition
->getName(),
'entity_type_id' => $entity_type_id,
'bundle' => $bundles_needed,
'target_entity_type_id' => $target_entity_type_id,
'target_bundles' => $target_bundles,
];
}
}
}
// Run the query.
$get_entity = $this->entityTypeManager
->getStorage($gen_options['target_entity_type_id']);
$relatedContentQuery = $this->entityTypeManager
->getStorage($gen_options['target_entity_type_id'])
->getQuery()
->condition('type', $gen_options['target_bundles'], 'IN')
->sort('type', $this->sortBundleOrder[$this->options['sort_bundle_order']]);
// Leave this for any debugging ->sort('title', 'ASC');.
if ($this->options['get_unpublished'] != 2) {
$relatedContentQuery
->condition('status', $this->options['get_unpublished']);
}
$relatedContentQuery
->sort($this->sortByOptions[$this->options['sort_by']], $this->sortOrderOptions[$this->options['sort_order']]);
// Returns an array of node ID's.
$relatedContentIds = $relatedContentQuery
->execute();
if (empty($relatedContentIds)) {
return [];
}
// Remove empty options if desired.
if ($this->options['get_filter_no_results'] == 0) {
$db = $this->Connection;
$query = $db
->select($entity_type_id . '__' . $relationship_field_name, 'x')
->fields('x', [
$relationship_field_name . '_target_id',
])
->condition('x.' . $relationship_field_name . '_target_id', $relatedContentIds, 'IN');
$ids_w_content = array_unique($query
->execute()
->fetchAll(\PDO::FETCH_COLUMN));
// Keep the sort order of the original query.
$relatedContentIds = array_intersect($relatedContentIds, $ids_w_content);
}
// Get the titles.
foreach ($relatedContentIds as $contentId) {
// Building an array with nid as key and title as value.
$res[$contentId] = \Drupal::service('entity.repository')
->getTranslationFromContext($get_entity
->load($contentId))
->getTitle();
}
}
return $res;
}
}
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 | |
EREFNodeTitles:: |
protected | property | The dbconnection. | |
EREFNodeTitles:: |
protected | property | The entity field manager. | |
EREFNodeTitles:: |
protected | property | The entity type bundle info. | |
EREFNodeTitles:: |
protected | property | The entity type manager. | |
EREFNodeTitles:: |
private | property | Option to filter out no results. | |
EREFNodeTitles:: |
private | property | Get relationships to use. | |
EREFNodeTitles:: |
private | property | Unpublished options. | |
EREFNodeTitles:: |
private | property | Order bundle options. | |
EREFNodeTitles:: |
private | property | Options to sort by. | |
EREFNodeTitles:: |
private | property | Order options. | |
EREFNodeTitles:: |
public | function |
Provide a form for setting options. Overrides HandlerBase:: |
|
EREFNodeTitles:: |
public | function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides FilterPluginBase:: |
|
EREFNodeTitles:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
EREFNodeTitles:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides ManyToOne:: |
|
EREFNodeTitles:: |
public | function | Helper function that generates the options. | |
EREFNodeTitles:: |
public | function |
Child classes should be used to override this function and set the
'value options', unless 'options callback' is defined as a valid function
or static public method to generate these values. Overrides InOperator:: |
|
EREFNodeTitles:: |
public | function |
Define the sort params as extra options. Overrides HandlerBase:: |
|
EREFNodeTitles:: |
public | function |
Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides ManyToOne:: |
|
EREFNodeTitles:: |
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. Overrides HandlerBase:: |
|
EREFNodeTitles:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides InOperator:: |
|
EREFNodeTitles:: |
public | function |
Options form subform for setting options. Overrides ManyToOne:: |
|
EREFNodeTitles:: |
public | function |
Constructs a Handler object. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | property | Disable the possibility to force a single value. | 6 |
FilterPluginBase:: |
public | property | Disable the possibility to allow a exposed input to be optional. | |
FilterPluginBase:: |
public | property | Contains the information of the selected item in a grouped filter. | |
FilterPluginBase:: |
public | property | Disable the possibility to use operators. | 1 |
FilterPluginBase:: |
public | property | Contains the operator which is used on the query. | |
FilterPluginBase:: |
public | property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow the use of (string) "0". | |
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Validate the build group options form. | |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
5 |
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
FilterPluginBase:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
FilterPluginBase:: |
public | function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
FilterPluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
7 |
FilterPluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
FilterPluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
1 |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
FilterPluginBase:: |
protected | function | Determines if the given grouped filter entry has a valid value. | 1 |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Options form subform for setting the operator. | 6 |
FilterPluginBase:: |
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. | |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | |
FilterPluginBase:: |
public | function |
Simple submit handler Overrides PluginBase:: |
|
FilterPluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides PluginBase:: |
|
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
protected | function | Validates a filter identifier. | |
FilterPluginBase:: |
public | function |
Simple validate handler Overrides PluginBase:: |
1 |
FilterPluginBase:: |
protected | function | Validate the options form. | 3 |
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 |
Check whether given user has access to this handler. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public | function |
Return a string representing this handler's name in the UI. 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 | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
10 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
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 exposed options form. Overrides ViewsHandlerInterface:: |
|
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 | 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 the exposed handler form | 4 |
HandlerBase:: |
public | function | Validate the options form. | |
InOperator:: |
protected | property | Stores all operations which are available on the form. | |
InOperator:: |
protected | property | The filter title. | |
InOperator:: |
public | function |
Determines if the input from a filter should change the generated query. Overrides FilterPluginBase:: |
2 |
InOperator:: |
public | function |
Display the filter on the administrative summary Overrides FilterPluginBase:: |
2 |
InOperator:: |
public | function |
Options form subform for exposed filter options. Overrides FilterPluginBase:: |
1 |
InOperator:: |
public | function |
Provide default options for exposed filters. Overrides FilterPluginBase:: |
|
InOperator:: |
protected | function | ||
InOperator:: |
public | function |
Build strings from the operators() for 'select' options Overrides FilterPluginBase:: |
1 |
InOperator:: |
protected | function | ||
InOperator:: |
protected | function | 1 | |
InOperator:: |
public | function |
Add this filter to the query. Overrides FilterPluginBase:: |
6 |
InOperator:: |
public | function | When using exposed filters, we may be required to reduce the set. | |
InOperator:: |
protected | function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides FilterPluginBase:: |
2 |
ManyToOne:: |
public | property | Stores the Helper object which handles the many_to_one complexity. | |
ManyToOne:: |
protected | property |
Overrides InOperator:: |
|
ManyToOne:: |
public | function |
Override ensureMyTable so we can control how this joins in.
The operator actually has influence over joining. Overrides HandlerBase:: |
|
ManyToOne:: |
public | function |
This kind of construct makes it relatively easy for a child class
to add or remove functionality by overriding this function and
adding/removing items from this array. Overrides InOperator:: |
1 |
ManyToOne:: |
protected | function | ||
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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 | Stores the render API renderer. | 3 |
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:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
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 | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
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. | ||
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. | |
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. |