class SearchApiViewsHandlerArgumentMoreLikeThis in Search API 7
Views argument handler providing a list of related items for search servers supporting the "search_api_mlt" feature.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of SearchApiViewsHandlerArgumentMoreLikeThis
1 string reference to 'SearchApiViewsHandlerArgumentMoreLikeThis'
- 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_argument_more_like_this.inc, line 12 - Contains SearchApiViewsHandlerArgumentMoreLikeThis.
View source
class SearchApiViewsHandlerArgumentMoreLikeThis extends SearchApiViewsHandlerArgument {
/**
* Specify the options this filter uses.
*/
public function option_definition() {
$options = parent::option_definition();
$options['entity_type'] = array(
'default' => FALSE,
);
$options['fields'] = array(
'default' => array(),
);
return $options;
}
/**
* Extend the options form a bit.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
unset($form['break_phrase']);
unset($form['not']);
$index = search_api_index_load(substr($this->table, 17));
if ($index
->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
$types = array_intersect_key(search_api_entity_type_options_list(), array_flip($index->options['datasource']['types']));
$form['entity_type'] = array(
'#type' => 'select',
'#title' => t('Entity type'),
'#description' => t('Select the entity type of the argument.'),
'#options' => $types,
'#default_value' => $this->options['entity_type'],
'#required' => TRUE,
);
}
if (!empty($index->options['fields'])) {
$fields = array();
foreach ($index
->getFields() as $key => $field) {
$fields[$key] = $field['name'];
}
}
if (!empty($fields)) {
$form['fields'] = array(
'#type' => 'select',
'#title' => t('Fields for Similarity'),
'#description' => t('Select the fields that will be used for finding similar content. If no fields are selected, all available fields will be used.'),
'#options' => $fields,
'#size' => min(8, count($fields)),
'#multiple' => TRUE,
'#default_value' => $this->options['fields'],
);
}
else {
$form['fields'] = array(
'#type' => 'value',
'#value' => array(),
);
}
}
/**
* Set up the query for this argument.
*
* The argument sent may be found at $this->argument.
*/
public function query($group_by = FALSE) {
try {
$server = $this->query
->getIndex()
->server();
if (!$server
->supportsFeature('search_api_mlt')) {
$class = search_api_get_service_info($server->class);
watchdog('search_api_views', 'The search service "@class" does not offer "More like this" functionality.', array(
'@class' => $class['name'],
), WATCHDOG_ERROR);
$this->query
->abort();
return;
}
$index_fields = array_keys($this->query
->getIndex()->options['fields']);
if (empty($this->options['fields'])) {
$fields = $index_fields;
}
else {
$fields = array_intersect($this->options['fields'], $index_fields);
}
if ($this->query
->getIndex()
->datasource() instanceof SearchApiCombinedEntityDataSourceController) {
$id = $this->options['entity_type'] . '/' . $this->argument;
}
else {
$id = $this->argument;
}
$mlt = array(
'id' => $id,
'fields' => $fields,
);
$this->query
->getSearchApiQuery()
->setOption('search_api_mlt', $mlt);
} catch (SearchApiException $e) {
$this->query
->abort($e
->getMessage());
}
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SearchApiViewsHandlerArgument:: |
public | property | The operator to use for multiple arguments. | |
SearchApiViewsHandlerArgument:: |
public | property |
The associated views query object. Overrides views_handler:: |
5 |
SearchApiViewsHandlerArgument:: |
public | function |
Provide a list of default behaviors for this argument if the argument
is not present. Overrides views_handler_argument:: |
|
SearchApiViewsHandlerArgument:: |
public | function |
Determine if the argument can generate a breadcrumb. Overrides views_handler_argument:: |
|
SearchApiViewsHandlerArgumentMoreLikeThis:: |
public | function |
Extend the options form a bit. Overrides SearchApiViewsHandlerArgument:: |
|
SearchApiViewsHandlerArgumentMoreLikeThis:: |
public | function |
Specify the options this filter uses. Overrides SearchApiViewsHandlerArgument:: |
|
SearchApiViewsHandlerArgumentMoreLikeThis:: |
public | function |
Set up the query for this argument. Overrides SearchApiViewsHandlerArgument:: |
|
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 | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
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 | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
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 | Validate the options form. | 1 |
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 | Returns TRUE if the exposed filter works like a grouped filter. | 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 | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 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 expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
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_argument:: |
public | property | ||
views_handler_argument:: |
public | property | The field to use for the name to use in the summary. | |
views_handler_argument:: |
public | property | The table to use for the name, if not the same table as the argument. | |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | 1 | |
views_handler_argument:: |
public | function |
Views handlers use a special construct function. Overrides views_object:: |
5 |
views_handler_argument:: |
public | function | Default action: access denied. | |
views_handler_argument:: |
public | function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
public | function | Provide a form for selecting the default argument. | 1 |
views_handler_argument:: |
public | function | This just returns true. | |
views_handler_argument:: |
public | function | Default action: empty. | |
views_handler_argument:: |
public | function | Default action: ignore. | |
views_handler_argument:: |
public | function | Default action: not found. | |
views_handler_argument:: |
public | function | Default action: summary. | |
views_handler_argument:: |
public | function | Form for selecting further summary options. | |
views_handler_argument:: |
public | function | Work out which title to use. | |
views_handler_argument:: |
public | function | Generic plugin export handler. | 1 |
views_handler_argument:: |
public | function | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
views_handler_argument:: |
public | function | Get a default argument, if available. | 1 |
views_handler_argument:: |
public | function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
public | function | Return a description of how the argument would normally be sorted. | 5 |
views_handler_argument:: |
public | function | Called by the view object to get the title. | |
views_handler_argument:: |
public | function | Get the value of this argument. | |
views_handler_argument:: |
public | function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
3 |
views_handler_argument:: |
public | function | ||
views_handler_argument:: |
public | function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
public | function | Process the summary arguments for display. | |
views_handler_argument:: |
public | function | Set the input for this argument. | |
views_handler_argument:: |
public | function | Give an argument the opportunity to modify the breadcrumb, if it wants. | 3 |
views_handler_argument:: |
public | function | Provide the argument to use to link from the summary to the next level. | 4 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Provides the name to use for the summary. | 10 |
views_handler_argument:: |
public | function | Add the name field, which is the field displayed in summary queries. | |
views_handler_argument:: |
public | function | Build the info for the summary query. | 3 |
views_handler_argument:: |
public | function | Sorts the summary based upon the user's selection. | |
views_handler_argument:: |
public | function | Get the title this argument will assign the view, given the argument. | 13 |
views_handler_argument:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
public | function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
public | function | Provide a basic argument validation. | 1 |
views_handler_argument:: |
public | function | How to act if validation fails. | |
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 | 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 |