You are here

drupal_variable.inc in Encrypt 7.3

Same filename and directory in other branches
  1. 7.2 plugins/key_providers/drupal_variable.inc

File

plugins/key_providers/drupal_variable.inc
View source
<?php

/**
 * @file
 * Plugin definition for the Drupal Private Key key provider.
 */
$plugin = encrypt_drupal_variable_encrypt_key_providers();

/**
 * Implements MODULE_FILENAME_encrypt_key_providers().
 */
function encrypt_drupal_variable_encrypt_key_providers() {
  return array(
    'title' => t('Drupal encrypt_drupal_variable_key variable'),
    'description' => t('Use a variable called encrypt_drupal_variable_key, preferably set in your settings.php $conf array.'),
    'key callback' => 'encrypt_get_encrypt_drupal_variable_key',
    'settings form' => NULL,
    'dependency callback' => '_encrypt_drupal_variable_is_present',
    'static key' => TRUE,
  );
}

/**
 * Callback function to return a variable.
 */
function encrypt_get_encrypt_drupal_variable_key() {
  $key = variable_get('encrypt_drupal_variable_key', NULL);
  if (empty($key)) {
    watchdog('encrypt', 'You need to set the encrypt_drupal_variable_key variable, preferably in $conf in your settings.php.', array(), WATCHDOG_EMERGENCY);
    drupal_set_message("Encryption settings are insufficient. See your site log for more information.", 'error');
  }
  return $key;
}

/**
 * Callback function to validate the variable is present.
 */
function _encrypt_drupal_variable_is_present() {
  $errors = array();
  $key = variable_get('encrypt_drupal_variable_key', NULL);
  if (empty($key)) {
    $errors[] = t('The encrypt_drupal_variable_key is currently null. You should set it, preferably in $conf in your settings.php.');
  }
  return $errors;
}

Functions

Namesort descending Description
encrypt_drupal_variable_encrypt_key_providers Implements MODULE_FILENAME_encrypt_key_providers().
encrypt_get_encrypt_drupal_variable_key Callback function to return a variable.
_encrypt_drupal_variable_is_present Callback function to validate the variable is present.