class SearchAutocompleteViewsPluginStyle in Search Autocomplete 7.4
Implements views_plugin_style
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of SearchAutocompleteViewsPluginStyle
1 string reference to 'SearchAutocompleteViewsPluginStyle'
- search_autocomplete_views_plugins in views/
search_autocomplete.views.inc - Implements hook_views_plugins().
File
- views/
plugins/ search_autocomplete.views_plugin_style.inc, line 10 - Implements views_plugin_style for search_autocomplete
View source
class SearchAutocompleteViewsPluginStyle extends views_plugin_style {
/**
* {@inheritdoc}
*/
function option_definition() {
$options = parent::option_definition();
$options['group_by'] = array(
'default' => FALSE,
);
$options['input_label'] = array(
'default' => FALSE,
);
$options['input_link'] = array(
'default' => FALSE,
);
$options['output_fields'] = array(
'default' => FALSE,
);
return $options;
}
/**
* Provide a form for setting options.
*/
function options_form(&$form, &$form_state) {
// Get all views fields.
$all_view_fields = $this->display->handler
->get_field_labels();
// Build the value option.
$group_fields = $all_view_fields;
array_unshift($group_fields, "- no grouping -");
$group_by_descr = (empty($all_view_fields) ? '<b>' . t('Warning') . ': </b> ' . t('Requires at least one field in the view.') . '<br/>' : '') . t("You may want to group fields together.");
$form['group_by'] = array(
'#title' => t('Group fields by'),
'#type' => 'select',
'#description' => check_plain($group_by_descr),
'#default_value' => $this->options['group_by'],
'#disabled' => empty($all_view_fields),
'#required' => TRUE,
'#options' => $group_fields,
);
$input_label_descr = (empty($all_view_fields) ? '<b>' . t('Warning') . ': </b> ' . t('Requires at least one field in the view.') . '<br/>' : '') . t('Select the autocompletion input value. If the autocompletion settings are set to auto-submit, this value will be submitted as the suggestion is selected.');
$form['input_label'] = array(
'#title' => t('Input Label'),
'#type' => 'select',
'#description' => check_plain($input_label_descr),
'#default_value' => $this->options['input_label'],
'#disabled' => empty($all_view_fields),
'#required' => TRUE,
'#options' => $all_view_fields,
);
// Build the link option.
$input_link_descr = (empty($all_view_fields) ? '<b>' . t('Warning') . ': </b> ' . t('Requires at least one field in the view.') . '<br/>' : '') . t('Select the autocompletion input link. If the autocompletion settings are set to auto-redirect, this link is where the user will be redirected as the suggestion is selected.');
$form['input_link'] = array(
'#title' => t('Input Link'),
'#type' => 'select',
'#description' => check_plain($input_link_descr),
'#default_value' => $this->options['input_link'],
'#disabled' => empty($all_view_fields),
'#required' => TRUE,
'#options' => $all_view_fields,
);
// Build the link option.
$output_field_descr = (empty($all_view_fields) ? '<b>' . t('Warning') . ': </b> ' . t('Requires at least one field in the view.') . '<br/>' : '') . t("Select the autocompletion output values. Thoses fields are the one that will show in the autocompletion popup suggestion list. This may be, the username and picture for instance, or the node title and it's author.");
$form['output_fields'] = array(
'#title' => t('Output Fields'),
'#type' => 'select',
'#description' => check_plain($output_field_descr),
'#default_value' => $this->options['output_fields'],
'#disabled' => empty($all_view_fields),
'#required' => TRUE,
'#multiple' => TRUE,
'#options' => $all_view_fields,
);
}
/**
* {@inheritdoc}
*/
function render() {
$view = $this->view;
$options = $this->options;
$rows = array();
foreach ($view->result as $count => $row) {
$view->row_index = $count;
$rows[] = _search_autocomplete_render_fields($view, $row);
}
unset($view->row_index);
return theme($this
->theme_functions(), array(
'view' => $view,
'options' => $options,
'rows' => $rows,
));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SearchAutocompleteViewsPluginStyle:: |
function |
Provide a form for setting options. Overrides views_plugin_style:: |
||
SearchAutocompleteViewsPluginStyle:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_plugin_style:: |
||
SearchAutocompleteViewsPluginStyle:: |
function |
Render the display in this style. Overrides views_plugin_style:: |
||
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 | 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 | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Handle any special handling on the validate form. | 9 |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
public | property | The row plugin, if it's initialized and the style itself supports it. | |
views_plugin_style:: |
public | property | Store all available tokens row rows. | |
views_plugin_style:: |
public | function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 |
views_plugin_style:: |
public | function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 |
views_plugin_style:: |
public | function |
Destructor. Overrides views_object:: |
|
views_plugin_style:: |
public | function | Should the output of the style plugin be rendered even if it's empty. | 1 |
views_plugin_style:: |
public | function | Get a rendered field. | |
views_plugin_style:: |
public | function | Get the raw field value. | |
views_plugin_style:: |
public | function | Return the token replaced row class for the specified row. | |
views_plugin_style:: |
public | function | Initialize a style plugin. | |
views_plugin_style:: |
public | function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_style:: |
public | function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
public | function |
Add anything to the query that we might need to. Overrides views_plugin:: |
2 |
views_plugin_style:: |
public | function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
public | function | Group records as needed for rendering. | |
views_plugin_style:: |
public | function | Render the grouping sets. | |
views_plugin_style:: |
public | function | Take a value and apply token replacement logic to it. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style uses tokens. | |
views_plugin_style:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |