You are here

Home » API reference » Synonyms 7 » synonyms_views_plugin_argument_validate_taxonomy_term.inc

class synonyms_views_plugin_argument_validate_taxonomy_term in Synonyms 7

Validate whether an argument is an acceptable taxonomy term.

Hierarchy

Expanded class hierarchy of synonyms_views_plugin_argument_validate_taxonomy_term

1 string reference to 'synonyms_views_plugin_argument_validate_taxonomy_term'
synonyms_views_plugins_alter in views/synonyms.views.inc
Implements hook_views_plugins_alter().

File

views/synonyms_views_plugin_argument_validate_taxonomy_term.inc, line 12
An extended version of the 'taxonomy term' argument validator plugin, which supports synonyms as arguments.

View source 
class synonyms_views_plugin_argument_validate_taxonomy_term extends views_plugin_argument_validate_taxonomy_term {
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // We just want to add yet another way of validation - synonyms friendly
    // validation.
    $form['type']['#options']['synonym'] = t('Term name or synonym');
    $form['type']['#options']['synonym_tid'] = t('Term name or synonym converted to Term ID');
  }
  function validate_argument($argument) {
    $vocabularies = array_filter($this->options['vocabularies']);
    $type = $this->options['type'];
    $transform = $this->options['transform'];
    switch ($type) {
      case 'synonym':
      case 'synonym_tid':

        // We are requested to do synonyms friendly validation. Firstly we are
        // going to query the database trying to find a term with our argument's
        // name. If we find one, it is great and we stop right there. Otherwise,
        // we look up by synonyms.
        $query = db_select('taxonomy_term_data', 't')
          ->fields('t', array(
          'tid',
          'name',
        ));
        if (!empty($vocabularies)) {
          $query
            ->innerJoin('taxonomy_vocabulary', 'v', 't.vid = v.vid');
          $query
            ->condition('v.machine_name', $vocabularies);
        }
        if ($transform) {
          $query
            ->where("REPLACE(t.name, ' ', '-') = :name", array(
            ':name' => $argument,
          ));
        }
        else {
          $query
            ->condition('t.name', $argument, '=');
        }
        $result = $query
          ->range(0, 1)
          ->execute();
        if ($result
          ->rowCount()) {

          // We have found a term, we are going to use it.
          $term = taxonomy_term_load($result
            ->fetchField(0));
          $this->argument->argument = $this
            ->synonyms_get_term_property($term);
          $this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));
          return TRUE;
        }
        $bundles = $vocabularies;
        if (empty($vocabularies)) {

          // At this point we want to convert an empty $vocabularies (implicitly
          // meaning "all") into actually a list of all vocabularies.
          $bundles = synonyms_bundle_normalize('taxonomy_term', $vocabularies);
        }
        foreach ($bundles as $bundle) {
          $condition = db_and();
          if ($transform) {
            $condition
              ->where("REPLACE(" . AbstractSynonymsBehavior::COLUMN_SYNONYM_PLACEHOLDER . ", ' ', '-') = :argument", array(
              ':argument' => $argument,
            ));
          }
          else {
            $condition
              ->condition(AbstractSynonymsBehavior::COLUMN_SYNONYM_PLACEHOLDER, $argument);
          }
          $synonyms = synonyms_synonyms_find($condition, 'taxonomy_term', $bundle);
          if (!empty($synonyms)) {
            $term = taxonomy_term_load($synonyms[0]->entity_id);
            $this->argument->argument = $this
              ->synonyms_get_term_property($term);
            $this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));
            return TRUE;
          }
        }

        // We haven't found any synonym that matched our argument, so there is
        // no term to return.
        return FALSE;
      default:
        return parent::validate_argument($argument);
    }
  }

  /**
   * Return necessary property (per chosen validator) of encountered term.
   *
   * @param $term object
   *   Fully loaded taxonomy term from which necessary property should be
   *   returned
   *
   * @return mixed
   *   Necessary property (per chosen validator) of the provided term
   */
  function synonyms_get_term_property($term) {
    switch ($this->options['type']) {
      case 'synonym':
        return $term->name;
      case 'synonym_tid':
        return $term->tid;
    }
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
synonyms_views_plugin_argument_validate_taxonomy_term::options_form function Provide the default form for setting options. Overrides views_plugin_argument_validate_taxonomy_term::options_form
synonyms_views_plugin_argument_validate_taxonomy_term::synonyms_get_term_property function Return necessary property (per chosen validator) of encountered term.
synonyms_views_plugin_argument_validate_taxonomy_term::validate_argument function Overrides views_plugin_argument_validate_taxonomy_term::validate_argument
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
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::query public function Add anything to the query that we might need to. 7
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_argument_validate::access public function Determine if the administrator has the privileges to use this plugin. 1
views_plugin_argument_validate::check_access public function If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
views_plugin_argument_validate::options_validate public function Provide the default form form for validating options. Overrides views_plugin::options_validate
views_plugin_argument_validate_taxonomy_term::convert_options public function Convert options from the older style. Overrides views_plugin_argument_validate::convert_options
views_plugin_argument_validate_taxonomy_term::init public function Initialize this plugin with the view and the argument it is linked to. Overrides views_plugin_argument_validate::init
views_plugin_argument_validate_taxonomy_term::options_submit public function Provide the default form form for submitting options Overrides views_plugin_argument_validate::options_submit
views_plugin_argument_validate_taxonomy_term::option_definition public function Retrieve the options when this is a new access control plugin. Overrides views_plugin_argument_validate::option_definition
views_plugin_argument_validate_taxonomy_term::process_summary_arguments public function Process the summary arguments for displaying. Overrides views_plugin_argument_validate::process_summary_arguments