class synonyms_views_handler_filter_entityreference_synonyms in Synonyms 7
Definition of synonyms friendly entity reference field filter.
Hierarchy
- class \views_object
Expanded class hierarchy of synonyms_views_handler_filter_entityreference_synonyms
1 string reference to 'synonyms_views_handler_filter_entityreference_synonyms'
- synonyms_field_views_data_alter in views/
synonyms.views.inc - Implements hook_field_views_data_alter().
File
- views/
synonyms_views_handler_filter_entityreference_synonyms.inc, line 11 - Definition of synonyms_views_handler_filter_entityreference_synonyms class.
View source
class synonyms_views_handler_filter_entityreference_synonyms extends views_handler_filter_numeric {
function option_definition() {
$options = parent::option_definition();
$options['type'] = array(
'default' => 'numeric',
);
return $options;
}
function extra_options_form(&$form, &$form_state) {
parent::extra_options_form($form, $form_state);
$form['type'] = array(
'#type' => 'radios',
'#title' => t('Type'),
'#options' => array(
'numeric' => t('Numeric'),
'synonyms_autocomplete' => t('Synonyms friendly autocomplete'),
'synonyms_select' => t('Synonyms friendly select list'),
),
'#default_value' => $this->options['type'],
);
}
function has_extra_options() {
return TRUE;
}
function operators() {
$operators = parent::operators();
switch ($this->options['type']) {
case 'synonyms_autocomplete':
case 'synonyms_select':
// Only "equals" and "not equals" make sense, other operators are rather
// funky when it comes to IDs and not simple integers.
$operators = array_intersect_key($operators, drupal_map_assoc(array(
'=',
'!=',
)));
break;
}
return $operators;
}
function value_form(&$form, &$form_state) {
parent::value_form($form, $form_state);
if (isset($form['value']['#type'])) {
$element =& $form['value'];
}
elseif (isset($form['value']['value']['#type'])) {
$element =& $form['value']['value'];
}
if (isset($element)) {
$field = field_info_field($this->definition['field_name']);
$entity_type = array_keys($field['bundles']);
$entity_type = reset($entity_type);
$bundle = reset($field['bundles'][$entity_type]);
$instance = field_info_instance($entity_type, $field['field_name'], $bundle);
switch ($this->options['type']) {
case 'synonyms_autocomplete':
$widget = field_info_widget_settings('synonyms_autocomplete_entity');
$element['#autocomplete_path'] = $widget['synonyms_autocomplete_path'] . '/' . $field['field_name'] . '/' . $instance['entity_type'] . '/' . $instance['bundle'];
$element['#attached']['js'][drupal_get_path('module', 'synonyms') . '/js/synonyms-autocomplete.js'] = array();
$element['#attributes']['class'][] = 'synonyms-autocomplete';
break;
case 'synonyms_select':
$element['#type'] = 'select';
$element['#options'] = synonyms_select_entity_options($field, $instance);
if (!$this
->is_exposed()) {
$element['#empty_option'] = t('- None -');
}
$element['#element_validate'][] = 'synonyms_select_validate';
$element['#element_validate'][] = 'synonyms_select_views_entityreference_filter_validate';
unset($element['#size']);
break;
}
}
}
function query() {
switch ($this->options['type']) {
case 'synonyms_autocomplete':
$field = field_info_field($this->definition['field_name']);
$this->value['value'] = synonyms_get_entity_by_synonym($field['settings']['target_type'], $this->value['value'], synonyms_field_target_bundles($field));
break;
}
parent::query();
}
function admin_summary() {
if ($this
->is_a_group()) {
return t('grouped');
}
if (!empty($this->options['exposed'])) {
return t('exposed');
}
switch ($this->options['type']) {
case 'numeric':
case 'synonyms_autocomplete':
return parent::admin_summary();
break;
case 'synonyms_select':
$field = field_info_field($this->definition['field_name']);
$entity = entity_load($field['settings']['target_type'], array(
$this->value['value'],
));
$entity = reset($entity);
if (is_object($entity)) {
$label = entity_label($field['settings']['target_type'], $entity);
$options = $this
->operator_options('short');
return check_plain($options[$this->operator]) . ' ' . check_plain($label);
}
break;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Display the filter on the administrative summary. Overrides views_handler_filter_numeric:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Provide a form for setting options. Overrides views_handler:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides views_handler:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Overrides views_handler_filter_numeric:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_numeric:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Add this filter to the query. Overrides views_handler_filter_numeric:: |
||
synonyms_views_handler_filter_entityreference_synonyms:: |
function |
Provide a simple textfield for equality Overrides views_handler_filter_numeric:: |
||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
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 | 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 | 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 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 | property | Contains the operator which is used on the query. | |
views_handler_filter:: |
public | property | Contains the actual value of the field. | |
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 |
Options form subform for exposed filter options. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Provide default options for exposed filters. Overrides views_handler:: |
2 |
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 | Perform any necessary changes to the form values prior to storage. | 1 |
views_handler_filter:: |
public | function | Validate the options form. | 3 |
views_handler_filter_numeric:: |
public | property |
Exposed filter options. Overrides views_handler_filter:: |
|
views_handler_filter_numeric:: |
public | function |
Do some minor translation of the exposed input. Overrides views_handler_filter:: |
1 |
views_handler_filter_numeric:: |
public | function |
Provide a list of all the numeric operators Overrides views_handler_filter:: |
|
views_handler_filter_numeric:: |
public | function | ||
views_handler_filter_numeric:: |
public | function | 3 | |
views_handler_filter_numeric:: |
public | function | 2 | |
views_handler_filter_numeric:: |
public | function | ||
views_handler_filter_numeric:: |
public | function | 1 | |
views_handler_filter_numeric:: |
public | function | 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 |