term_parent.inc

<?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: parent term"),
    'description' => t('Control access by existence of a parent term.'),
    'callback' => 'ctools_term_parent_ctools_access_check',
    'default' => array(
        'vid' => array(),
        'negate' => 0,
    ),
    'settings form' => 'ctools_term_parent_ctools_access_settings',
    'settings form validate' => 'ctools_term_parent_ctools_access_settings_validate',
    'settings form submit' => 'ctools_term_parent_ctools_access_settings_submit',
    'summary' => 'ctools_term_parent_ctools_access_summary',
    'required context' => new ctools_context_required(t('Term'), array(
        'taxonomy_term',
        'terms',
    )),
);

/**
 * Settings form for the 'by parent term' access plugin.
 */
function ctools_term_parent_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;
    }
    $form['settings']['vid'] = array(
        '#title' => t('Vocabulary'),
        '#type' => 'select',
        '#options' => array(),
        '#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,
    );
    $options = array();
    // Loop over each of the configured vocabularies.
    foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
        $options[$vid] = $vocabulary->name;
    }
    $form['settings']['vid']['#options'] = $options;
    return $form;
}

/**
 * Check for access.
 */
function ctools_term_parent_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;
    }
    $vid = $conf['vid'];
    $count = db_query('SELECT COUNT(*) FROM {taxonomy_term_hierarchy} th INNER JOIN {taxonomy_term_data} td ON th.parent = td.tid WHERE th.tid = :tid AND td.vid = :vid', array(
        ':tid' => $context->data->tid,
        ':vid' => $vid,
    ))
        ->fetchField();
    return $count ? TRUE : FALSE;
}

/**
 * Provide a summary description based upon the checked terms.
 */
function ctools_term_parent_ctools_access_summary($conf, $context) {
    $vocab = taxonomy_vocabulary_load($conf['vid']);
    return t('"@term" has parent in vocabulary "@vocab"', array(
        '@term' => $context->identifier,
        '@vocab' => $vocab->name,
    ));
}