You are here

Home » API reference » Simple hierarchical select 7 » shs_handler_filter_entityreference.inc

class shs_handler_filter_entityreference in Simple hierarchical select 7

Extends simple numeric filter with hierarchical selection.

Hierarchy

Expanded class hierarchy of shs_handler_filter_entityreference

1 string reference to 'shs_handler_filter_entityreference'
shs_field_views_data_alter in ./shs.module
Implements hook_field_views_data_alter().

File

includes/handlers/shs_handler_filter_entityreference.inc, line 13
Definition of shs_handler_filter_numeric.

View source 
class shs_handler_filter_entityreference extends views_handler_filter_numeric {

  /**
   * Define filter options.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['shs_enabled'] = array(
      'default' => FALSE,
    );
    $options['use_chosen'] = array(
      'default' => 'never',
    );
    return $options;
  }

  /**
   * Build the options form.
   *
   * @param array $form
   *   Current form structure.
   * @param array $form_state
   *   Current form state.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['shs_enabled'] = array(
      '#type' => 'checkbox',
      '#title' => t('Output filter as hierarchical select'),
      '#default_value' => $this->options['shs_enabled'],
    );
    if (module_exists('chosen')) {
      $form['use_chosen'] = array(
        '#type' => 'select',
        '#title' => t('Output this field with !chosen', array(
          '!chosen' => l(t('Chosen'), 'http://drupal.org/project/chosen'),
        )),
        '#description' => t('Select in which cases the element will use the !chosen module for the term selection of each level.', array(
          '!chosen' => l(t('Chosen'), 'http://drupal.org/project/chosen'),
        )),
        '#default_value' => empty($this->options['use_chosen']) ? 'never' : $this->options['use_chosen'],
        '#dependency' => array(
          'edit-options-shs-enabled' => array(
            1,
          ),
        ),
        '#options' => array(
          'chosen' => t('let chosen decide'),
          'always' => t('always'),
          'never' => t('never'),
        ),
      );
    }
  }

  /**
   * Provide a simple textfield for equality.
   */
  public function value_form(&$form, &$form_state) {
    global $language;
    parent::value_form($form, $form_state);
    if (empty($form_state['exposed']) || empty($this->options['shs_enabled'])) {
      return;
    }
    $identifier = $this->options['expose']['identifier'];
    $multiple = $this->options['expose']['multiple'];
    $field = field_info_field($this->definition['field_name']);
    $handler = entityreference_get_selection_handler($field);
    $referencable_entities = $handler
      ->getReferencableEntities();
    $vocabulary_names = array();
    if ('views' === $field['settings']['handler']) {
      $view_settings = $field['settings']['handler_settings']['view'];

      // Try to load vocabularies from view filter.
      $vocabulary_names = _shs_entityreference_views_get_vocabularies($view_settings['view_name'], $view_settings['display_name']);
    }
    else {
      $vocabulary_names = empty($field['settings']['handler_settings']['target_bundles']) ? array() : $field['settings']['handler_settings']['target_bundles'];
    }
    $vocabularies = array();
    foreach ($vocabulary_names as $vocabulary_name) {
      if (($vocabulary = taxonomy_vocabulary_machine_name_load($vocabulary_name)) !== FALSE) {
        $vocabularies[] = $vocabulary;
      }
    }
    if (empty($form_state['input'][$identifier])) {
      $form_state['input'][$identifier] = 'All';
    }
    $default_value = check_plain($form_state['input'][$identifier]);
    if (!is_array($default_value) && $multiple) {
      $default_value = explode('+', $default_value);
      foreach ($default_value as $delta => $value) {
        $default_value[$delta] = explode(',', $value);
      }
    }
    $parents = array();
    if (!empty($default_value) && $default_value != 'All') {
      if (is_array($default_value) && $default_value[0] != 'All') {
        foreach ($default_value as $delta => $level) {
          $parents[$delta]['tid'] = $level;
        }
      }
      elseif (is_string($default_value)) {
        $term_parents = taxonomy_get_parents_all($default_value);

        // Remove selected term from list.
        array_shift($term_parents);
        foreach (array_reverse($term_parents) as $term) {
          $parents[] = array(
            'tid' => $term->tid,
          );
        }

        // Add current term (name not needed).
        $parents[] = array(
          'tid' => $default_value,
        );
      }
    }

    // Add fake item for next level.
    $parents[] = array(
      'tid' => 0,
    );
    $element_settings = array(
      'create_new_terms' => FALSE,
      'create_new_levels' => FALSE,
      'required' => FALSE,
      'language' => $language,
    );
    if (module_exists('chosen') && !empty($this->options['use_chosen'])) {
      $element_settings['use_chosen'] = $this->options['use_chosen'];
    }
    if (!empty($this->options['exposed']) && !empty($this->options['expose']['required'])) {
      $element_settings['required'] = TRUE;
    }

    // Allowing other modules to add settings for shs.
    if (!empty($this->options['expose']['shs'])) {
      $element_settings = array_merge($element_settings, $this->options['expose']['shs']);
    }
    $vocabulary_identifier = array(
      'field_name' => $field['field_name'],
    );
    if (count($vocabularies) == 1) {

      // Get ID from first (and only) vocabulary.
      $vocabulary_identifier = $vocabularies[0]->vid;
    }

    // Generate a random hash to avoid merging of settings by drupal_add_js.
    // This is necessary until http://drupal.org/node/208611 lands for D7.
    $js_hash = _shs_create_hash();

    // Create settings needed for our js magic.
    $settings_js = array(
      'shs' => array(
        $identifier => array(
          $js_hash => array(
            'vid' => $vocabulary_identifier,
            'settings' => $element_settings,
            'default_value' => $default_value,
            'parents' => $parents,
            'multiple' => $multiple,
            'any_label' => variable_get('views_exposed_filter_any_label', 'new_any') == 'old_any' ? t('<Any>') : t('- Any -'),
            'any_value' => 'All',
          ),
        ),
      ),
    );

    // Add settings.
    drupal_add_js($settings_js, 'setting');

    // Add behavior.
    drupal_add_js(drupal_get_path('module', 'shs') . '/js/shs.js');
    if (is_array($default_value) && $multiple && $default_value[0] != 'All') {
      foreach ($default_value as $delta => $level) {
        if ($delta == 0) {
          $default_value_str = implode(',', $level);
        }
        else {
          $default_value_str .= '+' . implode(',', $level);
        }
      }
    }
    $options = array();
    foreach ($referencable_entities as $terms) {
      $options += $terms;
    }

    // Change type of value element.
    $form['value']['#type'] = 'select';
    $form['value']['#options'] = $options;
    $form['value']['#size'] = 1;
    $form['value']['#default_value'] = empty($default_value) ? 'All' : $default_value;
    $form['value']['#attributes'] = array(
      'class' => array(
        'element-invisible',
        'shs-enabled',
      ),
    );
    if (!empty($form_state['exposed']) && isset($identifier) && empty($form_state['input'][$identifier]) || $multiple && isset($form_state['input'][$identifier][0])) {
      $form_state['input'][$identifier] = empty($default_value_str) ? 'All' : $default_value_str;
    }
  }

  /**
   * Function to build the admin summary.
   *
   * @return string
   *   Short summary explaining the settings.
   */
  public function admin_summary() {
    $summary = parent::admin_summary();

    // @todo: add "shs".
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
shs_handler_filter_entityreference::admin_summary public function Function to build the admin summary. Overrides views_handler_filter_numeric::admin_summary
shs_handler_filter_entityreference::options_form public function Build the options form. Overrides views_handler_filter::options_form
shs_handler_filter_entityreference::option_definition public function Define filter options. Overrides views_handler_filter_numeric::option_definition
shs_handler_filter_entityreference::value_form public 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_form public function Provide a form for setting options. 1
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::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 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_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::operators public function
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_handler_filter_numeric::query public function Add this filter to the query. Overrides views_handler_filter::query 2
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