<?php
// $Id$

/**
 * @file
 * Flag taxonomy terms.
 */

/**
 * Implementation of hook_flag_definitions().
 */
function flag_taxonomy_flag_definitions() {
  return array(
    'term' => array(
      'title' => t('Taxonomy terms'),
      'description' => t("Taxonomy terms are used to classify content."),
      'handler' => 'flag_term',
    ),
  );
}

/**
 * Implements a term flag.
 */
class flag_term extends flag_flag {
  function default_options() {
    $options = parent::default_options();
    $options += array(
      'show_on_term_page' => TRUE,
    );
    return $options;
  }

  function options_form(&$form) {
    parent::options_form($form);

    $options = array();
    foreach (taxonomy_get_vocabularies() as $vocab) {
      $options[$vocab->vid] = check_plain($vocab->name);
    }
    $form['types'] = array(
      '#type' => 'checkboxes',
      '#title' => t('The vocabularies whose terms will be flaggable'),
      '#options' => $options,
      '#default_value' => $this->types,
      '#required' => TRUE,
      '#weight' => 10,
      '#access' => empty($flag->locked['types']),
    );
    $form['display']['show_on_term_page'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display link on q=taxonomy/term/x pages'),
      '#default_value' => $this->show_on_term_page,
      '#access' => empty($this->locked['show_on_term_page']),
    );
  }

  function _load_content($content_id) {
    return taxonomy_get_term($content_id);
  }

  function applies_to_content_object($term) {
    if ($term && in_array($term->vid, $this->types)) {
      return TRUE;
    }
    return FALSE;
  }

  function get_content_id($term) {
    return $term->tid;
  }

  // The 'Token' module doesn't seem to provide any term tokens, so
  // the following two methods aren't really useful.

  function get_labels_token_types() {
    return array('term');
  }

  function replace_tokens($label, $contexts, $content_id) {
    if ($content_id && ($term = $this->fetch_content($content_id))) {
      $contexts['term'] = $term;
    }
    return parent::replace_tokens($label, $contexts, $content_id);
  }

  function get_flag_action($content_id) {
    $flag_action = parent::get_flag_action($content_id);
    $term = $this->fetch_content($content_id);
    $flag_action->content_title = $term->name;
    $flag_action->content_url = _flag_url('taxonomy/term/' . $term->tid);
    return $flag_action;
  }

  function get_relevant_action_objects($content_id) {
    return array(
      'term' => $this->fetch_content($content_id),
    );
  }

  function get_views_info() {
    return array(
      'views table' => 'term_data',
      'join field' => 'tid',
      'title field' => 'name',
      'title' => t('Taxonomy term flag'),
      'help' => t('Limit results to only those terms flagged by a certain flag; Or display information about the flag set on a term.'),
      'counter title' => t('Taxonomy term flag counter'),
      'counter help' => t('Include this to gain access to the flag counter field.'),
    );
  }

  function applies_to_content_id_array($content_ids) {
    $passed = array();
    foreach ($content_ids as $tid) {
      if ($this->applies_to_content_id($tid)) {
        $passed[$tid] = TRUE;
      }
    }
    return $passed;
  }

}

/**
 * Implementation of hook_help().
 *
 * Injects flag links into taxonony/term/% pages.
 */
function flag_taxonomy_help($path, $arg) {
  $links = array();
  if (preg_match(',^taxonomy/term/,', $path) && is_numeric($arg[2])) {
    $tid = (int)$arg[2];
    foreach (flag_get_flags('term') as $flag) {
      $links[] = flag_create_link($flag->name, $tid);
    }
  }
  // @todo Use some theme function for the overall look.
  return join('', $links);
}