summaryrefslogtreecommitdiff
path: root/kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc
diff options
context:
space:
mode:
Diffstat (limited to 'kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc')
-rw-r--r--kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc128
1 files changed, 128 insertions, 0 deletions
diff --git a/kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc b/kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc
new file mode 100644
index 0000000..ab05b60
--- /dev/null
+++ b/kolab.org/www/drupal-7.26/sites/all/modules/ctools/term_depth/plugins/access/term_depth.inc
@@ -0,0 +1,128 @@
+<?php
+
+/**
+ * @file
+ * Plugin to provide access control based upon a parent term.
+ */
+
+/**
+ * Plugins are described by creating a $plugin array which will be used
+ * by the system that includes this file.
+ */
+$plugin = array(
+ 'title' => t("Taxonomy: term depth"),
+ 'description' => t('Control access by the depth of a term.'),
+ 'callback' => 'term_depth_term_depth_ctools_access_check',
+ 'default' => array('vid' => array(), 'depth' => 0),
+ 'settings form' => 'term_depth_term_depth_ctools_access_settings',
+ 'settings form validation' => 'term_depth_term_depth_ctools_access_settings_validate',
+ 'settings form submit' => 'term_depth_term_depth_ctools_access_settings_submit',
+ 'summary' => 'term_depth_term_depth_ctools_access_summary',
+ 'required context' => new ctools_context_required(t('Term'), array('taxonomy_term', 'terms')),
+);
+
+/**
+ * Settings form for the 'term depth' access plugin.
+ */
+function term_depth_term_depth_ctools_access_settings($form, &$form_state, $conf) {
+ // If no configuration was saved before, set some defaults.
+ if (empty($conf)) {
+ $conf = array(
+ 'vid' => 0,
+ );
+ }
+ if (!isset($conf['vid'])) {
+ $conf['vid'] = 0;
+ }
+
+ // Loop over each of the configured vocabularies.
+ foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
+ $options[$vid] = $vocabulary->name;
+ }
+
+ $form['settings']['vid'] = array(
+ '#title' => t('Vocabulary'),
+ '#type' => 'select',
+ '#options' => $options,
+ '#description' => t('Select the vocabulary for this form. If there exists a parent term in that vocabulary, this access check will succeed.'),
+ '#id' => 'ctools-select-vid',
+ '#default_value' => $conf['vid'],
+ '#required' => TRUE,
+ );
+
+ $form['settings']['depth'] = array(
+ '#title' => t('Depth'),
+ '#type' => 'textfield',
+ '#description' => t('Set the required depth of the term. If the term exists at the correct depth, this access check will succeed.'),
+ '#default_value' => $conf['depth'],
+ '#required' => TRUE,
+ );
+
+ return $form;
+}
+
+/**
+ * Submit function for the access plugins settings.
+ *
+ * We cast all settings to numbers to ensure they can be safely handled.
+ */
+function term_depth_term_depth_ctools_access_settings_submit($form, $form_state) {
+ foreach (array('depth', 'vid') as $key) {
+ $form_state['conf'][$key] = (integer) $form_state['values']['settings'][$key];
+ }
+}
+
+/**
+ * Check for access.
+ */
+function term_depth_term_depth_ctools_access_check($conf, $context) {
+ // As far as I know there should always be a context at this point, but this
+ // is safe.
+ if (empty($context) || empty($context->data) || empty($context->data->vid) || empty($context->data->tid)) {
+ return FALSE;
+ }
+
+ // Get the $vid.
+ if (!isset($conf['vid'])) {
+ return FALSE;
+ }
+ $depth = _term_depth($context->data->tid);
+
+ return ($depth == $conf['depth']);
+}
+
+/**
+ * Provide a summary description based upon the checked terms.
+ */
+function term_depth_term_depth_ctools_access_summary($conf, $context) {
+ $vocab = taxonomy_vocabulary_load($conf['vid']);
+
+ return t('"@term" has parent in vocabulary "@vocab" at @depth', array(
+ '@term' => $context->identifier,
+ '@vocab' => $vocab->name,
+ '@depth' => $conf['depth'],
+ ));
+}
+
+/**
+ * Find the depth of a term.
+ */
+function _term_depth($tid) {
+ static $depths = array();
+
+ if (!isset($depths[$tid])) {
+ $parent = db_select('taxonomy_term_hierarchy', 'th')
+ ->fields('th', array('parent'))
+ ->condition('tid', $tid)
+ ->execute()->fetchField();
+
+ if ($parent == 0) {
+ $depths[$tid] = 1;
+ }
+ else {
+ $depths[$tid] = 1 + _term_depth($parent);
+ }
+ }
+
+ return $depths[$tid];
+}