class BooleanOperator
Same name in other branches
- 9 core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator
- 8.9.x core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator
- 10 core/modules/views/src/Plugin/views/filter/BooleanOperator.php \Drupal\views\Plugin\views\filter\BooleanOperator
Simple filter to handle matching of boolean values.
Definition items:
- label: (REQUIRED) The label for the checkbox.
- type: For basic 'true false' types, an item can specify the following:
- true-false: True/false (this is the default)
- yes-no: Yes/No
- on-off: On/Off
- enabled-disabled: Enabled/Disabled
- accept null: Treat a NULL value as false.
- use_equal: If you use this flag the query will use = 1 instead of <> 0. This might be helpful for performance reasons.
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\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\filter\BooleanOperator extends \Drupal\views\Plugin\views\filter\FilterPluginBase implements \Drupal\views\Plugin\views\filter\FilterOperatorsInterface
- class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- 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 BooleanOperator
Related topics
2 files declare their use of BooleanOperator
- Current.php in core/
modules/ user/ src/ Plugin/ views/ filter/ Current.php - FilterBooleanOperatorDefaultTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ filter/ FilterBooleanOperatorDefaultTest.php
File
-
core/
modules/ views/ src/ Plugin/ views/ filter/ BooleanOperator.php, line 26
Namespace
Drupal\views\Plugin\views\filterView source
class BooleanOperator extends FilterPluginBase implements FilterOperatorsInterface {
/**
* The equal query operator.
*
* @var string
*/
const EQUAL = '=';
/**
* The non equal query operator.
*
* @var string
*/
const NOT_EQUAL = '<>';
/**
* Exposed filter options.
*
* @var bool
*/
protected $alwaysMultiple = TRUE;
/**
* Whether to accept NULL as a false value or not.
*
* @var bool
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
public $accept_null = FALSE;
/**
* The value title.
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
public string $value_value;
/**
* The value options.
*/
public ?array $valueOptions;
/**
* {@inheritdoc}
*/
public function operatorOptions($which = 'title') {
$options = [];
foreach ($this->operators() as $id => $info) {
$options[$id] = $info[$which];
}
return $options;
}
/**
* {@inheritdoc}
*/
public function operators() {
$operators = [
'=' => [
'title' => $this->t('Is equal to'),
'method' => 'queryOpBoolean',
'short' => $this->t('='),
'values' => 1,
'query_operator' => self::EQUAL,
],
'!=' => [
'title' => $this->t('Is not equal to'),
'method' => 'queryOpBoolean',
'short' => $this->t('!='),
'values' => 1,
'query_operator' => self::NOT_EQUAL,
],
];
// If the definition allows for the empty operator, add it.
if (!empty($this->definition['allow empty'])) {
$operators += [
'empty' => [
'title' => $this->t('Is empty (NULL)'),
'method' => 'opEmpty',
'short' => $this->t('empty'),
'values' => 0,
],
'not empty' => [
'title' => $this->t('Is not empty (NOT NULL)'),
'method' => 'opEmpty',
'short' => $this->t('not empty'),
'values' => 0,
],
];
}
return $operators;
}
/**
* {@inheritdoc}
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, ?array &$options = NULL) {
parent::init($view, $display, $options);
$this->value_value = $this->t('True');
if (isset($this->definition['label'])) {
$this->value_value = $this->definition['label'];
}
elseif (isset($this->definition['title'])) {
$this->value_value = $this->definition['title'];
}
if (isset($this->definition['accept null'])) {
$this->accept_null = (bool) $this->definition['accept null'];
}
elseif (isset($this->definition['accept_null'])) {
$this->accept_null = (bool) $this->definition['accept_null'];
}
$this->valueOptions = NULL;
$this->definition['allow empty'] = TRUE;
}
/**
* Return the possible options for this filter.
*
* Child classes should override this function to set the possible values
* for the filter. Since this is a boolean filter, the array should have
* two possible keys: 1 for "True" and 0 for "False", although the labels
* can be whatever makes sense for the filter. These values are used for
* configuring the filter, when the filter is exposed, and in the admin
* summary of the filter. Normally, this should be static data, but if it's
* dynamic for some reason, child classes should use a guard to reduce
* database hits as much as possible.
*/
public function getValueOptions() {
if (isset($this->definition['type'])) {
if ($this->definition['type'] == 'yes-no') {
$this->valueOptions = [
1 => $this->t('Yes'),
0 => $this->t('No'),
];
}
if ($this->definition['type'] == 'on-off') {
$this->valueOptions = [
1 => $this->t('On'),
0 => $this->t('Off'),
];
}
if ($this->definition['type'] == 'enabled-disabled') {
$this->valueOptions = [
1 => $this->t('Enabled'),
0 => $this->t('Disabled'),
];
}
}
// Provide a fallback if the above didn't set anything.
if (!isset($this->valueOptions)) {
$this->valueOptions = [
1 => $this->t('True'),
0 => $this->t('False'),
];
}
return $this->valueOptions;
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['value']['default'] = FALSE;
return $options;
}
protected function valueForm(&$form, FormStateInterface $form_state) {
$form['value'] = [];
if (empty($this->valueOptions)) {
// Initialize the array of possible values for this filter.
$this->getValueOptions();
}
if ($exposed = $form_state->get('exposed')) {
// Exposed filter: use a select box to save space.
$filter_form_type = 'select';
}
else {
// Configuring a filter: use radios for clarity.
$filter_form_type = 'radios';
}
$display_options = 'all';
$source = ':input[name="options[operator]"]';
if ($exposed) {
$identifier = $this->options['expose']['identifier'];
if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {
$display_options = in_array($this->operator, $this->operatorValues(1)) ? 'value' : 'none';
}
else {
$source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
}
}
if ($display_options === 'all' || $display_options === 'value') {
$form['value'] = [
'#type' => $filter_form_type,
'#title' => $this->value_value,
'#options' => $this->valueOptions,
'#default_value' => $this->value,
];
$identifier = $this->options['expose']['identifier'];
$user_input = $form_state->getUserInput();
if ($exposed && isset($identifier) && !isset($user_input[$identifier])) {
$user_input[$identifier] = $this->value;
$form_state->setUserInput($user_input);
}
// If we're configuring an exposed filter, add an - Any - option.
if (!$exposed || empty($this->options['expose']['required'])) {
$form['value']['#options'] = [
'All' => $this->t('- Any -'),
] + $form['value']['#options'];
}
if ($display_options === 'all') {
// Setup #states for operators with a value.
foreach ($this->operatorValues(1) as $operator) {
$form['value']['#states']['visible'][] = [
$source => [
'value' => $operator,
],
];
}
}
}
}
protected function valueValidate($form, FormStateInterface $form_state) {
if ($form_state->getValue([
'options',
'value',
]) == 'All' && !$form_state->isValueEmpty([
'options',
'expose',
'required',
])) {
$form_state->setErrorByName('value', $this->t('You must select a value unless this is an non-required exposed filter.'));
}
}
public function adminSummary() {
if ($this->isAGroup()) {
return $this->t('grouped');
}
if (!empty($this->options['exposed'])) {
return $this->t('exposed');
}
if (empty($this->valueOptions)) {
$this->getValueOptions();
}
if (in_array($this->operator, $this->operatorValues(1), TRUE)) {
$this->getValueOptions();
// Now that we have the valid options for this filter, just return the
// human-readable label based on the current value. The valueOptions
// array is keyed with either 0 or 1, so if the current value is not
// empty, use the label for 1, and if it's empty, use the label for 0.
return $this->operator . ' ' . $this->valueOptions[!empty($this->value)];
}
return $this->operator;
}
public function defaultExposeOptions() {
parent::defaultExposeOptions();
$this->options['expose']['operator_id'] = '';
$this->options['expose']['label'] = $this->value_value;
$this->options['expose']['required'] = TRUE;
}
/**
* {@inheritdoc}
*/
public function query() {
$this->ensureMyTable();
$field = "{$this->tableAlias}.{$this->realField}";
$info = $this->operators();
if (!empty($info[$this->operator]['method'])) {
$this->{$info[$this->operator]['method']}($field, $info[$this->operator]['query_operator'] ?? NULL);
}
}
/**
* Adds a where condition to the query for a boolean value.
*
* @param string $field
* The field name to add the where condition for.
* @param string $query_operator
* (optional) Either self::EQUAL or self::NOT_EQUAL. Defaults to
* self::EQUAL.
*/
protected function queryOpBoolean($field, $query_operator = self::EQUAL) {
if (empty($this->value)) {
if ($this->accept_null) {
if ($query_operator === self::EQUAL) {
$condition = $this->query
->getConnection()
->condition('OR')
->condition($field, 0, $query_operator)
->isNull($field);
}
else {
$condition = $this->query
->getConnection()
->condition('AND')
->condition($field, 0, $query_operator)
->isNotNull($field);
}
$this->query
->addWhere($this->options['group'], $condition);
}
else {
$this->query
->addWhere($this->options['group'], $field, 0, $query_operator);
}
}
else {
if (!empty($this->definition['use_equal'])) {
// Forces a self::EQUAL operator instead of a self::NOT_EQUAL for
// performance reasons.
if ($query_operator === self::EQUAL) {
$this->query
->addWhere($this->options['group'], $field, 1, self::EQUAL);
}
else {
$this->query
->addWhere($this->options['group'], $field, 0, self::EQUAL);
}
}
else {
$this->query
->addWhere($this->options['group'], $field, 1, $query_operator);
}
}
}
/**
* Filters by operator empty.
*
* @param string $field
* The views field.
*/
protected function opEmpty(string $field) : void {
if ($this->operator === 'empty') {
$operator = "IS NULL";
}
else {
$operator = "IS NOT NULL";
}
$this->query
->addWhere($this->options['group'], $field, NULL, $operator);
}
/**
* Returns operators for values.
*
* @param int $values
* The values filter value.
*
* @return string[]
* A filtered list of operators.
*/
protected function operatorValues(int $values = 1) : array {
$options = [];
foreach ($this->operators() as $id => $info) {
if (isset($info['values']) && $info['values'] === $values) {
$options[] = $id;
}
}
return $options;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
BooleanOperator::$accept_null | public | property | |||
BooleanOperator::$alwaysMultiple | protected | property | Exposed filter options. | Overrides FilterPluginBase::$alwaysMultiple | |
BooleanOperator::$valueOptions | public | property | The value options. | ||
BooleanOperator::$value_value | public | property | |||
BooleanOperator::adminSummary | public | function | Display the filter on the administrative summary. | Overrides FilterPluginBase::adminSummary | |
BooleanOperator::defaultExposeOptions | public | function | Provide default options for exposed filters. | Overrides FilterPluginBase::defaultExposeOptions | |
BooleanOperator::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides FilterPluginBase::defineOptions | |
BooleanOperator::EQUAL | constant | The equal query operator. | |||
BooleanOperator::getValueOptions | public | function | Return the possible options for this filter. | ||
BooleanOperator::init | public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | Overrides FilterPluginBase::init | 1 |
BooleanOperator::NOT_EQUAL | constant | The non equal query operator. | |||
BooleanOperator::opEmpty | protected | function | Filters by operator empty. | ||
BooleanOperator::operatorOptions | public | function | Provide a list of options for the default operator form. | Overrides FilterPluginBase::operatorOptions | |
BooleanOperator::operators | public | function | Returns an array of operator information, keyed by operator ID. | Overrides FilterOperatorsInterface::operators | |
BooleanOperator::operatorValues | protected | function | Returns operators for values. | ||
BooleanOperator::query | public | function | Add this filter to the query. | Overrides FilterPluginBase::query | 3 |
BooleanOperator::queryOpBoolean | protected | function | Adds a where condition to the query for a boolean value. | ||
BooleanOperator::valueForm | protected | function | Options form subform for setting options. | Overrides FilterPluginBase::valueForm | |
BooleanOperator::valueValidate | protected | function | Validate the options form. | Overrides FilterPluginBase::valueValidate | |
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 | |
FilterPluginBase::$always_required | public | property | |||
FilterPluginBase::$group_info | public | property | |||
FilterPluginBase::$no_operator | public | property | 1 | ||
FilterPluginBase::$operator | public | property | Contains the operator which is used on the query. | ||
FilterPluginBase::$tableAliases | public | property | Keyed array by alias of table relations. | ||
FilterPluginBase::$value | public | property | The value. | ||
FilterPluginBase::acceptExposedInput | public | function | Determines if the input from a filter should change the generated query. | Overrides HandlerBase::acceptExposedInput | 2 |
FilterPluginBase::addGroupForm | public | function | Add a new group to the exposed filter groups. | ||
FilterPluginBase::arrayFilterZero | protected static | function | Filter by no empty values, though allow the use of (string) "0". | ||
FilterPluginBase::buildExposedFiltersGroupForm | protected | function | Build the form to let users create the group of exposed filters. | ||
FilterPluginBase::buildExposedForm | public | function | Render our chunk of the exposed filter form when selecting. | Overrides HandlerBase::buildExposedForm | |
FilterPluginBase::buildExposeForm | public | function | Options form subform for exposed filter options. | Overrides HandlerBase::buildExposeForm | 4 |
FilterPluginBase::buildGroupForm | public | function | Displays the Build Group form. | ||
FilterPluginBase::buildGroupOptions | protected | function | Provide default options for exposed filters. | ||
FilterPluginBase::buildGroupSubmit | protected | function | Save new group items, re-enumerates and remove groups marked to delete. | ||
FilterPluginBase::buildGroupValidate | protected | function | Validate the build group options form. | ||
FilterPluginBase::buildOptionsForm | public | function | Provide the basic form which calls through to subforms. | Overrides HandlerBase::buildOptionsForm | 2 |
FilterPluginBase::buildValueWrapper | protected | function | Builds wrapper for value and operator forms. | ||
FilterPluginBase::canBuildGroup | protected | function | Determine if a filter can be converted into a group. | ||
FilterPluginBase::canExpose | public | function | Determine if a filter can be exposed. | Overrides HandlerBase::canExpose | 5 |
FilterPluginBase::canGroup | public | function | Can this filter be used in OR groups? | 1 | |
FilterPluginBase::convertExposedInput | public | function | Transform the input from a grouped filter into a standard filter. | ||
FilterPluginBase::exposedInfo | public | function | Tell the renderer about our exposed form. | Overrides HandlerBase::exposedInfo | |
FilterPluginBase::exposedTranslate | protected | function | Make some translations to a form item to make it more suitable to exposing. | ||
FilterPluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | 6 |
FilterPluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | |
FilterPluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | 1 |
FilterPluginBase::groupForm | public | function | Builds a group form. | ||
FilterPluginBase::groupMultipleExposedInput | public | function | Group multiple exposed input. | ||
FilterPluginBase::hasValidGroupedValue | protected | function | Determines if the given grouped filter entry has a valid value. | 1 | |
FilterPluginBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides HandlerBase::isAGroup | |
FilterPluginBase::multipleExposedInput | public | function | Multiple exposed input. | Overrides HandlerBase::multipleExposedInput | |
FilterPluginBase::operatorForm | protected | function | Options form subform for setting the operator. | 6 | |
FilterPluginBase::operatorSubmit | public | function | Perform any necessary changes to the form values prior to storage. | ||
FilterPluginBase::operatorValidate | protected | function | Validate the operator form. | ||
FilterPluginBase::prepareFilterSelectOptions | protected | function | Sanitizes the HTML select element's options. | ||
FilterPluginBase::RESTRICTED_IDENTIFIERS | constant | A list of restricted identifiers. | |||
FilterPluginBase::showBuildGroupButton | protected | function | Shortcut to display the build_group/hide button. | ||
FilterPluginBase::showBuildGroupForm | public | function | Shortcut to display the exposed options form. | ||
FilterPluginBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | Overrides HandlerBase::showExposeButton | |
FilterPluginBase::showOperatorForm | public | function | Shortcut to display the operator form. | ||
FilterPluginBase::showValueForm | protected | function | Shortcut to display the value form. | ||
FilterPluginBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | Overrides HandlerBase::storeExposedInput | |
FilterPluginBase::storeGroupInput | public | function | If set to remember exposed input in the session, store it there. | ||
FilterPluginBase::submitOptionsForm | public | function | Simple submit handler. | Overrides PluginBase::submitOptionsForm | |
FilterPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
FilterPluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides HandlerBase::validate | 2 |
FilterPluginBase::validateExposeForm | public | function | Validate the options form. | Overrides HandlerBase::validateExposeForm | |
FilterPluginBase::validateIdentifier | protected | function | Validates a filter identifier. | ||
FilterPluginBase::validateOptionsForm | public | function | Simple validate handler. | Overrides PluginBase::validateOptionsForm | 1 |
FilterPluginBase::valueSubmit | protected | function | Perform any necessary changes to the form values prior to storage. | 1 | |
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::access | public | function | Check whether given user has access to this handler. | Overrides ViewsHandlerInterface::access | 5 |
HandlerBase::adminLabel | public | function | Return a string representing this handler's name in the UI. | Overrides ViewsHandlerInterface::adminLabel | 4 |
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::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::caseTransform | protected | function | Transform a string by a certain method. | ||
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::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::isExposed | public | function | Determine if this item is 'exposed'. | ||
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::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | |
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::validateExposed | public | function | Validate the exposed handler form. | 5 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | 1 | |
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 43 |
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::$renderer | protected | property | Stores the render API renderer. | 3 | |
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::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 61 |
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::getRenderer | protected | function | Returns the render API renderer. | 1 | |
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::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 |
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 | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.