danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Plugin to provide access control based upon term vocabulary
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: vocabulary"),
danielebarchiesi@0:   'description' => t('Control access by vocabulary.'),
danielebarchiesi@0:   'callback' => 'ctools_term_vocabulary_ctools_access_check',
danielebarchiesi@0:   'default' => array('vids' => array()),
danielebarchiesi@0:   'settings form' => 'ctools_term_vocabulary_ctools_access_settings',
danielebarchiesi@0:   'settings form submit' => 'ctools_term_vocabulary_ctools_access_settings_submit',
danielebarchiesi@0:   'summary' => 'ctools_term_vocabulary_ctools_access_summary',
danielebarchiesi@0:   'required context' => new ctools_context_required(t('Vocabulary'), array('taxonomy_term', 'terms', 'taxonomy_vocabulary')),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Settings form for the 'by term_vocabulary' access plugin
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_vocabulary_ctools_access_settings($form, &$form_state, $conf) {
danielebarchiesi@0:   $options = array();
danielebarchiesi@0:   $vocabularies = taxonomy_get_vocabularies();
danielebarchiesi@0:   foreach ($vocabularies as $voc) {
danielebarchiesi@0:     $options[$voc->vid] = check_plain($voc->name);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['vids'] = array(
danielebarchiesi@0:     '#type' => 'checkboxes',
danielebarchiesi@0:     '#title' => t('Vocabularies'),
danielebarchiesi@0:     '#options' => $options,
danielebarchiesi@0:     '#description' => t('Only the checked vocabularies will be valid.'),
danielebarchiesi@0:     '#default_value' => $conf['vids'],
danielebarchiesi@0:   );
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Compress the term_vocabularys allowed to the minimum.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_vocabulary_ctools_access_settings_submit($form, &$form_state) {
danielebarchiesi@0:   $form_state['values']['settings']['vids'] = array_filter($form_state['values']['settings']['vids']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Check for access.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_vocabulary_ctools_access_check($conf, $context) {
danielebarchiesi@0:   // As far as I know there should always be a context at this point, but this
danielebarchiesi@0:   // is safe.
danielebarchiesi@0:   if (empty($context) || empty($context->data) || empty($context->data->vid)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (array_filter($conf['vids']) && empty($conf['vids'][$context->data->vid])) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return TRUE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a summary description based upon the checked term_vocabularys.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_vocabulary_ctools_access_summary($conf, $context) {
danielebarchiesi@0:   if (!isset($conf['type'])) {
danielebarchiesi@0:     $conf['type'] = array();
danielebarchiesi@0:   }
danielebarchiesi@0:   $vocabularies = taxonomy_get_vocabularies();
danielebarchiesi@0: 
danielebarchiesi@0:   $names = array();
danielebarchiesi@0:   foreach (array_filter($conf['vids']) as $vid) {
danielebarchiesi@0:     $names[] = check_plain($vocabularies[$vid]->name);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($names)) {
danielebarchiesi@0:     return t('@identifier is any vocabulary', array('@identifier' => $context->identifier));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return format_plural(count($names), '@identifier vocabulary is "@vids"', '@identifier vocabulary is one of "@vids"', array('@vids' => implode(', ', $names), '@identifier' => $context->identifier));
danielebarchiesi@0: }
danielebarchiesi@0: