site_language.inc in Chaos Tool Suite (ctools) 7

Plugin to provide access control based upon node type.

File

plugins/access/site_language.inc

<?php

/**
 * @file
 * Plugin to provide access control based upon node type.
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
if (module_exists('locale')) {
  $plugin = array(
    'title' => t("User: language"),
    'description' => t('Control access by the language the user or site currently uses.'),
    'callback' => 'ctools_site_language_ctools_access_check',
    'default' => array(
      'language' => array(),
    ),
    'settings form' => 'ctools_site_language_ctools_access_settings',
    'settings form submit' => 'ctools_site_language_ctools_access_settings_submit',
    'summary' => 'ctools_site_language_ctools_access_summary',
  );
}

/**
 * Settings form for the 'by site_language' access plugin.
 */
function ctools_site_language_ctools_access_settings($form, &$form_state, $conf) {
  $options = array(
    'default' => t('Default site language'),
  );
  $options = array_merge($options, locale_language_list());
  $form['settings']['language'] = array(
    '#title' => t('Language'),
    '#type' => 'checkboxes',
    '#options' => $options,
    '#description' => t('Pass only if the current site language is one of the selected languages.'),
    '#default_value' => $conf['language'],
  );
  return $form;
}

/**
 * Check for access.
 */
function ctools_site_language_ctools_access_check($conf, $context) {
  global $language;

  // Specialcase: If 'default' is checked, return TRUE if the default site language
  // matches the node language.
  if (!empty($conf['language']['default'])) {
    if ($language->language == language_default('language')) {
      return TRUE;
    }
  }
  if (array_filter($conf['language']) && empty($conf['language'][$language->language])) {
    return FALSE;
  }
  return TRUE;
}

/**
 * Provide a summary description based upon the checked site_languages.
 */
function ctools_site_language_ctools_access_summary($conf, $context) {
  $languages = array(
    'default' => t('Default site language'),
  );
  $languages = array_merge($languages, locale_language_list());
  if (!isset($conf['language'])) {
    $conf['language'] = array();
  }
  $names = array();
  foreach (array_filter($conf['language']) as $language) {
    $names[] = $languages[$language];
  }
  if (empty($names)) {
    return t('Site language is any language');
  }
  return format_plural(count($names), 'Site language is "@languages"', 'Site language is one of "@languages"', array(
    '@languages' => implode(', ', $names),
  ));
}

Functions

Name	Description
ctools_site_language_ctools_access_check	Check for access.
ctools_site_language_ctools_access_settings	Settings form for the 'by site_language' access plugin.
ctools_site_language_ctools_access_summary	Provide a summary description based upon the checked site_languages.