Drupal 8  8.0.2
ExposedFormPluginBase Class Reference
Inheritance diagram for ExposedFormPluginBase:

Public Member Functions

 buildOptionsForm (&$form, FormStateInterface $form_state)
 renderExposedForm ($block=FALSE)
 query ()
 preRender ($values)
 postRender (&$output)
 preExecute ()
 postExecute ()
 exposedFormAlter (&$form, FormStateInterface $form_state)
 exposedFormValidate (&$form, FormStateInterface $form_state)
 exposedFormSubmit (&$form, FormStateInterface $form_state, &$exclude)
 resetForm (&$form, FormStateInterface $form_state)
 getCacheMaxAge ()
 getCacheTags ()
- Public Member Functions inherited from PluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 filterByDefinedOptions (array &$storage)
 unpackOptions (&$storage, $options, $definition=NULL, $all=TRUE, $check=TRUE)
 destroy ()
 buildOptionsForm (&$form, FormStateInterface $form_state)
 validateOptionsForm (&$form, FormStateInterface $form_state)
 submitOptionsForm (&$form, FormStateInterface $form_state)
 query ()
 themeFunctions ()
 validate ()
 summaryTitle ()
 pluginTitle ()
 usesOptions ()
 globalTokenReplace ($string= '', array $options=array())
 getAvailableGlobalTokens ($prepared=FALSE, array $types=array())
 globalTokenForm (&$form, FormStateInterface $form_state)
 calculateDependencies ()
 getProvider ()
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 getPluginDefinition ()
- Public Member Functions inherited from DerivativeInspectionInterface
 getBaseId ()
 getDerivativeId ()
- Public Member Functions inherited from CacheableDependencyInterface
 getCacheContexts ()

Protected Member Functions

 defineOptions ()
- Protected Member Functions inherited from PluginBase
 defineOptions ()
 setOptionDefaults (array &$storage, array $options)
 doFilterByDefinedOptions (array &$storage, array $options)
 viewsTokenReplace ($text, $tokens)
 listLanguages ($flags=LanguageInterface::STATE_ALL, array $current_values=NULL)
 getRenderer ()

Protected Attributes

 $usesOptions = TRUE
- Protected Attributes inherited from PluginBase
 $usesOptions = FALSE

Additional Inherited Members

- Static Public Member Functions inherited from PluginBase
static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
static preRenderAddFieldsetMarkup (array $form)
static preRenderFlattenData ($form)
static queryLanguageSubstitutions ()
- Data Fields inherited from PluginBase
 $options = array()
 $view = NULL

Detailed Description

Base class for Views exposed filter form plugins.

Member Function Documentation

buildOptionsForm ( $form,
FormStateInterface  $form_state 

Provide a form to edit options for this plugin.

Implements ViewsPluginInterface.

References t().

Here is the call graph for this function:

exposedFormAlter ( $form,
FormStateInterface  $form_state 

Alters the view exposed form.

$formThe form build array. Passed by reference.
$form_stateThe form state. Passed by reference.

References Html\escape(), FormStateInterface\getUserInput(), FormStateInterface\set(), FormStateInterface\setUserInput(), and t().

Here is the call graph for this function:

exposedFormSubmit ( $form,
FormStateInterface  $form_state,

This function is executed when exposed form is submitted.

$formNested array of form elements that comprise the form.
$form_stateThe current state of the form.
$excludeNested array of keys to exclude of insert into $view->exposed_raw_input

References FormStateInterface\get(), FormStateInterface\getValue(), and FormStateInterface\isValueEmpty().

Here is the call graph for this function:

getCacheMaxAge ( )

{The maximum age for which this object may be cached.

int The maximum time in seconds that this object may be cached.

Implements CacheableDependencyInterface.

References Cache\PERMANENT.

getCacheTags ( )

{The cache tags associated with this object.When this object is modified, these cache tags will be invalidated.

string[] A set of cache tags.

Implements CacheableDependencyInterface.

query ( )

Add anything to the query that we might need to.

Implements ViewsPluginInterface.

renderExposedForm (   $block = FALSE)

Render the exposed filter form.

This actually does more than that; because it's using FAPI, the form will also assign data to the appropriate handlers for use in building the query.

References Drupal\formBuilder().

Here is the call graph for this function:

Field Documentation

$usesOptions = TRUE


The documentation for this class was generated from the following file: