You are here

class synonyms_views_handler_filter_entityreference_synonyms in Synonyms 7

Definition of synonyms friendly entity reference field filter.

Hierarchy

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

Namesort descending Modifiers Type Description Overrides
synonyms_views_handler_filter_entityreference_synonyms::admin_summary function Display the filter on the administrative summary. Overrides views_handler_filter_numeric::admin_summary
synonyms_views_handler_filter_entityreference_synonyms::extra_options_form function Provide a form for setting options. Overrides views_handler::extra_options_form
synonyms_views_handler_filter_entityreference_synonyms::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. Overrides views_handler::has_extra_options
synonyms_views_handler_filter_entityreference_synonyms::operators function Overrides views_handler_filter_numeric::operators
synonyms_views_handler_filter_entityreference_synonyms::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_numeric::option_definition
synonyms_views_handler_filter_entityreference_synonyms::query function Add this filter to the query. Overrides views_handler_filter_numeric::query
synonyms_views_handler_filter_entityreference_synonyms::value_form function Provide a simple textfield for equality Overrides views_handler_filter_numeric::value_form
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_submit 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::extra_options public function Provide defaults for the handler.
views_handler::extra_options_submit 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::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit 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::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
views_handler_filter_numeric::$always_multiple public property Exposed filter options. Overrides views_handler_filter::$always_multiple
views_handler_filter_numeric::accept_exposed_input public function Do some minor translation of the exposed input. Overrides views_handler_filter::accept_exposed_input 1
views_handler_filter_numeric::operator_options public function Provide a list of all the numeric operators Overrides views_handler_filter::operator_options
views_handler_filter_numeric::operator_values public function
views_handler_filter_numeric::op_between public function 3
views_handler_filter_numeric::op_empty public function 2
views_handler_filter_numeric::op_not_regex public function
views_handler_filter_numeric::op_regex public function 1
views_handler_filter_numeric::op_simple public function 3
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function