class SearchApiViewsHandlerFilterLanguage in Search API 7
Views filter handler class for handling the special "Item language" field.
Definition items:
- options: An array of possible values for this field.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of SearchApiViewsHandlerFilterLanguage
1 string reference to 'SearchApiViewsHandlerFilterLanguage'
- search_api_views_views_data in contrib/
search_api_views/ search_api_views.views.inc - Implements hook_views_data().
File
- contrib/
search_api_views/ includes/ handler_filter_language.inc, line 14 - Contains the SearchApiViewsHandlerFilterLanguage class.
View source
class SearchApiViewsHandlerFilterLanguage extends SearchApiViewsHandlerFilterOptions {
/**
* {@inheritdoc}
*/
protected function get_value_options() {
parent::get_value_options();
$options = array();
if (module_exists('language_hierarchy')) {
$options['fallback'] = t("Current user's language with fallback");
}
$options['current'] = t("Current user's language");
$options['default'] = t('Default site language');
$this->value_options = $options + $this->value_options;
}
/**
* Add this filter to the query.
*/
public function query() {
global $language_content;
if (!is_array($this->value)) {
$this->value = $this->value ? array(
$this->value,
) : array();
}
foreach ($this->value as $i => $v) {
if ($v == 'current') {
$this->value[$i] = $language_content->language;
}
elseif ($v == 'default') {
$this->value[$i] = language_default('language');
}
elseif ($v == 'fallback' && module_exists('language_hierarchy')) {
$fallbacks = array(
$language_content->language => $language_content->language,
);
$fallbacks += array_keys(language_hierarchy_get_ancestors($language_content->language));
$this->value[$i] = drupal_map_assoc($fallbacks);
}
}
parent::query();
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SearchApiViewsHandlerFilter:: |
public | property |
The operator used for filtering. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilter:: |
public | property |
The associated views query object. Overrides views_handler:: |
4 |
SearchApiViewsHandlerFilter:: |
public | property |
The value to filter for. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilterLanguage:: |
protected | function |
Fills the value_options property with all possible options. Overrides SearchApiViewsHandlerFilterOptions:: |
|
SearchApiViewsHandlerFilterLanguage:: |
public | function |
Add this filter to the query. Overrides SearchApiViewsHandlerFilterOptions:: |
|
SearchApiViewsHandlerFilterOptions:: |
protected | property | The type of form element used to display the options. | |
SearchApiViewsHandlerFilterOptions:: |
protected | property | Stores the values which are available on the form. | |
SearchApiViewsHandlerFilterOptions:: |
function |
Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter:: |
||
SearchApiViewsHandlerFilterOptions:: |
public | function |
Provides a summary of this filter's value for the admin UI. Overrides SearchApiViewsHandlerFilter:: |
|
SearchApiViewsHandlerFilterOptions:: |
public | function |
Add the "reduce" option to the exposed form. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilterOptions:: |
public | function |
Set "reduce" option to FALSE by default. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilterOptions:: |
protected | function | Retrieves a wrapper for this filter's field. | |
SearchApiViewsHandlerFilterOptions:: |
public | function |
Provide a list of options for the operator form. Overrides SearchApiViewsHandlerFilter:: |
|
SearchApiViewsHandlerFilterOptions:: |
public | function |
Define "reduce" option. Overrides views_handler_filter:: |
|
SearchApiViewsHandlerFilterOptions:: |
protected | function | Reduce the options according to the selection. | |
SearchApiViewsHandlerFilterOptions:: |
public | function |
Provide a form for setting options. Overrides SearchApiViewsHandlerFilter:: |
|
SearchApiViewsHandlerFilterOptions:: |
public | function |
Save set checkboxes. Overrides views_handler_filter:: |
|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
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. | |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_filter:: |
public | property | Disable the possibility to force a single value. | 6 |
views_handler_filter:: |
public | property | Disable the possibility to allow a exposed input to be optional. | |
views_handler_filter:: |
public | property | Contains the information of the selected item in a gruped filter. | |
views_handler_filter:: |
public | property | Disable the possibility to use operators. | 2 |
views_handler_filter:: |
public | function | Build the form to let users create the group of exposed filters. | |
views_handler_filter:: |
public | function | Provide default options for exposed filters. | |
views_handler_filter:: |
public | function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
public | function | Validate the build group options form. | 1 |
views_handler_filter:: |
public | function | Determine if a filter can be converted into a group. | |
views_handler_filter:: |
public | function |
Determine if a filter can be exposed. Overrides views_handler:: |
5 |
views_handler_filter:: |
public | function | Can this filter be used in OR groups? | 1 |
views_handler_filter:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
views_handler_filter:: |
public | function |
Render our chunk of the exposed filter form when selecting. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Tell the renderer about our exposed form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Build a form with a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
public | function | Options available for a grouped filter which uses checkboxes. | |
views_handler_filter:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Indicate whether users can select multiple group items. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Options form subform for setting the operator. | 6 |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
views_handler_filter:: |
public | function | Validate the operator form. | |
views_handler_filter:: |
public | function |
Provide the basic form which calls through to subforms. Overrides views_handler:: |
4 |
views_handler_filter:: |
public | function |
Simple submit handler. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Simple validate handler. Overrides views_handler:: |
1 |
views_handler_filter:: |
public | function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
public | function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
public | function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
public | function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Shortcut to display the operator form. | |
views_handler_filter:: |
public | function | Shortcut to display the value form. | |
views_handler_filter:: |
public | function |
Store the exposed input for processing later. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | If set to remember exposed input in the session, store it there. | |
views_handler_filter:: |
public | function | Validate the options form. | 3 |
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |