class FilterPluginBase
Same name in other branches
- 9 core/modules/views/src/Plugin/views/filter/FilterPluginBase.php \Drupal\views\Plugin\views\filter\FilterPluginBase
- 10 core/modules/views/src/Plugin/views/filter/FilterPluginBase.php \Drupal\views\Plugin\views\filter\FilterPluginBase
- 11.x core/modules/views/src/Plugin/views/filter/FilterPluginBase.php \Drupal\views\Plugin\views\filter\FilterPluginBase
Base class for Views filters handler plugins.
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\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 FilterPluginBase
Related topics
9 files declare their use of FilterPluginBase
- Access.php in core/
modules/ node/ src/ Plugin/ views/ filter/ Access.php - FilterExceptionTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ filter/ FilterExceptionTest.php - FilterTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ filter/ FilterTest.php - HistoryUserTimestamp.php in core/
modules/ history/ src/ Plugin/ views/ filter/ HistoryUserTimestamp.php - Search.php in core/
modules/ search/ src/ Plugin/ views/ filter/ Search.php
File
-
core/
modules/ views/ src/ Plugin/ views/ filter/ FilterPluginBase.php, line 46
Namespace
Drupal\views\Plugin\views\filterView source
abstract class FilterPluginBase extends HandlerBase implements CacheableDependencyInterface {
/**
* Contains the actual value of the field,either configured in the views ui
* or entered in the exposed filters.
*/
public $value = NULL;
/**
* Contains the operator which is used on the query.
*
* @var string
*/
public $operator = '=';
/**
* Contains the information of the selected item in a grouped filter.
*/
public $group_info = NULL;
/**
* @var bool
* Disable the possibility to force a single value.
*/
protected $alwaysMultiple = FALSE;
/**
* @var bool
* Disable the possibility to use operators.
*/
public $no_operator = FALSE;
/**
* @var bool
* Disable the possibility to allow a exposed input to be optional.
*/
public $always_required = FALSE;
/**
* Overrides \Drupal\views\Plugin\views\HandlerBase::init().
*
* Provide some extra help to get the operator/value easier to use.
*
* This likely has to be overridden by filters which are more complex
* than simple operator/value.
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
$this->operator = $this->options['operator'];
$this->value = $this->options['value'];
$this->group_info = $this->options['group_info']['default_group'];
// Set the default value of the operator ID.
if (!empty($options['exposed']) && !empty($options['expose']['operator']) && !isset($options['expose']['operator_id'])) {
$this->options['expose']['operator_id'] = $options['expose']['operator'];
}
if ($this->multipleExposedInput()) {
$this->group_info = array_filter($options['group_info']['default_group_multiple']);
$this->options['expose']['multiple'] = TRUE;
}
// If there are relationships in the view, allow empty should be true
// so that we can do IS NULL checks on items. Not all filters respect
// allow empty, but string and numeric do and that covers enough.
if ($this->view->display_handler
->getOption('relationships')) {
$this->definition['allow empty'] = TRUE;
}
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['operator'] = [
'default' => '=',
];
$options['value'] = [
'default' => '',
];
$options['group'] = [
'default' => '1',
];
$options['exposed'] = [
'default' => FALSE,
];
$options['expose'] = [
'contains' => [
'operator_id' => [
'default' => FALSE,
],
'label' => [
'default' => '',
],
'description' => [
'default' => '',
],
'use_operator' => [
'default' => FALSE,
],
'operator' => [
'default' => '',
],
'operator_limit_selection' => [
'default' => FALSE,
],
'operator_list' => [
'default' => [],
],
'identifier' => [
'default' => '',
],
'required' => [
'default' => FALSE,
],
'remember' => [
'default' => FALSE,
],
'multiple' => [
'default' => FALSE,
],
'remember_roles' => [
'default' => [
RoleInterface::AUTHENTICATED_ID => RoleInterface::AUTHENTICATED_ID,
],
],
],
];
// A group is a combination of a filter, an operator and a value
// operating like a single filter.
// Users can choose from a select box which group they want to apply.
// Views will filter the view according to the defined values.
// Because it acts as a standard filter, we have to define
// an identifier and other settings like the widget and the label.
// This settings are saved in another array to allow users to switch
// between a normal filter and a group of filters with a single click.
$options['is_grouped'] = [
'default' => FALSE,
];
$options['group_info'] = [
'contains' => [
'label' => [
'default' => '',
],
'description' => [
'default' => '',
],
'identifier' => [
'default' => '',
],
'optional' => [
'default' => TRUE,
],
'widget' => [
'default' => 'select',
],
'multiple' => [
'default' => FALSE,
],
'remember' => [
'default' => 0,
],
'default_group' => [
'default' => 'All',
],
'default_group_multiple' => [
'default' => [],
],
'group_items' => [
'default' => [],
],
],
];
return $options;
}
/**
* Display the filter on the administrative summary
*/
public function adminSummary() {
return $this->operator . ' ' . $this->value;
}
/**
* Determine if a filter can be exposed.
*/
public function canExpose() {
return TRUE;
}
/**
* Determine if a filter can be converted into a group.
* Only exposed filters with operators available can be converted into groups.
*/
protected function canBuildGroup() {
return $this->isExposed() && count($this->operatorOptions()) > 0;
}
/**
* Returns TRUE if the exposed filter works like a grouped filter.
*/
public function isAGroup() {
return $this->isExposed() && !empty($this->options['is_grouped']);
}
/**
* 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.
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
if ($this->canExpose()) {
$this->showExposeButton($form, $form_state);
}
if ($this->canBuildGroup()) {
$this->showBuildGroupButton($form, $form_state);
}
$form['clear_markup_start'] = [
'#markup' => '<div class="clearfix">',
];
if ($this->isAGroup()) {
if ($this->canBuildGroup()) {
$form['clear_markup_start'] = [
'#markup' => '<div class="clearfix">',
];
// Render the build group form.
$this->showBuildGroupForm($form, $form_state);
$form['clear_markup_end'] = [
'#markup' => '</div>',
];
}
}
else {
// Add the subform from operatorForm().
$this->showOperatorForm($form, $form_state);
// Add the subform from valueForm().
$this->showValueForm($form, $form_state);
$form['clear_markup_end'] = [
'#markup' => '</div>',
];
if ($this->canExpose()) {
// Add the subform from buildExposeForm().
$this->showExposeForm($form, $form_state);
}
}
}
/**
* Simple validate handler
*/
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
$this->operatorValidate($form, $form_state);
$this->valueValidate($form, $form_state);
if (!empty($this->options['exposed']) && !$this->isAGroup()) {
$this->validateExposeForm($form, $form_state);
}
if ($this->isAGroup()) {
$this->buildGroupValidate($form, $form_state);
}
}
/**
* Simple submit handler
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
// Do not store these values.
$form_state->unsetValue('expose_button');
$form_state->unsetValue('group_button');
if (!$this->isAGroup()) {
$this->operatorSubmit($form, $form_state);
$this->valueSubmit($form, $form_state);
}
if (!empty($this->options['exposed'])) {
$this->submitExposeForm($form, $form_state);
}
if ($this->isAGroup()) {
$this->buildGroupSubmit($form, $form_state);
}
}
/**
* Shortcut to display the operator form.
*/
public function showOperatorForm(&$form, FormStateInterface $form_state) {
$this->operatorForm($form, $form_state);
$form['operator']['#prefix'] = '<div class="views-group-box views-left-30">';
$form['operator']['#suffix'] = '</div>';
}
/**
* Options form subform for setting the operator.
*
* This may be overridden by child classes, and it must
* define $form['operator'];
*
* @see buildOptionsForm()
*/
protected function operatorForm(&$form, FormStateInterface $form_state) {
$options = $this->operatorOptions();
if (!empty($options)) {
$form['operator'] = [
'#type' => count($options) < 10 ? 'radios' : 'select',
'#title' => $this->t('Operator'),
'#default_value' => $this->operator,
'#options' => $options,
];
}
}
/**
* Provide a list of options for the default operator form.
* Should be overridden by classes that don't override operatorForm
*/
public function operatorOptions() {
return [];
}
/**
* Validate the operator form.
*/
protected function operatorValidate($form, FormStateInterface $form_state) {
}
/**
* Perform any necessary changes to the form values prior to storage.
* There is no need for this function to actually store the data.
*/
public function operatorSubmit($form, FormStateInterface $form_state) {
}
/**
* Shortcut to display the value form.
*/
protected function showValueForm(&$form, FormStateInterface $form_state) {
$this->valueForm($form, $form_state);
if (empty($this->no_operator)) {
$form['value']['#prefix'] = '<div class="views-group-box views-right-70">' . (isset($form['value']['#prefix']) ? $form['value']['#prefix'] : '');
$form['value']['#suffix'] = (isset($form['value']['#suffix']) ? $form['value']['#suffix'] : '') . '</div>';
}
}
/**
* Options form subform for setting options.
*
* This should be overridden by all child classes and it must
* define $form['value']
*
* @see buildOptionsForm()
*/
protected function valueForm(&$form, FormStateInterface $form_state) {
$form['value'] = [];
}
/**
* Validate the options form.
*/
protected function valueValidate($form, FormStateInterface $form_state) {
}
/**
* Perform any necessary changes to the form values prior to storage.
* There is no need for this function to actually store the data.
*/
protected function valueSubmit($form, FormStateInterface $form_state) {
}
/**
* Shortcut to display the exposed options form.
*/
public function showBuildGroupForm(&$form, FormStateInterface $form_state) {
if (empty($this->options['is_grouped'])) {
return;
}
$this->buildExposedFiltersGroupForm($form, $form_state);
// When we click the expose button, we add new gadgets to the form but they
// have no data in POST so their defaults get wiped out. This prevents
// these defaults from getting wiped out. This setting will only be TRUE
// during a 2nd pass rerender.
if ($form_state->get('force_build_group_options')) {
foreach (Element::children($form['group_info']) as $id) {
if (isset($form['group_info'][$id]['#default_value']) && !isset($form['group_info'][$id]['#value'])) {
$form['group_info'][$id]['#value'] = $form['group_info'][$id]['#default_value'];
}
}
}
}
/**
* Shortcut to display the build_group/hide button.
*/
protected function showBuildGroupButton(&$form, FormStateInterface $form_state) {
$form['group_button'] = [
'#prefix' => '<div class="views-grouped clearfix">',
'#suffix' => '</div>',
// Should always come after the description and the relationship.
'#weight' => -190,
];
$grouped_description = $this->t('Grouped filters allow a choice between predefined operator|value pairs.');
$form['group_button']['radios'] = [
'#theme_wrappers' => [
'container',
],
'#attributes' => [
'class' => [
'js-only',
],
],
];
$form['group_button']['radios']['radios'] = [
'#title' => $this->t('Filter type to expose'),
'#description' => $grouped_description,
'#type' => 'radios',
'#options' => [
$this->t('Single filter'),
$this->t('Grouped filters'),
],
];
if (empty($this->options['is_grouped'])) {
$form['group_button']['markup'] = [
'#markup' => '<div class="description grouped-description">' . $grouped_description . '</div>',
];
$form['group_button']['button'] = [
'#limit_validation_errors' => [],
'#type' => 'submit',
'#value' => $this->t('Grouped filters'),
'#submit' => [
[
$this,
'buildGroupForm',
],
],
];
$form['group_button']['radios']['radios']['#default_value'] = 0;
}
else {
$form['group_button']['button'] = [
'#limit_validation_errors' => [],
'#type' => 'submit',
'#value' => $this->t('Single filter'),
'#submit' => [
[
$this,
'buildGroupForm',
],
],
];
$form['group_button']['radios']['radios']['#default_value'] = 1;
}
}
/**
* Displays the Build Group form.
*/
public function buildGroupForm($form, FormStateInterface $form_state) {
$item =& $this->options;
// flip. If the filter was a group, set back to a standard filter.
$item['is_grouped'] = empty($item['is_grouped']);
// If necessary, set new defaults:
if ($item['is_grouped']) {
$this->buildGroupOptions();
}
$view = $form_state->get('view');
$display_id = $form_state->get('display_id');
$type = $form_state->get('type');
$id = $form_state->get('id');
$view->getExecutable()
->setHandler($display_id, $type, $id, $item);
$view->addFormToStack($form_state->get('form_key'), $display_id, $type, $id, TRUE, TRUE);
$view->cacheSet();
$form_state->set('rerender', TRUE);
$form_state->setRebuild();
$form_state->get('force_build_group_options', TRUE);
}
/**
* Shortcut to display the expose/hide button.
*/
public function showExposeButton(&$form, FormStateInterface $form_state) {
$form['expose_button'] = [
'#prefix' => '<div class="views-expose clearfix">',
'#suffix' => '</div>',
// Should always come after the description and the relationship.
'#weight' => -200,
];
// Add a checkbox for JS users, which will have behavior attached to it
// so it can replace the button.
$form['expose_button']['checkbox'] = [
'#theme_wrappers' => [
'container',
],
'#attributes' => [
'class' => [
'js-only',
],
],
];
$form['expose_button']['checkbox']['checkbox'] = [
'#title' => $this->t('Expose this filter to visitors, to allow them to change it'),
'#type' => 'checkbox',
];
// Then add the button itself.
if (empty($this->options['exposed'])) {
$form['expose_button']['markup'] = [
'#markup' => '<div class="description exposed-description">' . $this->t('This filter is not exposed. Expose it to allow the users to change it.') . '</div>',
];
$form['expose_button']['button'] = [
'#limit_validation_errors' => [],
'#type' => 'submit',
'#value' => $this->t('Expose filter'),
'#submit' => [
[
$this,
'displayExposedForm',
],
],
];
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 0;
}
else {
$form['expose_button']['markup'] = [
'#markup' => '<div class="description exposed-description">' . $this->t('This filter is exposed. If you hide it, users will not be able to change it.') . '</div>',
];
$form['expose_button']['button'] = [
'#limit_validation_errors' => [],
'#type' => 'submit',
'#value' => $this->t('Hide filter'),
'#submit' => [
[
$this,
'displayExposedForm',
],
],
];
$form['expose_button']['checkbox']['checkbox']['#default_value'] = 1;
}
}
/**
* Options form subform for exposed filter options.
*
* @see buildOptionsForm()
*/
public function buildExposeForm(&$form, FormStateInterface $form_state) {
$form['#theme'] = 'views_ui_expose_filter_form';
// #flatten will move everything from $form['expose'][$key] to $form[$key]
// prior to rendering. That's why the preRender for it needs to run first,
// so that when the next preRender (the one for fieldsets) runs, it gets
// the flattened data.
array_unshift($form['#pre_render'], [
get_class($this),
'preRenderFlattenData',
]);
$form['expose']['#flatten'] = TRUE;
if (empty($this->always_required)) {
$form['expose']['required'] = [
'#type' => 'checkbox',
'#title' => $this->t('Required'),
'#default_value' => $this->options['expose']['required'],
];
}
else {
$form['expose']['required'] = [
'#type' => 'value',
'#value' => TRUE,
];
}
$form['expose']['label'] = [
'#type' => 'textfield',
'#default_value' => $this->options['expose']['label'],
'#title' => $this->t('Label'),
'#size' => 40,
];
$form['expose']['description'] = [
'#type' => 'textfield',
'#default_value' => $this->options['expose']['description'],
'#title' => $this->t('Description'),
'#size' => 60,
];
if (!empty($form['operator']['#type'])) {
// Increase the width of the left (operator) column.
$form['operator']['#prefix'] = '<div class="views-group-box views-left-40">';
$form['operator']['#suffix'] = '</div>';
$form['value']['#prefix'] = '<div class="views-group-box views-right-60">';
$form['value']['#suffix'] = '</div>';
$form['expose']['use_operator'] = [
'#type' => 'checkbox',
'#title' => $this->t('Expose operator'),
'#description' => $this->t('Allow the user to choose the operator.'),
'#default_value' => !empty($this->options['expose']['use_operator']),
];
$operators = $this->operatorOptions();
if (!empty($operators) && count($operators) > 1) {
$form['expose']['operator_limit_selection'] = [
'#type' => 'checkbox',
'#title' => $this->t('Limit the available operators'),
'#description' => $this->t('Limit the available operators to be shown on the exposed filter.'),
'#default_value' => !empty($this->options['expose']['operator_limit_selection']),
'#states' => [
'visible' => [
':input[name="options[expose][use_operator]"]' => [
'checked' => TRUE,
],
],
],
];
$form['expose']['operator_list'] = [
'#type' => 'select',
'#title' => $this->t('Restrict operators to'),
'#default_value' => $this->options['expose']['operator_list'],
'#options' => $operators,
'#multiple' => TRUE,
'#description' => $this->t('Selecting none will make all of them available.'),
'#states' => [
'visible' => [
':input[name="options[expose][operator_limit_selection]"]' => [
'checked' => TRUE,
],
':input[name="options[expose][use_operator]"]' => [
'checked' => TRUE,
],
],
],
];
}
$form['expose']['operator_id'] = [
'#type' => 'textfield',
'#default_value' => $this->options['expose']['operator_id'],
'#title' => $this->t('Operator identifier'),
'#size' => 40,
'#description' => $this->t('This will appear in the URL after the ? to identify this operator.'),
'#states' => [
'visible' => [
':input[name="options[expose][use_operator]"]' => [
'checked' => TRUE,
],
],
],
];
}
else {
$form['expose']['operator_id'] = [
'#type' => 'value',
'#value' => '',
];
}
if (empty($this->alwaysMultiple)) {
$form['expose']['multiple'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple selections'),
'#description' => $this->t('Enable to allow users to select multiple items.'),
'#default_value' => $this->options['expose']['multiple'],
];
}
$form['expose']['remember'] = [
'#type' => 'checkbox',
'#title' => $this->t('Remember the last selection'),
'#description' => $this->t('Enable to remember the last selection made by the user.'),
'#default_value' => $this->options['expose']['remember'],
];
$role_options = array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names());
$form['expose']['remember_roles'] = [
'#type' => 'checkboxes',
'#title' => $this->t('User roles'),
'#description' => $this->t('Remember exposed selection only for the selected user role(s). If you select no roles, the exposed data will never be stored.'),
'#default_value' => $this->options['expose']['remember_roles'],
'#options' => $role_options,
'#states' => [
'invisible' => [
':input[name="options[expose][remember]"]' => [
'checked' => FALSE,
],
],
],
];
$form['expose']['identifier'] = [
'#type' => 'textfield',
'#default_value' => $this->options['expose']['identifier'],
'#title' => $this->t('Filter identifier'),
'#size' => 40,
'#description' => $this->t('This will appear in the URL after the ? to identify this filter. Cannot be blank. Only letters, digits and the dot ("."), hyphen ("-"), underscore ("_"), and tilde ("~") characters are allowed.'),
];
}
/**
* {@inheritdoc}
*/
public static function trustedCallbacks() {
$callbacks = parent::trustedCallbacks();
$callbacks[] = 'preRenderFlattenData';
return $callbacks;
}
/**
* Validate the options form.
*/
public function validateExposeForm($form, FormStateInterface $form_state) {
$identifier = $form_state->getValue([
'options',
'expose',
'identifier',
]);
$this->validateIdentifier($identifier, $form_state, $form['expose']['identifier']);
$limit_operators = $form_state->getValue([
'options',
'expose',
'operator_limit_selection',
]);
$operators_selected = $form_state->getValue([
'options',
'expose',
'operator_list',
]);
$selected_operator = $form_state->getValue([
'options',
'operator',
]);
if ($limit_operators && !in_array($selected_operator, $operators_selected, TRUE)) {
$form_state->setError($form['expose']['operator_list'], $this->t('You selected the "@operator" operator as the default value but is not included in the list of limited operators.', [
'@operator' => $this->operatorOptions()[$selected_operator],
]));
}
}
/**
* Determines if the given grouped filter entry has a valid value.
*
* @param array $group
* A group entry as defined by buildGroupForm().
*
* @return bool
*/
protected function hasValidGroupedValue(array $group) {
$operators = $this->operators();
if ($operators[$group['operator']]['values'] == 0) {
// Some filters, such as "is empty," do not require a value to be
// specified in order to be valid entries.
return TRUE;
}
else {
if (is_string($group['value'])) {
return trim($group['value']) != '';
}
elseif (is_array($group['value'])) {
// Some filters allow multiple options to be selected (for example, node
// types). Ensure at least the minimum number of values is present for
// this entry to be considered valid.
$min_values = $operators[$group['operator']]['values'];
$actual_values = count(array_filter($group['value'], 'static::arrayFilterZero'));
return $actual_values >= $min_values;
}
}
return FALSE;
}
/**
* Validate the build group options form.
*/
protected function buildGroupValidate($form, FormStateInterface $form_state) {
if (!$form_state->isValueEmpty([
'options',
'group_info',
])) {
$identifier = $form_state->getValue([
'options',
'group_info',
'identifier',
]);
$this->validateIdentifier($identifier, $form_state, $form['group_info']['identifier']);
}
if ($group_items = $form_state->getValue([
'options',
'group_info',
'group_items',
])) {
foreach ($group_items as $id => $group) {
if (empty($group['remove'])) {
$has_valid_value = $this->hasValidGroupedValue($group);
if ($has_valid_value && $group['title'] == '') {
$operators = $this->operators();
if ($operators[$group['operator']]['values'] == 0) {
$form_state->setError($form['group_info']['group_items'][$id]['title'], $this->t('A label is required for the specified operator.'));
}
else {
$form_state->setError($form['group_info']['group_items'][$id]['title'], $this->t('A label is required if the value for this item is defined.'));
}
}
if (!$has_valid_value && $group['title'] != '') {
$form_state->setError($form['group_info']['group_items'][$id]['value'], $this->t('A value is required if the label for this item is defined.'));
}
}
}
}
}
/**
* Validates a filter identifier.
*
* Sets the form error if $form_state is passed or a error string if
* $form_state is not passed.
*
* @param string $identifier
* The identifier to check.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* @param array $form_group
* The form element to set any errors on.
*
* @return string
*/
protected function validateIdentifier($identifier, FormStateInterface $form_state = NULL, &$form_group = []) {
$error = '';
if (empty($identifier)) {
$error = $this->t('The identifier is required if the filter is exposed.');
}
elseif ($identifier == 'value') {
$error = $this->t('This identifier is not allowed.');
}
elseif (preg_match('/[^a-zA-Z0-9_~\\.\\-]+/', $identifier)) {
$error = $this->t('This identifier has illegal characters.');
}
if ($form_state && !$this->view->display_handler
->isIdentifierUnique($form_state->get('id'), $identifier)) {
$error = $this->t('This identifier is used by another handler.');
}
if (!empty($form_state) && !empty($error)) {
$form_state->setError($form_group, $error);
}
return $error;
}
/**
* Save new group items, re-enumerates and remove groups marked to delete.
*/
protected function buildGroupSubmit($form, FormStateInterface $form_state) {
$groups = [];
$group_items = $form_state->getValue([
'options',
'group_info',
'group_items',
]);
uasort($group_items, [
'Drupal\\Component\\Utility\\SortArray',
'sortByWeightElement',
]);
// Filter out removed items.
// Start from 1 to avoid problems with #default_value in the widget.
$new_id = 1;
$new_default = 'All';
foreach ($group_items as $id => $group) {
if (empty($group['remove'])) {
// Don't store this.
unset($group['remove']);
unset($group['weight']);
$groups[$new_id] = $group;
if ($form_state->getValue([
'options',
'group_info',
'default_group',
]) == $id) {
$new_default = $new_id;
}
}
$new_id++;
}
if ($new_default != 'All') {
$form_state->setValue([
'options',
'group_info',
'default_group',
], $new_default);
}
$filter_default_multiple = $form_state->getValue([
'options',
'group_info',
'default_group_multiple',
]);
$form_state->setValue([
'options',
'group_info',
'default_group_multiple',
], array_filter($filter_default_multiple));
$form_state->setValue([
'options',
'group_info',
'group_items',
], $groups);
}
/**
* Provide default options for exposed filters.
*/
public function defaultExposeOptions() {
$this->options['expose'] = [
'use_operator' => FALSE,
'operator' => $this->options['id'] . '_op',
'operator_limit_selection' => FALSE,
'operator_list' => [],
'identifier' => $this->options['id'],
'label' => $this->definition['title'],
'description' => NULL,
'remember' => FALSE,
'multiple' => FALSE,
'required' => FALSE,
];
}
/**
* Provide default options for exposed filters.
*/
protected function buildGroupOptions() {
$this->options['group_info'] = [
'label' => $this->definition['title'],
'description' => NULL,
'identifier' => $this->options['id'],
'optional' => TRUE,
'widget' => 'select',
'multiple' => FALSE,
'remember' => FALSE,
'default_group' => 'All',
'default_group_multiple' => [],
'group_items' => [],
];
}
/**
* Build a form containing a group of operator | values to apply as a
* single filter.
*/
public function groupForm(&$form, FormStateInterface $form_state) {
if (!empty($this->options['group_info']['optional']) && !$this->multipleExposedInput()) {
$groups = [
'All' => $this->t('- Any -'),
];
}
foreach ($this->options['group_info']['group_items'] as $id => $group) {
if (!empty($group['title'])) {
$groups[$id] = $id != 'All' ? $this->t($group['title']) : $group['title'];
}
}
if (count($groups)) {
$value = $this->options['group_info']['identifier'];
$form[$value] = [
'#title' => $this->options['group_info']['label'],
'#type' => $this->options['group_info']['widget'],
'#default_value' => $this->group_info,
'#options' => $groups,
];
if (!empty($this->options['group_info']['multiple'])) {
if (count($groups) < 5) {
$form[$value]['#type'] = 'checkboxes';
}
else {
$form[$value]['#type'] = 'select';
$form[$value]['#size'] = 5;
$form[$value]['#multiple'] = TRUE;
}
unset($form[$value]['#default_value']);
$user_input = $form_state->getUserInput();
if (empty($user_input)) {
$user_input[$value] = $this->group_info;
$form_state->setUserInput($user_input);
}
}
$this->options['expose']['label'] = '';
}
}
/**
* Render our chunk of the exposed filter form when selecting
*
* You can override this if it doesn't do what you expect.
*/
public function buildExposedForm(&$form, FormStateInterface $form_state) {
if (empty($this->options['exposed'])) {
return;
}
// Build the exposed form, when its based on an operator.
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
$operator = $this->options['expose']['operator_id'];
$this->operatorForm($form, $form_state);
// Limit the exposed operators if needed.
if (!empty($this->options['expose']['operator_limit_selection']) && !empty($this->options['expose']['operator_list'])) {
$options = $this->operatorOptions();
$operator_list = $this->options['expose']['operator_list'];
$form['operator']['#options'] = array_intersect_key($options, $operator_list);
}
$form[$operator] = $form['operator'];
$this->exposedTranslate($form[$operator], 'operator');
unset($form['operator']);
}
// Build the form and set the value based on the identifier.
if (!empty($this->options['expose']['identifier'])) {
$value = $this->options['expose']['identifier'];
$this->valueForm($form, $form_state);
$form[$value] = $form['value'];
if (isset($form[$value]['#title']) && !empty($form[$value]['#type']) && $form[$value]['#type'] != 'checkbox') {
unset($form[$value]['#title']);
}
$this->exposedTranslate($form[$value], 'value');
if ($value != 'value') {
unset($form['value']);
}
}
}
/**
* Build the form to let users create the group of exposed filters.
* This form is displayed when users click on button 'Build group'
*/
protected function buildExposedFiltersGroupForm(&$form, FormStateInterface $form_state) {
if (empty($this->options['exposed']) || empty($this->options['is_grouped'])) {
return;
}
$form['#theme'] = 'views_ui_build_group_filter_form';
// #flatten will move everything from $form['group_info'][$key] to $form[$key]
// prior to rendering. That's why the preRender for it needs to run first,
// so that when the next preRender (the one for fieldsets) runs, it gets
// the flattened data.
array_unshift($form['#pre_render'], [
get_class($this),
'preRenderFlattenData',
]);
$form['group_info']['#flatten'] = TRUE;
if (!empty($this->options['group_info']['identifier'])) {
$identifier = $this->options['group_info']['identifier'];
}
else {
$identifier = 'group_' . $this->options['expose']['identifier'];
}
$form['group_info']['identifier'] = [
'#type' => 'textfield',
'#default_value' => $identifier,
'#title' => $this->t('Filter identifier'),
'#size' => 40,
'#description' => $this->t('This will appear in the URL after the ? to identify this filter. Cannot be blank. Only letters, digits and the dot ("."), hyphen ("-"), underscore ("_"), and tilde ("~") characters are allowed.'),
];
$form['group_info']['label'] = [
'#type' => 'textfield',
'#default_value' => $this->options['group_info']['label'],
'#title' => $this->t('Label'),
'#size' => 40,
];
$form['group_info']['description'] = [
'#type' => 'textfield',
'#default_value' => $this->options['group_info']['description'],
'#title' => $this->t('Description'),
'#size' => 60,
];
$form['group_info']['optional'] = [
'#type' => 'checkbox',
'#title' => $this->t('Optional'),
'#description' => $this->t('This exposed filter is optional and will have added options to allow it not to be set.'),
'#default_value' => $this->options['group_info']['optional'],
];
$form['group_info']['multiple'] = [
'#type' => 'checkbox',
'#title' => $this->t('Allow multiple selections'),
'#description' => $this->t('Enable to allow users to select multiple items.'),
'#default_value' => $this->options['group_info']['multiple'],
];
$form['group_info']['widget'] = [
'#type' => 'radios',
'#default_value' => $this->options['group_info']['widget'],
'#title' => $this->t('Widget type'),
'#options' => [
'radios' => $this->t('Radios'),
'select' => $this->t('Select'),
],
'#description' => $this->t('Select which kind of widget will be used to render the group of filters'),
];
$form['group_info']['remember'] = [
'#type' => 'checkbox',
'#title' => $this->t('Remember'),
'#description' => $this->t('Remember the last setting the user gave this filter.'),
'#default_value' => $this->options['group_info']['remember'],
];
if (!empty($this->options['group_info']['identifier'])) {
$identifier = $this->options['group_info']['identifier'];
}
else {
$identifier = 'group_' . $this->options['expose']['identifier'];
}
$form['group_info']['identifier'] = [
'#type' => 'textfield',
'#default_value' => $identifier,
'#title' => $this->t('Filter identifier'),
'#size' => 40,
'#description' => $this->t('This will appear in the URL after the ? to identify this filter. Cannot be blank. Only letters, digits and the dot ("."), hyphen ("-"), underscore ("_"), and tilde ("~") characters are allowed.'),
];
$form['group_info']['label'] = [
'#type' => 'textfield',
'#default_value' => $this->options['group_info']['label'],
'#title' => $this->t('Label'),
'#size' => 40,
];
$form['group_info']['optional'] = [
'#type' => 'checkbox',
'#title' => $this->t('Optional'),
'#description' => $this->t('This exposed filter is optional and will have added options to allow it not to be set.'),
'#default_value' => $this->options['group_info']['optional'],
];
$form['group_info']['widget'] = [
'#type' => 'radios',
'#default_value' => $this->options['group_info']['widget'],
'#title' => $this->t('Widget type'),
'#options' => [
'radios' => $this->t('Radios'),
'select' => $this->t('Select'),
],
'#description' => $this->t('Select which kind of widget will be used to render the group of filters'),
];
$form['group_info']['remember'] = [
'#type' => 'checkbox',
'#title' => $this->t('Remember'),
'#description' => $this->t('Remember the last setting the user gave this filter.'),
'#default_value' => $this->options['group_info']['remember'],
];
// The string '- Any -' will not be rendered.
// @see theme_views_ui_build_group_filter_form()
$groups = [
'All' => $this->t('- Any -'),
];
// Provide 3 options to start when we are in a new group.
if (count($this->options['group_info']['group_items']) == 0) {
$this->options['group_info']['group_items'] = array_fill(1, 3, []);
}
// After the general settings, comes a table with all the existent groups.
$default_weight = 0;
foreach ($this->options['group_info']['group_items'] as $item_id => $item) {
if (!$form_state->isValueEmpty([
'options',
'group_info',
'group_items',
$item_id,
'remove',
])) {
continue;
}
// Each rows contains three widgets:
// a) The title, where users define how they identify a pair of operator | value
// b) The operator
// c) The value (or values) to use in the filter with the selected operator
// In each row, we have to display the operator form and the value from
// $row acts as a fake form to render each widget in a row.
$row = [];
$groups[$item_id] = $this->t('Grouping @id', [
'@id' => $item_id,
]);
$this->operatorForm($row, $form_state);
// Force the operator form to be a select box. Some handlers uses
// radios and they occupy a lot of space in a table row.
$row['operator']['#type'] = 'select';
$row['operator']['#title'] = '';
$this->valueForm($row, $form_state);
// Fix the dependencies to update value forms when operators changes. This
// is needed because forms are inside a new form and their IDs changes.
// Dependencies are used when operator changes from to 'Between',
// 'Not Between', etc, and two or more widgets are displayed.
FormHelper::rewriteStatesSelector($row['value'], ':input[name="options[operator]"]', ':input[name="options[group_info][group_items][' . $item_id . '][operator]"]');
// Set default values.
$children = Element::children($row['value']);
if (!empty($children)) {
foreach ($children as $child) {
if (!empty($row['value'][$child]['#states']['visible'])) {
foreach ($row['value'][$child]['#states']['visible'] as $state) {
if (isset($state[':input[name="options[group_info][group_items][' . $item_id . '][operator]"]'])) {
$row['value'][$child]['#title'] = '';
// Exit this loop and process the next child element.
break;
}
}
}
if (!empty($this->options['group_info']['group_items'][$item_id]['value'][$child])) {
$row['value'][$child]['#default_value'] = $this->options['group_info']['group_items'][$item_id]['value'][$child];
}
}
}
else {
if (isset($this->options['group_info']['group_items'][$item_id]['value']) && $this->options['group_info']['group_items'][$item_id]['value'] != '') {
$row['value']['#default_value'] = $this->options['group_info']['group_items'][$item_id]['value'];
}
}
if (!empty($this->options['group_info']['group_items'][$item_id]['operator'])) {
$row['operator']['#default_value'] = $this->options['group_info']['group_items'][$item_id]['operator'];
}
$default_title = '';
if (!empty($this->options['group_info']['group_items'][$item_id]['title'])) {
$default_title = $this->options['group_info']['group_items'][$item_id]['title'];
}
// Per item group, we have a title that identifies it.
$form['group_info']['group_items'][$item_id] = [
'title' => [
'#title' => $this->t('Label'),
'#title_display' => 'invisible',
'#type' => 'textfield',
'#size' => 20,
'#default_value' => $default_title,
],
'operator' => $row['operator'],
'value' => $row['value'],
// No title is given here, since this input is never displayed. It is
// only triggered by JavaScript.
'remove' => [
'#type' => 'checkbox',
'#id' => 'views-removed-' . $item_id,
'#attributes' => [
'class' => [
'views-remove-checkbox',
],
],
'#default_value' => 0,
],
'weight' => [
'#title' => $this->t('Weight'),
'#title_display' => 'invisible',
'#type' => 'weight',
'#delta' => count($this->options['group_info']['group_items']),
'#default_value' => $default_weight++,
'#attributes' => [
'class' => [
'weight',
],
],
],
];
}
// From all groups, let chose which is the default.
$form['group_info']['default_group'] = [
'#type' => 'radios',
'#options' => $groups,
'#default_value' => $this->options['group_info']['default_group'],
'#required' => TRUE,
'#attributes' => [
'class' => [
'default-radios',
],
],
];
// From all groups, let chose which is the default.
$form['group_info']['default_group_multiple'] = [
'#type' => 'checkboxes',
'#options' => $groups,
'#default_value' => $this->options['group_info']['default_group_multiple'],
'#attributes' => [
'class' => [
'default-checkboxes',
],
],
];
$form['group_info']['add_group'] = [
'#prefix' => '<div class="views-build-group clear-block">',
'#suffix' => '</div>',
'#type' => 'submit',
'#value' => $this->t('Add another item'),
'#submit' => [
[
$this,
'addGroupForm',
],
],
];
$js = [];
$js['tableDrag']['views-filter-groups']['weight'][0] = [
'target' => 'weight',
'source' => NULL,
'relationship' => 'sibling',
'action' => 'order',
'hidden' => TRUE,
'limit' => 0,
];
$js_settings = $form_state->get('js_settings');
if ($js_settings && is_array($js)) {
$js_settings = array_merge($js_settings, $js);
}
else {
$js_settings = $js;
}
$form_state->set('js_settings', $js_settings);
}
/**
* Add a new group to the exposed filter groups.
*/
public function addGroupForm($form, FormStateInterface $form_state) {
$item =& $this->options;
// Add a new row.
$item['group_info']['group_items'][] = [];
$view = $form_state->get('view');
$display_id = $form_state->get('display_id');
$type = $form_state->get('type');
$id = $form_state->get('id');
$view->getExecutable()
->setHandler($display_id, $type, $id, $item);
$view->cacheSet();
$form_state->set('rerender', TRUE);
$form_state->setRebuild();
$form_state->get('force_build_group_options', TRUE);
}
/**
* Make some translations to a form item to make it more suitable to
* exposing.
*/
protected function exposedTranslate(&$form, $type) {
if (!isset($form['#type'])) {
return;
}
if ($form['#type'] == 'radios') {
$form['#type'] = 'select';
}
// Checkboxes don't work so well in exposed forms due to GET conversions.
if ($form['#type'] == 'checkboxes') {
if (empty($form['#no_convert']) || empty($this->options['expose']['multiple'])) {
$form['#type'] = 'select';
}
if (!empty($this->options['expose']['multiple'])) {
$form['#multiple'] = TRUE;
}
}
if (empty($this->options['expose']['multiple']) && isset($form['#multiple'])) {
unset($form['#multiple']);
$form['#size'] = NULL;
}
// Cleanup in case the translated element's (radios or checkboxes) display value contains html.
if ($form['#type'] == 'select') {
$this->prepareFilterSelectOptions($form['#options']);
}
if ($type == 'value' && empty($this->always_required) && empty($this->options['expose']['required']) && $form['#type'] == 'select' && empty($form['#multiple'])) {
$form['#options'] = [
'All' => $this->t('- Any -'),
] + $form['#options'];
$form['#default_value'] = 'All';
}
if (!empty($this->options['expose']['required'])) {
$form['#required'] = TRUE;
}
}
/**
* Sanitizes the HTML select element's options.
*
* The function is recursive to support optgroups.
*/
protected function prepareFilterSelectOptions(&$options) {
foreach ($options as $value => $label) {
// Recurse for optgroups.
if (is_array($label)) {
$this->prepareFilterSelectOptions($options[$value]);
}
elseif (is_object($label) && isset($label->option)) {
$this->prepareFilterSelectOptions($options[$value]->option);
}
else {
// Cast the label to a string since it can be an object.
// @see \Drupal\Core\StringTranslation\TranslatableMarkup
$options[$value] = strip_tags(Html::decodeEntities((string) $label));
}
}
}
/**
* Tell the renderer about our exposed form. This only needs to be
* overridden for particularly complex forms. And maybe not even then.
*
* @return array|null
* For standard exposed filters. An array with the following keys:
* - operator: The $form key of the operator. Set to NULL if no operator.
* - value: The $form key of the value. Set to NULL if no value.
* - label: The label to use for this piece.
* For grouped exposed filters. An array with the following keys:
* - value: The $form key of the value. Set to NULL if no value.
* - label: The label to use for this piece.
*/
public function exposedInfo() {
if (empty($this->options['exposed'])) {
return;
}
if ($this->isAGroup()) {
return [
'value' => $this->options['group_info']['identifier'],
'label' => $this->options['group_info']['label'],
'description' => $this->options['group_info']['description'],
];
}
return [
'operator' => $this->options['expose']['operator_id'],
'value' => $this->options['expose']['identifier'],
'label' => $this->options['expose']['label'],
'description' => $this->options['expose']['description'],
];
}
/**
* Transform the input from a grouped filter into a standard filter.
*
* When a filter is a group, find the set of operator and values
* that the chosen item represents, and inform views that a normal
* filter was submitted by telling the operator and the value selected.
*
* The param $selected_group_id is only passed when the filter uses the
* checkboxes widget, and this function will be called for each item
* chosen in the checkboxes.
*/
public function convertExposedInput(&$input, $selected_group_id = NULL) {
if ($this->isAGroup()) {
// If it is already defined the selected group, use it. Only valid
// when the filter uses checkboxes for widget.
if (!empty($selected_group_id)) {
$selected_group = $selected_group_id;
}
else {
$selected_group = $input[$this->options['group_info']['identifier']];
}
if ($selected_group == 'All' && !empty($this->options['group_info']['optional'])) {
return NULL;
}
if ($selected_group != 'All' && empty($this->options['group_info']['group_items'][$selected_group])) {
return FALSE;
}
if (isset($selected_group) && isset($this->options['group_info']['group_items'][$selected_group])) {
$input[$this->options['expose']['operator']] = $this->options['group_info']['group_items'][$selected_group]['operator'];
// Value can be optional, For example for 'empty' and 'not empty' filters.
if (isset($this->options['group_info']['group_items'][$selected_group]['value']) && $this->options['group_info']['group_items'][$selected_group]['value'] !== '') {
$input[$this->options['group_info']['identifier']] = $this->options['group_info']['group_items'][$selected_group]['value'];
}
$this->options['expose']['use_operator'] = TRUE;
$this->group_info = $input[$this->options['group_info']['identifier']];
return TRUE;
}
else {
return FALSE;
}
}
}
/**
* 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.
*/
public function groupMultipleExposedInput(&$input) {
if (!empty($input[$this->options['group_info']['identifier']])) {
return array_filter($input[$this->options['group_info']['identifier']]);
}
return [];
}
/**
* Returns TRUE if users can select multiple groups items of a
* grouped exposed filter.
*/
public function multipleExposedInput() {
return $this->isAGroup() && !empty($this->options['group_info']['multiple']);
}
/**
* 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.
*/
public function storeGroupInput($input, $status) {
if (!$this->isAGroup() || empty($this->options['group_info']['identifier'])) {
return TRUE;
}
if (empty($this->options['group_info']['remember'])) {
return;
}
// Figure out which display id is responsible for the filters, so we
// know where to look for session stored values.
$display_id = $this->view->display_handler
->isDefaulted('filters') ? 'default' : $this->view->current_display;
// False means that we got a setting that means to recurse ourselves,
// so we should erase whatever happened to be there.
if ($status === FALSE && isset($_SESSION['views'][$this->view->storage
->id()][$display_id])) {
$session =& $_SESSION['views'][$this->view->storage
->id()][$display_id];
if (isset($session[$this->options['group_info']['identifier']])) {
unset($session[$this->options['group_info']['identifier']]);
}
}
if ($status !== FALSE) {
if (!isset($_SESSION['views'][$this->view->storage
->id()][$display_id])) {
$_SESSION['views'][$this->view->storage
->id()][$display_id] = [];
}
$session =& $_SESSION['views'][$this->view->storage
->id()][$display_id];
$session[$this->options['group_info']['identifier']] = $input[$this->options['group_info']['identifier']];
}
}
/**
* Determines if the input from a filter should change the generated query.
*
* @param array $input
* The exposed data for this view.
*
* @return bool
* TRUE if the input for this filter should be included in the view query.
* FALSE otherwise.
*/
public function acceptExposedInput($input) {
if (empty($this->options['exposed'])) {
return TRUE;
}
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']) && isset($input[$this->options['expose']['operator_id']])) {
$this->operator = $input[$this->options['expose']['operator_id']];
}
if (!empty($this->options['expose']['identifier'])) {
if ($this->options['is_grouped']) {
$value = $input[$this->options['group_info']['identifier']];
}
else {
$value = $input[$this->options['expose']['identifier']];
}
// Various ways to check for the absence of non-required input.
if (empty($this->options['expose']['required'])) {
if (($this->operator == 'empty' || $this->operator == 'not empty') && $value === '') {
$value = ' ';
}
if ($this->operator != 'empty' && $this->operator != 'not empty') {
if ($value == 'All' || $value === []) {
return FALSE;
}
// If checkboxes are used to render this filter, do not include the
// filter if no options are checked.
if (is_array($value) && Checkboxes::detectEmptyCheckboxes($value)) {
return FALSE;
}
}
if (!empty($this->alwaysMultiple) && $value === '') {
return FALSE;
}
}
if (isset($value)) {
$this->value = $value;
if (empty($this->alwaysMultiple) && empty($this->options['expose']['multiple']) && !is_array($value)) {
$this->value = [
$value,
];
}
}
else {
return FALSE;
}
}
return TRUE;
}
public function storeExposedInput($input, $status) {
if (empty($this->options['exposed']) || empty($this->options['expose']['identifier'])) {
return TRUE;
}
if (empty($this->options['expose']['remember'])) {
return;
}
// Check if we store exposed value for current user.
$user = \Drupal::currentUser();
$allowed_rids = empty($this->options['expose']['remember_roles']) ? [] : array_filter($this->options['expose']['remember_roles']);
$intersect_rids = array_intersect(array_keys($allowed_rids), $user->getRoles());
if (empty($intersect_rids)) {
return;
}
// Figure out which display id is responsible for the filters, so we
// know where to look for session stored values.
$display_id = $this->view->display_handler
->isDefaulted('filters') ? 'default' : $this->view->current_display;
// shortcut test.
$operator = !empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']);
// False means that we got a setting that means to recurse ourselves,
// so we should erase whatever happened to be there.
if (!$status && isset($_SESSION['views'][$this->view->storage
->id()][$display_id])) {
$session =& $_SESSION['views'][$this->view->storage
->id()][$display_id];
if ($operator && isset($session[$this->options['expose']['operator_id']])) {
unset($session[$this->options['expose']['operator_id']]);
}
if (isset($session[$this->options['expose']['identifier']])) {
unset($session[$this->options['expose']['identifier']]);
}
}
if ($status) {
if (!isset($_SESSION['views'][$this->view->storage
->id()][$display_id])) {
$_SESSION['views'][$this->view->storage
->id()][$display_id] = [];
}
$session =& $_SESSION['views'][$this->view->storage
->id()][$display_id];
if ($operator && isset($input[$this->options['expose']['operator_id']])) {
$session[$this->options['expose']['operator_id']] = $input[$this->options['expose']['operator_id']];
}
$session[$this->options['expose']['identifier']] = $input[$this->options['expose']['identifier']];
}
}
/**
* Add this filter to the query.
*
* Due to the nature of fapi, the value and the operator have an unintended
* level of indirection. You will find them in $this->operator
* and $this->value respectively.
*/
public function query() {
$this->ensureMyTable();
$this->query
->addWhere($this->options['group'], "{$this->tableAlias}.{$this->realField}", $this->value, $this->operator);
}
/**
* Can this filter be used in OR groups?
*
* Some filters have complicated where clauses that cannot be easily used
* with OR groups. Some filters must also use HAVING which also makes
* them not groupable. These filters will end up in a special group
* if OR grouping is in use.
*
* @return bool
*/
public function canGroup() {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return Cache::PERMANENT;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
$cache_contexts = [];
// An exposed filter allows the user to change a view's filters. They accept
// input from GET parameters, which are part of the URL. Hence a view with
// an exposed filter is cacheable per URL.
if ($this->isExposed()) {
$cache_contexts[] = 'url';
}
return $cache_contexts;
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return [];
}
/**
* {@inheritdoc}
*/
public function validate() {
if (!empty($this->options['exposed']) && ($error = $this->validateIdentifier($this->options['expose']['identifier']))) {
return [
$error,
];
}
}
/**
* Filter by no empty values, though allow the use of (string) "0".
*
* @param string $var
* The variable to evaluate.
*
* @return bool
* TRUE if the value is equal to an empty string, FALSE otherwise.
*/
protected static function arrayFilterZero($var) {
if (is_int($var)) {
return $var != 0;
}
return trim($var) != '';
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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::$alwaysMultiple | protected | property | Disable the possibility to force a single value. | 6 | |
FilterPluginBase::$always_required | public | property | Disable the possibility to allow a exposed input to be optional. | ||
FilterPluginBase::$group_info | public | property | Contains the information of the selected item in a grouped filter. | ||
FilterPluginBase::$no_operator | public | property | Disable the possibility to use operators. | 1 | |
FilterPluginBase::$operator | public | property | Contains the operator which is used on the query. | ||
FilterPluginBase::$value | public | property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. |
||
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::adminSummary | public | function | Display the filter on the administrative summary | Overrides HandlerBase::adminSummary | 10 |
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. This form is displayed when users click on button 'Build group' |
||
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. 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 HandlerBase::buildOptionsForm | 2 |
FilterPluginBase::canBuildGroup | protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. |
||
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::defaultExposeOptions | public | function | Provide default options for exposed filters. | Overrides HandlerBase::defaultExposeOptions | 4 |
FilterPluginBase::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides HandlerBase::defineOptions | 6 |
FilterPluginBase::exposedInfo | 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::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 | 7 |
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 | Build a form containing a group of operator | values to apply as a single filter. |
||
FilterPluginBase::groupMultipleExposedInput | 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::hasValidGroupedValue | protected | function | Determines if the given grouped filter entry has a valid value. | 1 | |
FilterPluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\HandlerBase::init(). | Overrides HandlerBase::init | 4 |
FilterPluginBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | Overrides HandlerBase::isAGroup | |
FilterPluginBase::multipleExposedInput | public | function | Returns TRUE if users can select multiple groups items of a grouped exposed filter. |
Overrides HandlerBase::multipleExposedInput | |
FilterPluginBase::operatorForm | protected | function | Options form subform for setting the operator. | 6 | |
FilterPluginBase::operatorOptions | public | function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operatorForm |
5 | |
FilterPluginBase::operatorSubmit | 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::operatorValidate | protected | function | Validate the operator form. | ||
FilterPluginBase::prepareFilterSelectOptions | protected | function | Sanitizes the HTML select element's options. | ||
FilterPluginBase::query | public | function | Add this filter to the query. | Overrides HandlerBase::query | 15 |
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. This function is similar to storeExposedInput but modified to work properly when the filter is a group. |
||
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::valueForm | protected | function | Options form subform for setting options. | 7 | |
FilterPluginBase::valueSubmit | 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. |
1 | |
FilterPluginBase::valueValidate | protected | function | Validate the options form. | 3 | |
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | ||
HandlerBase::$moduleHandler | protected | property | The module handler. | 3 | |
HandlerBase::$query | public | property | Where the $query object will reside: | 7 | |
HandlerBase::$realField | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. |
||
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 | 4 |
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', meaning it's a placeholder used when a handler can't be found. |
Overrides ViewsHandlerInterface::broken | |
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | |
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | |
HandlerBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 10 |
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 | Ensure the main table for this handler is in the query. This is used a lot. |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. |
1 | |
HandlerBase::isExposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
||
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 | Called just prior to query(), this lets a handler set up any relationship it needs. |
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. There is no need for this function to actually store the data. |
||
HandlerBase::submitExtraOptionsForm | 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::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. There is no need for this function to actually store the data. |
1 | |
HandlerBase::submitTemporaryForm | public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. |
||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | |
HandlerBase::validateExposed | public | function | Validate the exposed handler form | 4 | |
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | ||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 44 |
PluginBase::$definition | public | property | Plugins's 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::$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 | 62 |
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 | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
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. The resulting string will be sanitized with Xss::filterAdmin. |
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. | |||
TrustedCallbackInterface::TRIGGER_WARNING | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.