class similar_handler_argument_nid in Similar Entries 7.2

Same name and namespace in other branches

6.2 views/similar_handler_argument_nid.inc \similar_handler_argument_nid

Defines the similar entries View node ID argument.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_argument
    class \views_handler_argument_numeric
    class \similar_handler_argument_nid

Expanded class hierarchy of similar_handler_argument_nid

1 string reference to 'similar_handler_argument_nid'

similar_views_data in views/similar.views.inc: Implements hook_views_data().

File

views/similar_handler_argument_nid.inc, line 11: Defines the Similar entries node ID argument.

View source

class similar_handler_argument_nid extends views_handler_argument_numeric {

  /**
   * Defines default values for argument settings.
   */
  public function option_definition() {
    $common_words = array(
      '-not',
      '-and',
      '-a',
      '-or',
      '-the',
      '-but',
      '-therefore',
      '-because',
      '-can\'t',
      '-can',
      '-for',
      '-until',
      '-the',
      '-of',
      '-and',
      '-to',
      '-in',
      '-is',
      '-you',
      '-that',
      '-it',
      '-he',
      '-was',
      '-on',
      '-are',
      '-as',
      '-with',
      '-his',
      '-they',
      '-I',
      '-at',
      '-be',
      '-this',
      '-have',
      '-from',
      '-one',
      '-had',
      '-by',
      '-word',
      '-but',
      '-not',
      '-what',
      '-all',
      '-were',
      '-we',
      '-when',
      '-your',
      '-said',
      '-there',
      '-use',
      '-an',
      '-each',
      '-which',
      '-she',
      '-do',
      '-how',
      '-their',
      '-if',
      '-will',
      '-up',
      '-other',
      '-about',
      '-out',
      '-many',
      '-then',
      '-them',
      '-these',
      '-so',
      '-some',
      '-her',
      '-would',
      '-make',
      '-like',
      '-him',
      '-into',
      '-time',
      '-has',
      '-look',
      '-two',
      '-more',
      '-write',
      '-go',
      '-see',
      '-no',
      '-way',
      '-could',
      '-people',
      '-my',
      '-than',
      '-first',
      '-water',
      '-been',
      '-call',
      '-who',
      '-oil',
      '-its',
      '-now',
      '-find',
    );
    $options = parent::option_definition();
    $options['default_action'] = array(
      'default' => 'default',
    );
    $options['default_argument_type'] = array(
      'default' => 'node',
    );
    $options['validate']['contains']['type'] = array(
      'default' => 'node',
    );
    $options['boolean_mode'] = array(
      'default' => 0,
    );
    $options['rendered_content'] = array(
      'default' => 0,
    );
    $options['rendered_view_mode'] = array(
      'default' => 'full',
    );
    $options['adjust_relevance'] = array(
      'default' => 1,
    );
    $options['title_relevance'] = array(
      'default' => 1.4,
    );
    $options['body_relevance'] = array(
      'default' => 0.8,
    );
    $options['source_relevance'] = array(
      'default' => 1,
    );
    $options['title_operator'] = array(
      'default' => 'increase',
    );
    $options['enable_custom_operators'] = array(
      'default' => 0,
    );
    $options['custom_operators'] = array(
      'default' => implode(' | ', $common_words),
    );

    // Notify Views of individual field weights.
    // Note: the Views cache may need to be reset when fields are added.
    if (module_exists('field')) {
      $options['include_fields'] = array(
        'default' => 0,
      );
      foreach (similar_get_indices() as $field => $info) {
        $options['included_fields:' . $field] = array(
          'default' => 1,
        );
      }
    }
    return $options;
  }

  /**
   * Defines the options form.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    unset($form['not']);
    $form['default_argument_type']['#disabled'] = TRUE;
    $form['similar'] = array(
      '#type' => 'fieldset',
      '#title' => t('FULLTEXT search options'),
    );

    // Add fields for increasing or decreasing relevance of destination ndoe fields.
    $relevance_options = array(
      '0' => '0%',
      '0.1' => '10%',
      '0.2' => '20%',
      '0.3' => '30%',
      '0.4' => '40%',
      '0.5' => '50%',
      '0.6' => '60%',
      '0.7' => '70%',
      '0.8' => '80%',
      '0.9' => '90%',
      '1.0' => '100%',
      '1.1' => '110%',
      '1.2' => '120%',
      '1.3' => '130%',
      '1.4' => '140%',
      '1.5' => '150%',
      '1.6' => '160%',
      '1.7' => '170%',
      '1.8' => '180%',
      '1.9' => '190%',
      '2.0' => '200%',
    );
    foreach (entity_get_info('node')['view modes'] as $key => $values) {
      $render_view_mode_options[$key] = $values['label'];
    }
    $form['adjust_relevance'] = array(
      '#type' => 'checkbox',
      '#title' => t('Adjust relevance of fields'),
      '#default_value' => $this->options['adjust_relevance'],
      '#description' => t('Adjust the relevance of content titles, bodies, and other fields in matching.'),
      '#fieldset' => 'similar',
    );
    $form['title_relevance'] = array(
      '#type' => 'select',
      '#title' => t('Relevance of content\'s title.'),
      '#options' => $relevance_options,
      '#default_value' => $this->options['title_relevance'],
      '#description' => t('Increase or decrease the relevance of matches in destination content\'s title field.'),
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-adjust-relevance' => array(
          '1',
        ),
      ),
    );
    $form['body_relevance'] = array(
      '#type' => 'select',
      '#title' => t('Relevance of content\'s body.'),
      '#options' => $relevance_options,
      '#default_value' => $this->options['body_relevance'],
      '#description' => t('Increase or decrease the relevance of matches in ' . 'destination content\'s body and other fields.'),
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-adjust-relevance' => array(
          '1',
        ),
      ),
    );
    $form['rendered_content'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use rendered source content instead of body'),
      '#default_value' => $this->options['rendered_content'],
      '#description' => t('Score similarity by comparing to source content rendered in a view mode, rather than body value.'),
      '#fieldset' => 'similar',
    );
    $form['rendered_view_mode'] = array(
      '#type' => 'select',
      '#title' => t('View mode to render content'),
      '#options' => $render_view_mode_options,
      '#default_value' => $this->options['rendered_view_mode'],
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-rendered-content' => array(
          '1',
        ),
      ),
    );

    // Add fields for enabling matching in fields defined by field module.
    if (module_exists('field')) {

      // Checkbox to enable fields in query.
      $form['include_fields'] = array(
        '#type' => 'checkbox',
        '#title' => t('Include content fields in matching'),
        '#default_value' => !empty($this->options['include_fields']),
        '#description' => t('Enable FULLTEXT queries on fields defined with Field module.'),
        '#fieldset' => 'similar',
      );

      // Add a weight select list for each field defined by Field module.
      foreach (similar_get_indices() as $field => $info) {
        $form['included_fields:' . $field] = array(
          '#type' => 'select',
          '#title' => isset($info['label']) ? $info['label'] : $field,
          '#options' => $relevance_options,
          '#default_value' => isset($this->options['included_fields:' . $field]) ? $this->options['included_fields:' . $field] : 1,
          '#fieldset' => 'similar',
          '#dependency' => array(
            'edit-options-include-fields' => array(
              '1',
            ),
            'edit-options-adjust-relevance' => array(
              '1',
            ),
          ),
          '#dependency_count' => 2,
        );
      }
    }
    $form['boolean_mode'] = array(
      '#type' => 'checkbox',
      '#title' => t('Execute search in boolean mode'),
      '#default_value' => !empty($this->options['boolean_mode']),
      '#fieldset' => 'similar',
      '#description' => t('Boolean mode enables the ability to increase or decrease the relevance of certain fields.<br />' . 'Note: Boolean mode may negatively affect the accuracy of view results.'),
    );

    // Add options for increasing or decreasing relevance of source node.
    $form['source_relevance'] = array(
      '#type' => 'checkbox',
      '#title' => t('Adjust source relevance'),
      '#default_value' => !empty($this->options['source_relevance']),
      '#description' => t('Increase the relevance of words in the title of the content being viewed.'),
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-boolean-mode' => array(
          '1',
        ),
      ),
    );
    $form['title_operator'] = array(
      '#type' => 'select',
      '#title' => t('Relevance of source content\'s title'),
      '#options' => array(
        'none' => t('No change'),
        'increase' => t('Increase title relevance'),
        'decrease' => t('Decrease title relevance'),
        'require_all' => t('Require all terms'),
        'require_some' => t('Require at least one term'),
        'require_complete' => t('Require complete title'),
        'exclude_all' => t('Exclude all terms'),
        'exclude_some' => t('Exclude at least one term'),
        'exclude_complete' => t('Exclude complete title'),
      ),
      '#default_value' => $this->options['title_operator'],
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-boolean-mode' => array(
          '1',
        ),
        'edit-options-source-relevance' => array(
          '1',
        ),
      ),
      '#dependency_count' => 2,
    );

    // Add fields for creating custom relevance rules for specific words or phrases.
    $form['enable_custom_operators'] = array(
      '#type' => 'checkbox',
      '#title' => t('Set custom operators in words and phrases'),
      '#default_value' => !empty($this->options['enable_custom_operators']),
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-boolean-mode' => array(
          '1',
        ),
      ),
    );
    $form['custom_operators'] = array(
      '#type' => 'textfield',
      '#title' => t('Operators'),
      '#default_value' => $this->options['custom_operators'],
      '#description' => t('Use boolean logical operators to customize the FULLTEXT query. Each expression should ' . 'be separated by a vertical bar |.<br />' . 'Available operators:  +  -  >  <  (  )  ~  "<br />' . 'See http://dev.mysql.com/doc/refman/5.5/en/fulltext-boolean.html for more information.'),
      '#maxlength' => 1024,
      '#fieldset' => 'similar',
      '#dependency' => array(
        'edit-options-boolean-mode' => array(
          '1',
        ),
        'edit-options-enable-custom-operators' => array(
          '1',
        ),
      ),
      '#dependency_count' => 2,
    );
  }

  /**
   * Overrides argument's default actions list to ensure that node ID
   * from URL is provided.
   */
  public function default_actions($which = NULL) {
    $defaults = parent::default_actions();
    unset($defaults['ignore'], $defaults['not found'], $defaults['summary'], $defaults['empty']);
    if ($which) {
      if (!empty($defaults[$which])) {
        return $defaults[$which];
      }
    }
    else {
      return $defaults;
    }
  }

  /**
   * Validates that the argument works.
   */
  public function validate_arg($arg) {
    if (!parent::validate_arg($arg)) {
      return FALSE;
    }
    if (!empty($this->options['break_phrase'])) {
      views_break_phrase($this->argument, $this);
    }
    else {
      $this->value = array(
        $this->argument,
      );
    }
    $this->view->nids = $this->value;
    return TRUE;
  }

  /**
   * Override the behavior of title(). Get the title of the node.
   */
  function title_query() {
    $titles = array();
    $result = db_query("SELECT n.title FROM {node} n WHERE n.nid IN (:nids)", array(
      ':nids' => $this->value,
    ));
    foreach ($result as $term) {
      $titles[] = check_plain($term->title);
    }
    return $titles;
  }

  /**
   * Builds the query.
   */
  public function query($group_by = FALSE) {
    $boolean = !empty($this->options['boolean_mode']);
    $text = '';

    // Since the view could have multiple nid arguments, load each node
    // and populate the $text variable with node titles and bodies.
    foreach ($this->value as $nid) {
      $node = node_load($nid);
      if ($this->options['rendered_content']) {
        $node_view = node_view($node, $this->options['rendered_view_mode'], $node->language);
        $node->body[$node->language][0]['value'] = render($node_view);
      }
      if (isset($node->title)) {

        // Remove punctuation from the title.
        $title = preg_replace('/[^a-z0-9 _-]+/i', '', $node->title);

        // Alter the relevancy of words in the node title if option is selected.
        if ($boolean && !empty($this->options['source_relevance']) && isset($this->options['title_operator'])) {
          $title = $this
            ->alter_node_title($title);
        }
        $text .= " {$title}";
      }
      if (isset($node->body) && isset($node->body[$node->language])) {

        // Strip tags and add slashes only to the body before adding the title.
        $body = trim(addslashes(strip_tags($node->body[$node->language][0]['safe_value'])));
        $text .= " {$body}";
      }
    }

    // Perform replacements to add custom operators to node body and title words.
    if ($boolean && !empty($this->options['enable_custom_operators']) && !empty($this->options['custom_operators'])) {
      $replacements = array_map('trim', explode('|', $this->options['custom_operators']));
      $words = array_map('similar_handler_argument_nid::get_search_word', $replacements);
      $text = preg_replace($words, $replacements, $text);
    }
    $text = trim($text);
    $this
      ->ensure_my_table();
    $query = $boolean ? $this
      ->similar_build_query($text, 'IN BOOLEAN MODE') : $this
      ->similar_build_query($text);

    // An empty string is passed for the table to bypass the table alias.
    $this->query
      ->add_field('', $query, 'score');

    // Exclude the current node(s).
    if (count($this->value) > 1) {
      $this->query
        ->add_where(0, 'node.nid', $this->value, 'NOT IN');
    }
    else {
      $this->query
        ->add_where(0, 'node.nid', $this->value[0], '<>');
    }

    // Add a node_access tag to prevent conflict with node_access module.
    $this->query
      ->add_tag('node_access');

    // Add a Similar Entries tag to indicate that filters and sort handlers are valid.
    $this->query
      ->add_tag('similar_entries');
  }

  /**
   * Builds a query from argument configuration options.
   *
   * @param string $text
   *   The text of the current node to be used in the query.
   * @param string $modifier
   *   An optional FULLTEXT search modifer. ie 'IN BOOLEAN MODE'.
   *
   * @return string
   *   A FULLTEXT expression string.
   *
   * @see similar_handler_argument_nid::query()
   */
  public function similar_build_query($text, $modifier = '') {
    $query = array();
    if (!empty($modifier)) {
      $modifier = " {$modifier}";
    }
    $weight = !empty($this->options['adjust_relevance']) && isset($this->options['title_relevance']) ? $this->options['title_relevance'] : 1;
    $query[] = "({$weight} * (MATCH (node.title) AGAINST ('{$text}'{$modifier})))";

    // The body field is always included in the query if it exists.
    if (db_table_exists('field_data_body')) {
      $weight = !empty($this->options['adjust_relevance']) ? $this->options['body_relevance'] : 1;
      $body_table = $this->query
        ->add_table('field_data_body');
      if ($weight) {
        $query[] = "({$weight} * (MATCH ({$body_table}.body_value) AGAINST ('{$text}'{$modifier})))";
      }
    }

    // Add additional MATCH queries for fields if enabled.
    if (!empty($this->options['include_fields']) && module_exists('field')) {
      foreach (similar_get_indices() as $field => $info) {
        $weight = !empty($this->options['adjust_relevance']) && isset($this->options['included_fields:' . $field]) ? $this->options['included_fields:' . $field] : 1;
        if ($weight) {
          $alias = $this->query
            ->ensure_table($info['table']);
          if (empty($alias) && !empty($this->query->relationships)) {
            foreach ($this->query->relationships as $relationship => $relationship_info) {
              $alias = $this->query
                ->ensure_table($info['table'], $relationship);
              if (!empty($alias)) {
                break;
              }
            }
          }
          if (!empty($alias)) {
            $query[] = "({$weight} * (MATCH ({$alias}.{$info['column']}) AGAINST ('{$text}'{$modifier})))";
          }
        }
      }
    }

    // Return a query that calculates an average score to prevent scores from fluctuating too much.
    // We multiply the score by different amounts depending on the modifier used.
    return "((" . implode(" + ", $query) . ") / " . count($query) . ")";
  }

  /**
   * Converts a user-defined word with operator into a search word for use
   * in preg_replace().
   *
   * @return string
   *   The word as prepared for use in a regular expression search.
   *
   * @see similar_handler_argument_nid::query()
   */
  public static function get_search_word($word) {
    return '/\\b' . trim($word, '+-<>~()"') . '\\b/i';
  }

  /**
   * Alters the node title's relevance for boolean searches.
   *
   * @param string $title
   *   The node title with punctuation removed.
   *
   * @return string
   *   The node title with new operators.
   *
   * @see similar_handler_argument_nid::query()
   */
  private function alter_node_title($title) {
    switch ($this->options['title_operator']) {
      case 'increase':
        return '>' . implode(' >', explode(' ', $title));
      case 'decrease':
        return '<' . implode(' <', explode(' ', $title));
      case 'require_all':
        return '+' . implode(' +', explode(' ', $title));
      case 'require_some':
        return "+({$title})";
      case 'require_complete':
        return '"' . $title . '"';
      case 'exclude_all':
        return '-' . implode(' -', explode(' ', $title));
      case 'exclude_some':
        return "-({$title})";
      case 'exclude_complete':
        return '-("' . $title . '")';
      default:
        return $title;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
similar_handler_argument_nid::alter_node_title	private	function	Alters the node title's relevance for boolean searches.
similar_handler_argument_nid::default_actions	public	function	Overrides argument's default actions list to ensure that node ID from URL is provided. Overrides views_handler_argument::default_actions
similar_handler_argument_nid::get_search_word	public static	function	Converts a user-defined word with operator into a search word for use in preg_replace().
similar_handler_argument_nid::options_form	public	function	Defines the options form. Overrides views_handler_argument_numeric::options_form
similar_handler_argument_nid::option_definition	public	function	Defines default values for argument settings. Overrides views_handler_argument_numeric::option_definition
similar_handler_argument_nid::query	public	function	Builds the query. Overrides views_handler_argument_numeric::query
similar_handler_argument_nid::similar_build_query	public	function	Builds a query from argument configuration options.
similar_handler_argument_nid::title_query		function	Override the behavior of title(). Get the title of the node. Overrides views_handler_argument_numeric::title_query
similar_handler_argument_nid::validate_arg	public	function	Validates that the argument works. Overrides views_handler_argument::validate_arg
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::accept_exposed_input	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::admin_summary	public	function	Provide text for the administrative summary.	4
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::can_expose	public	function	Determine if a handler can be exposed.	2
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_form	public	function	Render our chunk of the exposed handler form when selecting.	1
views_handler::exposed_info	public	function	Get information about the exposed form for the form renderer.	1
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_form	public	function	Form for exposed handler options.	2
views_handler::expose_options	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
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::expose_validate	public	function	Validate the options form.	1
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_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter.	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::multiple_exposed_input	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::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_button	public	function	Shortcut to display the expose/hide button.	2
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	public	function	If set to remember exposed input in the session, store it there.	1
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_argument::$argument	public	property
views_handler_argument::$name_field	public	property	The field to use for the name to use in the summary.
views_handler_argument::$name_table	public	property	The table to use for the name, if not the same table as the argument.
views_handler_argument::$validator	public	property
views_handler_argument::construct	public	function	Views handlers use a special construct function. Overrides views_object::construct	5
views_handler_argument::default_access_denied	public	function	Default action: access denied.
views_handler_argument::default_action	public	function	Handle the default action, which means our argument wasn't present.
views_handler_argument::default_argument_form	public	function	Provide a form for selecting the default argument.	1
views_handler_argument::default_default	public	function	This just returns true.
views_handler_argument::default_empty	public	function	Default action: empty.
views_handler_argument::default_ignore	public	function	Default action: ignore.
views_handler_argument::default_not_found	public	function	Default action: not found.
views_handler_argument::default_summary	public	function	Default action: summary.
views_handler_argument::default_summary_form	public	function	Form for selecting further summary options.
views_handler_argument::exception_title	public	function	Work out which title to use.
views_handler_argument::export_plugin	public	function	Generic plugin export handler.	1
views_handler_argument::export_summary	public	function	Export handler for summary export.
views_handler_argument::export_validation	public	function	Export handler for validation export.
views_handler_argument::get_default_argument	public	function	Get a default argument, if available.	1
views_handler_argument::get_plugin	public	function	Get the display or row plugin, if it exists.
views_handler_argument::get_title	public	function	Called by the view object to get the title.
views_handler_argument::get_value	public	function	Get the value of this argument.
views_handler_argument::has_default_argument	public	function	Determine if the argument is set to provide a default argument.
views_handler_argument::init	public	function	Init the handler with necessary data. Overrides views_handler::init	3
views_handler_argument::is_exception	public	function
views_handler_argument::needs_style_plugin	public	function	Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::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. Overrides views_handler::options_submit
views_handler_argument::options_validate	public	function	Validate the options form. Overrides views_handler::options_validate
views_handler_argument::process_summary_arguments	public	function	Process the summary arguments for display.
views_handler_argument::set_argument	public	function	Set the input for this argument.
views_handler_argument::set_breadcrumb	public	function	Give an argument the opportunity to modify the breadcrumb, if it wants.	3
views_handler_argument::summary_argument	public	function	Provide the argument to use to link from the summary to the next level.	4
views_handler_argument::summary_basics	public	function	Some basic summary behavior.
views_handler_argument::summary_name	public	function	Provides the name to use for the summary.	10
views_handler_argument::summary_name_field	public	function	Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_query	public	function	Build the info for the summary query.	3
views_handler_argument::summary_sort	public	function	Sorts the summary based upon the user's selection.
views_handler_argument::uses_breadcrumb	public	function	Determine if the argument can generate a breadcrumb.
views_handler_argument::validate_argument	public	function	Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic	public	function	Provide a basic argument validation.	1
views_handler_argument::validate_fail	public	function	How to act if validation fails.
views_handler_argument_numeric::$operator	public	property	The operator used for the query: or\|and.
views_handler_argument_numeric::$value	public	property	The actual value which is used for querying. Overrides views_handler_argument::$value
views_handler_argument_numeric::get_sort_name	public	function	Return a description of how the argument would normally be sorted. Overrides views_handler_argument::get_sort_name
views_handler_argument_numeric::title	public	function	Get the title this argument will assign the view, given the argument. Overrides views_handler_argument::title	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::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

You are here

class similar_handler_argument_nid in Similar Entries 7.2

Hierarchy

File

Members

API Navigation