forum_container.inc in Advanced Forum 6.2

Plugin to provide access control based upon term vocabulary

File

plugins/access/forum_container.inc

<?php

/**
 * @file
 * Plugin to provide access control based upon term vocabulary
 */

/**
 * Implementation of specially named hook_ctools_access().
 */
function advanced_forum_forum_container_ctools_access() {
  return array(
    'title' => t("Forum: container"),
    'description' => t('Control access by whether or not the forum is a container.'),
    'callback' => 'advanced_forum_forum_container_ctools_access_check',
    'default' => array(
      'container' => 0,
    ),
    'settings form' => 'advanced_forum_forum_container_ctools_access_settings',
    'settings form submit' => 'advanced_forum_forum_container_ctools_access_settings_submit',
    'summary' => 'advanced_forum_forum_container_ctools_acesss_summary',
    'required context' => new ctools_context_required(t('Forum'), array(
      'forum',
    )),
  );
}

/**
 * Settings form for the 'by term_vocabulary' access plugin
 */
function advanced_forum_forum_container_ctools_access_settings(&$form, &$form_state, $conf) {
  $form['settings']['container'] = array(
    '#type' => 'select',
    '#title' => t('Container'),
    '#options' => array(
      0 => t('Pass if forum is a container'),
      1 => t('Pass if forum is not a container'),
    ),
    '#default_value' => $conf['container'],
  );
}

/**
 * Compress the term_vocabularys allowed to the minimum.
 */
function advanced_forum_forum_container_ctools_access_settings_submit(&$form, &$form_state) {
  $form_state['values']['settings']['container'] = $form_state['values']['settings']['container'];
}

/**
 * Check for access.
 */
function advanced_forum_forum_container_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)) {
    return FALSE;
  }

  // xor returns false if the two bools are the same, and true if they are not.
  return $context->data->container xor !empty($conf['container']);
}

/**
 * Provide a summary description based upon the checked term_vocabularys.
 */
function advanced_forum_forum_container_ctools_acesss_summary($conf, $context) {
  $comparison = empty($conf['container']) ? "is" : 'is not';
  return t('@id1 @comp a forum container', array(
    '@comp' => $comparison,
    '@id1' => $context->identifier,
  ));
}

Functions

Name	Description
advanced_forum_forum_container_ctools_access	Implementation of specially named hook_ctools_access().
advanced_forum_forum_container_ctools_access_check	Check for access.
advanced_forum_forum_container_ctools_access_settings	Settings form for the 'by term_vocabulary' access plugin
advanced_forum_forum_container_ctools_access_settings_submit	Compress the term_vocabularys allowed to the minimum.
advanced_forum_forum_container_ctools_acesss_summary	Provide a summary description based upon the checked term_vocabularys.