danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Plugin to provide a term context
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Plugins are described by creating a $plugin array which will be used
danielebarchiesi@0:  * by the system that includes this file.
danielebarchiesi@0:  */
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t("Taxonomy term"),
danielebarchiesi@0:   'description' => t('A single taxonomy term object.'),
danielebarchiesi@0:   'context' => 'ctools_context_create_term',
danielebarchiesi@0:   'edit form' => 'ctools_context_term_settings_form',
danielebarchiesi@0:   'defaults' => array(
danielebarchiesi@0:     'vid' => '',
danielebarchiesi@0:     'tid' => '',
danielebarchiesi@0:   ),
danielebarchiesi@0:   'keyword' => 'term',
danielebarchiesi@0:   'context name' => 'term',
danielebarchiesi@0:   'convert list' => array(
danielebarchiesi@0:     'tid' => t('Term ID'),
danielebarchiesi@0:     'name' => t('Term name'),
danielebarchiesi@0:     'name_dashed' => t('Term name, lowercased and spaces converted to dashes'),
danielebarchiesi@0:     'description' => t('Term Description'),
danielebarchiesi@0:     'vid' => t('Vocabulary ID'),
danielebarchiesi@0:   ),
danielebarchiesi@0:   'convert' => 'ctools_context_term_convert',
danielebarchiesi@0:   // This context is deprecated and should not be usable in the UI.
danielebarchiesi@0:   'no ui' => TRUE,
danielebarchiesi@0:   'no required context ui' => TRUE,
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * It's important to remember that $conf is optional here, because contexts
danielebarchiesi@0:  * are not always created from the UI.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create_term($empty, $data = NULL, $conf = FALSE) {
danielebarchiesi@0:   $context = new ctools_context('term');
danielebarchiesi@0:   $context->plugin = 'term';
danielebarchiesi@0: 
danielebarchiesi@0:   if ($empty) {
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($conf && isset($data['tid'])) {
danielebarchiesi@0:     $data = taxonomy_term_load($data['tid']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($data)) {
danielebarchiesi@0:     $context->data        = $data;
danielebarchiesi@0:     $context->title       = $data->name;
danielebarchiesi@0:     $context->argument    = $data->tid;
danielebarchiesi@0:     $context->description = $data->description;
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_term_settings_form($form, &$form_state) {
danielebarchiesi@0:   $conf = $form_state['conf'];
danielebarchiesi@0: 
danielebarchiesi@0:   $form['vid'] = array(
danielebarchiesi@0:     '#title' => t('Vocabulary'),
danielebarchiesi@0:     '#type' => 'select',
danielebarchiesi@0:     '#options' => array(),
danielebarchiesi@0:     '#description' => t('Select the vocabulary for this form.'),
danielebarchiesi@0:     '#id' => 'ctools-select-vid',
danielebarchiesi@0:     '#default_value' => $conf['vid'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $description = '';
danielebarchiesi@0:   if (!empty($conf['tid'])) {
danielebarchiesi@0:     $info = db_query('SELECT * FROM {taxonomy_term_data} WHERE tid = :tid', array(':tid' => $conf['tid']))->fetchObject();
danielebarchiesi@0:     if ($info) {
danielebarchiesi@0:       $description = ' ' . t('Currently set to @term. Enter another term if you wish to change the term.', array('@term' => $info->name));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   ctools_include('dependent');
danielebarchiesi@0:   $options = array();
danielebarchiesi@0: 
danielebarchiesi@0:   $form['taxonomy']['#tree'] = TRUE;
danielebarchiesi@0: 
danielebarchiesi@0:   foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
danielebarchiesi@0:     $options[$vid] = $vocabulary->name;
danielebarchiesi@0:     $form['taxonomy'][$vocabulary->vid] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#description' => t('Select a term from @vocabulary.', array('@vocabulary' => $vocabulary->name)) . $description,
danielebarchiesi@0:       '#autocomplete_path' => 'taxonomy/autocomplete/' . $vocabulary->vid,
danielebarchiesi@0:       '#dependency' => array('ctools-select-vid' => array($vocabulary->vid)),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['vid']['#options'] = $options;
danielebarchiesi@0: 
danielebarchiesi@0:   $form['tid'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#value' => $conf['tid'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['set_identifier'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#default_value' => FALSE,
danielebarchiesi@0:     '#title' => t('Reset identifier to term title'),
danielebarchiesi@0:     '#description' => t('If checked, the identifier will be reset to the term name of the selected term.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate a term.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_term_settings_form_validate($form, &$form_state) {
danielebarchiesi@0:   // Validate the autocomplete
danielebarchiesi@0:   $vid = $form_state['values']['vid'];
danielebarchiesi@0:   if (empty($form_state['values']['tid']) && empty($form_state['values']['taxonomy'][$vid])) {
danielebarchiesi@0:     form_error($form['taxonomy'][$vid], t('You must select a term.'));
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($form_state['values']['taxonomy'][$vid])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $term = db_query('SELECT tid FROM {taxonomy_term_data} WHERE LOWER(name) = LOWER(:name) AND vid = :vid', array(':name' => $form_state['values']['taxonomy'][$vid], ':vid' => $vid))->fetchObject();
danielebarchiesi@0: 
danielebarchiesi@0:   if (!$term) {
danielebarchiesi@0:     form_error($form['taxonomy'][$vid], t('Invalid term selected.'));
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     form_set_value($form['tid'], $term->tid, $form_state);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_term_settings_form_submit($form, &$form_state) {
danielebarchiesi@0:   if ($form_state['values']['set_identifier']) {
danielebarchiesi@0:     $term = db_query('SELECT tid, name FROM {taxonomy_term_data} WHERE LOWER(tid) = :tid', array(':tid' => $form_state['values']['tid']))->fetchObject();
danielebarchiesi@0:     $form_state['values']['identifier'] = $term->name;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form_state['conf']['tid'] = $form_state['values']['tid'];
danielebarchiesi@0:   $form_state['conf']['vid'] = $form_state['values']['vid'];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert a context into a string.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_term_convert($context, $type) {
danielebarchiesi@0:   switch ($type) {
danielebarchiesi@0:     case 'tid':
danielebarchiesi@0:       return $context->data->tid;
danielebarchiesi@0:     case 'name':
danielebarchiesi@0:       return $context->data->name;
danielebarchiesi@0:     case 'name_dashed':
danielebarchiesi@0:       return drupal_strtolower(str_replace(' ', '-', $context->data->name));
danielebarchiesi@0:     case 'vid':
danielebarchiesi@0:       return $context->data->vid;
danielebarchiesi@0:     case 'description':
danielebarchiesi@0:       return $context->data->description;
danielebarchiesi@0:   }
danielebarchiesi@0: }