Drupal 8  8.0.2
Search Class Reference
Inheritance diagram for Search:

Public Member Functions

 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 validateExposed (&$form, FormStateInterface $form_state)
 
 query ()
 
- Public Member Functions inherited from FilterPluginBase
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 adminSummary ()
 
 canExpose ()
 
 isAGroup ()
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 showOperatorForm (&$form, FormStateInterface $form_state)
 
 operatorOptions ()
 
 operatorSubmit ($form, FormStateInterface $form_state)
 
 showBuildGroupForm (&$form, FormStateInterface $form_state)
 
 buildGroupForm ($form, FormStateInterface $form_state)
 
 showExposeButton (&$form, FormStateInterface $form_state)
 
 buildExposeForm (&$form, FormStateInterface $form_state)
 
 validateExposeForm ($form, FormStateInterface $form_state)
 
 defaultExposeOptions ()
 
 groupForm (&$form, FormStateInterface $form_state)
 
 buildExposedForm (&$form, FormStateInterface $form_state)
 
 addGroupForm ($form, FormStateInterface $form_state)
 
 exposedInfo ()
 
 convertExposedInput (&$input, $selected_group_id=NULL)
 
 groupMultipleExposedInput (&$input)
 
 multipleExposedInput ()
 
 storeGroupInput ($input, $status)
 
 acceptExposedInput ($input)
 
 storeExposedInput ($input, $status)
 
 query ()
 
 canGroup ()
 
 getCacheMaxAge ()
 
 getCacheContexts ()
 
 getCacheTags ()
 
- Public Member Functions inherited from HandlerBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 adminLabel ($short=FALSE)
 
 getField ($field=NULL)
 
 sanitizeValue ($value, $type=NULL)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 setModuleHandler (ModuleHandlerInterface $module_handler)
 
 usesGroupBy ()
 
 buildGroupByForm (&$form, FormStateInterface $form_state)
 
 submitGroupByForm (&$form, FormStateInterface $form_state)
 
 hasExtraOptions ()
 
 defineExtraOptions (&$option)
 
 buildExtraOptionsForm (&$form, FormStateInterface $form_state)
 
 validateExtraOptionsForm ($form, FormStateInterface $form_state)
 
 submitExtraOptionsForm ($form, FormStateInterface $form_state)
 
 canExpose ()
 
 defaultExposeOptions ()
 
 exposedInfo ()
 
 buildExposedForm (&$form, FormStateInterface $form_state)
 
 validateExposed (&$form, FormStateInterface $form_state)
 
 submitExposed (&$form, FormStateInterface $form_state)
 
 buildExposeForm (&$form, FormStateInterface $form_state)
 
 validateExposeForm ($form, FormStateInterface $form_state)
 
 submitExposeForm ($form, FormStateInterface $form_state)
 
 showExposeButton (&$form, FormStateInterface $form_state)
 
 showExposeForm (&$form, FormStateInterface $form_state)
 
 access (AccountInterface $account)
 
 preQuery ()
 
 query ()
 
 postExecute (&$values)
 
 setRelationship ()
 
 ensureMyTable ()
 
 adminSummary ()
 
 isExposed ()
 
 isAGroup ()
 
 multipleExposedInput ()
 
 acceptExposedInput ($input)
 
 storeExposedInput ($input, $status)
 
 getJoin ()
 
 validate ()
 
 broken ()
 
 getDateFormat ($format)
 
 getDateField ()
 
 setViewsData (ViewsData $views_data)
 
 getEntityType ()
 
 displayExposedForm ($form, FormStateInterface $form_state)
 
 submitTemporaryForm ($form, FormStateInterface $form_state)
 
- 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 ()
 

Protected Member Functions

 defineOptions ()
 
 operatorForm (&$form, FormStateInterface $form_state)
 
 valueForm (&$form, FormStateInterface $form_state)
 
 queryParseSearchExpression ($input)
 
- Protected Member Functions inherited from FilterPluginBase
 defineOptions ()
 
 canBuildGroup ()
 
 operatorForm (&$form, FormStateInterface $form_state)
 
 operatorValidate ($form, FormStateInterface $form_state)
 
 showValueForm (&$form, FormStateInterface $form_state)
 
 valueForm (&$form, FormStateInterface $form_state)
 
 valueValidate ($form, FormStateInterface $form_state)
 
 valueSubmit ($form, FormStateInterface $form_state)
 
 showBuildGroupButton (&$form, FormStateInterface $form_state)
 
 buildGroupValidate ($form, FormStateInterface $form_state)
 
 buildGroupSubmit ($form, FormStateInterface $form_state)
 
 buildGroupOptions ()
 
 buildExposedFiltersGroupForm (&$form, FormStateInterface $form_state)
 
 exposedTranslate (&$form, $type)
 
 prepareFilterSelectOptions (&$options)
 
- Protected Member Functions inherited from HandlerBase
 defineOptions ()
 
 caseTransform ($string, $option)
 
 getModuleHandler ()
 
 placeholder ()
 
 getViewsData ()
 
- 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

 $alwaysMultiple = TRUE
 
 $searchQuery = NULL
 
 $parsed = FALSE
 
 $searchType
 
- Protected Attributes inherited from FilterPluginBase
 $alwaysMultiple = FALSE
 
- Protected Attributes inherited from HandlerBase
 $moduleHandler
 
 $viewsData
 
- Protected Attributes inherited from PluginBase
 $usesOptions = FALSE
 
 $renderer
 

Additional Inherited Members

- Static Public Member Functions inherited from HandlerBase
static getTableJoin ($table, $base_table)
 
static breakString ($str, $force_int=FALSE)
 
- 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 FilterPluginBase
 $value = NULL
 
 $operator= '='
 
 $group_info = NULL
 
 $no_operator = FALSE
 
 $always_required = FALSE
 
- Data Fields inherited from HandlerBase
 $query = NULL
 
 $table
 
 $tableAlias
 
 $actualTable
 
 $realField
 
 $field
 
 $actualField
 
 $relationship = NULL
 
- Data Fields inherited from PluginBase
const INCLUDE_NEGOTIATED = 16
 
const INCLUDE_ENTITY = 32
 
const VIEWS_QUERY_LANGUAGE_SITE_DEFAULT = '***LANGUAGE_site_default***'
 
 $options = array()
 
 $view = NULL
 
 $displayHandler
 
 $definition
 
- Static Protected Member Functions inherited from FilterPluginBase
static arrayFilterZero ($var)
 

Detailed Description

Filter handler for search keywords.

("search_keywords")

Member Function Documentation

defineOptions ( )
protected

{}

init ( ViewExecutable  $view,
DisplayPluginBase  $display,
array &  $options = NULL 
)

{}

operatorForm ( $form,
FormStateInterface  $form_state 
)
protected

{}

References t().

Here is the call graph for this function:

query ( )

{Add anything to the query that we might need to.}

Implements ViewsPluginInterface.

References db_and(), db_or(), HandlerBase\ensureMyTable(), HandlerBase\placeholder(), Views\pluginManager(), and Search\queryParseSearchExpression().

Here is the call graph for this function:

queryParseSearchExpression (   $input)
protected

Sets up and parses the search query.

Parameters
string$inputThe search keywords entered by the user.

References db_select().

Referenced by Search\query(), and Search\validateExposed().

Here is the call graph for this function:

Here is the caller graph for this function:

validateExposed ( $form,
FormStateInterface  $form_state 
)

{}

References Drupal\config(), and Search\queryParseSearchExpression().

Here is the call graph for this function:

valueForm ( $form,
FormStateInterface  $form_state 
)
protected

{}

References t().

Here is the call graph for this function:

Field Documentation

$parsed = FALSE
protected

TRUE if the search query has been parsed.


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