Same name and namespace in other branches
- 7.x-3.x modules/search/views_handler_field_search_score.inc \views_handler_field_search_score
Field handler to provide simple renderer that allows linking to a node.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field_search_score
Related topics
1 string reference to 'views_handler_field_search_score'
- search_views_data in modules/
search.views.inc - Implementation of hook_views_data()
File
- modules/
search/ views_handler_field_search_score.inc, line 8
View source
class views_handler_field_search_score extends views_handler_field_numeric {
function option_definition() {
$options = parent::option_definition();
$options['alternate_sort'] = array(
'default' => '',
);
$options['alternate_order'] = array(
'default' => 'asc',
);
return $options;
}
function options_form(&$form, &$form_state) {
$style_options = $this->view->display_handler
->get_option('style_options');
if (isset($style_options['default']) && $style_options['default'] == $this->options['id']) {
$handlers = $this->view->display_handler
->get_handlers('field');
$options = array(
'' => t('No alternate'),
);
foreach ($handlers as $id => $handler) {
$options[$id] = $handler
->ui_name();
}
$form['alternate_sort'] = array(
'#type' => 'select',
'#title' => t('Alternative sort'),
'#description' => t('Pick an alternative default table sort field to use when the search score field is unavailable.'),
'#options' => $options,
'#default_value' => $this->options['alternate_sort'],
);
$form['alternate_order'] = array(
'#type' => 'select',
'#title' => t('Alternate sort order'),
'#options' => array(
'asc' => t('Ascending'),
'desc' => t('Descending'),
),
'#default_value' => $this->options['alternate_order'],
);
}
parent::options_form($form, $form_state);
}
function query() {
// Check to see if the search filter added 'score' to the table.
// Our filter stores it as $handler->search_score -- and we also
// need to check its relationship to make sure that we're using the same
// one or obviously this won't work.
foreach ($this->view->filter as $handler) {
if (isset($handler->search_score) && $handler->relationship == $this->relationship) {
$this->field_alias = $handler->search_score;
$this->table_alias = $handler->table_alias;
return;
}
}
// Hide this field if no search filter is in place.
$this->options['exclude'] = TRUE;
if (!empty($this->options['alternate_sort'])) {
if (isset($this->view->style_plugin->options['default']) && $this->view->style_plugin->options['default'] == $this->options['id']) {
// Since the style handler initiates fields, we plug these values right into the active handler.
$this->view->style_plugin->options['default'] = $this->options['alternate_sort'];
$this->view->style_plugin->options['order'] = $this->options['alternate_order'];
}
}
}
function render($values) {
// Only render if we exist.
if (isset($this->table_alias)) {
return parent::render($values);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
property | The type of the handler, for example filter/footer/field. | ||
views_handler:: |
property | Where the $query object will reside: | 6 | |
views_handler:: |
property |
The top object of a view. Overrides views_object:: |
||
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
views_handler:: |
function | Check whether current user has access to this handler. | 8 | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 | |
views_handler:: |
function | Determine if a handler can be exposed. | 2 | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | 8 | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | 2 | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | 1 | |
views_handler:: |
function | Submit the exposed handler form | ||
views_handler:: |
function | Validate the exposed handler form | 4 | |
views_handler:: |
function | Overridable form for exposed handler options. | ||
views_handler:: |
function | 2 | ||
views_handler:: |
function | 2 | ||
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | 2 | |
views_handler:: |
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:: |
function | Validate the options form. | 1 | |
views_handler:: |
function | Provide defaults for the handler. | ||
views_handler:: |
function | Provide a form for setting options. | 1 | |
views_handler:: |
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:: |
function | Validate the options form. | ||
views_handler:: |
function | Shortcut to get a handler's raw field value. | ||
views_handler:: |
function | Get the join object that should be used for this handler. | ||
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | ||
views_handler:: |
function | Determine if the argument needs a style plugin. | 1 | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 4 | |
views_handler:: |
function | Validate the options form. | 4 | |
views_handler:: |
function | Run before the view is built. | 1 | |
views_handler:: |
function | Sanitize the value for output. | ||
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | ||
views_handler:: |
function | Shortcut to display the expose/hide button. | ||
views_handler:: |
function | Shortcut to display the exposed options form. | ||
views_handler:: |
function | If set to remember exposed input in the session, store it there. | 1 | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | 10 | |
views_handler:: |
function | Provides the handler some groupby. | 2 | |
views_handler:: |
function | Validates the handler against the complete View. | 1 | |
views_handler_field:: |
property | Stores additional fields which get's added to the query. The generated aliases are stored in $aliases. | ||
views_handler_field:: |
property | |||
views_handler_field:: |
property | |||
views_handler_field:: |
function | Add 'additional' fields to the query. | ||
views_handler_field:: |
function | Add any special tokens this field might use for itself. | 4 | |
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
||
views_handler_field:: |
function | Render a field using advanced settings. | ||
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | 1 | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | 1 | |
views_handler_field:: |
function | Determine if this field is click sortable. | ||
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
18 | |
views_handler_field:: |
function | Document any special tokens this field might use for itself. | 4 | |
views_handler_field:: |
function | Return the class of the field. | ||
views_handler_field:: |
function | Return the class of the field's label. | ||
views_handler_field:: |
function | Return an HTML element for the label based upon the field's element type. | ||
views_handler_field:: |
function | Return an HTML element based upon the field's element type. | 2 | |
views_handler_field:: |
function | Return the class of the field's wrapper. | ||
views_handler_field:: |
function | Return an HTML element for the wrapper based upon the field's element type. | ||
views_handler_field:: |
function | Provide a list of elements valid for field HTML. | ||
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | ||
views_handler_field:: |
function | Get the value that's supposed to be rendered. | ||
views_handler_field:: |
function |
init the handler with necessary data. Overrides views_handler:: |
11 | |
views_handler_field:: |
function | Get this field's label. | ||
views_handler_field:: |
function | Run before any fields are rendered. | 6 | |
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | ||
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | ||
views_handler_field:: |
function | Perform an advanced text render for the item. | ||
views_handler_field:: |
function | Trim the field down to the specified length. | ||
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | ||
views_handler_field:: |
function | |||
views_handler_field:: |
function | Replace a value with tokens from the last field. | ||
views_handler_field_search_score:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_field_numeric:: |
||
views_handler_field_search_score:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field_numeric:: |
||
views_handler_field_search_score:: |
function |
Called to add the field to a query. Overrides views_handler_field:: |
||
views_handler_field_search_score:: |
function |
Render the field. Overrides views_handler_field_numeric:: |
||
views_object:: |
property | Handler's definition | ||
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
views_object:: |
function | 2 | ||
views_object:: |
function | 1 | ||
views_object:: |
function | |||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | ||
views_object:: |
function | Let the handler know what its full definition is. | ||
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | ||
views_object:: |
function | Unpack a single option definition. | ||
views_object:: |
function | Unpacks each handler to store translatable texts. | ||
views_object:: |
function |