' .t('The Environment Indicator adds a coloured strip to the side of the site informing you which environment you\'re currently in (Development, Staging Production etc') .'';
$output .= ''. t('The Environment Indicator settings page allows you to modify some elements of the indicator\'s behavior and appearance. Since the appearance of the indicator is dependent on your site theme, substantial customisations require modifications to your site\'s theme and CSS files.', array('@settings' => url('admin/settings/environment_indicator'))) . '
';
$output .= ''. t('The Environment Indicator\'s visibility depends upon the permissions of the viewer. The access environment indicator permission must be enabled for a user role in order for users of that role to see the indicator.', array('@permissions' => url('admin/user/permissions', array('fragment' => 'module-environment_indicator')))) .'
';
$output .= ''. t('The settings for the Environment Indicator, such as the text to display and the color can be overridden for each of your specific environments in the site\'s settings.php file. This allows you to customise the indicator for each environment without needing to make any changes in the database. This means that the Environment Indicator will always display correctly when moving your site from development to staging to production. For example:') .'
';
$output .= '';
$output .= '- environment_indicator_text
- '. t('The text that will be displayed vertically down the indicator. e.g:
$conf[\'environment_indicator_text\'] = \'STAGING SERVER\';') .' ';
$output .= '- environment_indicator_color
- '. t('A valid css color. e.g:
$conf[\'environment_indicator_color\'] = \'red\';') .' ';
$output .= '- environment_indicator_enabled
- '. t('A boolean value indicating whether the Environment Indicator should be enabled or not. On your production environment, you should probably set this to FALSE. e.g:
$conf[\'environment_indicator_enabled\'] = FALSE;') .' ';
$output .= '
';
return $output;
}
}
/**
* Implement hook_perm().
*/
function environment_indicator_perm() {
return array(
'access environment indicator' => array(
'title' => t('Access environment indocator'),
'description' => t('View the environment indicator'),
)
);
}
/**
* Implement hook_menu().
*/
function environment_indicator_menu() {
$items['admin/config/development/environment_indicator'] = array(
'title' => 'Environment indicator',
'description' => 'Adjust settings for the Environment Indicator.',
'page callback' => 'drupal_get_form',
'page arguments' => array('environment_indicator_settings'),
'access arguments' => array('administer site configuration'),
'type' => MENU_NORMAL_ITEM,
);
return $items;
}
/**
* Module settings form.
*/
function environment_indicator_settings() {
$form['environment_indicator_enabled'] = array(
'#type' => 'radios',
'#title' => t('Status'),
'#default_value' => variable_get('environment_indicator_enabled', 1),
'#options' => array(t('Disabled'), t('Enabled')),
'#description' => t('Should the Environment Indicator display?'),
);
$form['environment_indicator_position'] = array(
'#type' => 'select',
'#title' => t('Position'),
'#description' => t('Choose a position for the environment indicator.'),
'#options' => array(
'left' => t('Left'),
'right' => t('Right'),
),
'#default_value' => variable_get('environment_indicator_position', 'left'),
);
$form['environment_indicator_margin'] = array(
'#type' => 'checkbox',
'#title' => t('Adjust margin'),
'#default_value' => variable_get('environment_indicator_margin', 1),
'#description' => t('If enabled, the site output is shifted to the left or right approximately 30 pixels to display the environment indicator. If disabled, some absolute- or fixed-positioned page elements may be covered by the environment indicator strip.'),
);
$form['environment_indicator_text'] = array(
'#type' => 'textfield',
'#title' => t('Text to display'),
'#default_value' => variable_get('environment_indicator_text', 'ENVIRONMENT INDICATOR'),
'#description' => t('Text to display in the environment indicator. Override this for each environment in settings.php.'),
);
$form['environment_indicator_color'] = array(
'#type' => 'textfield',
'#title' => t('Colour'),
'#default_value' => variable_get('environment_indicator_color', '#d00c0c'),
'#description' => t('The colour of the environment indicator. Override this for each environment in settings.php.'),
'#size' => 7,
);
$form['environment_indicator_suppress_pages'] = array(
'#type' => 'textarea',
'#title' => t('Turn off Environment Indicator on these pages'),
'#default_value' => variable_get('environment_indicator_suppress_pages', "imagecrop/*\n"),
'#description' => t("Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are 'blog' for the blog page and 'blog/*' for every personal blog. '<front>' is the front page."),
);
return system_settings_form($form);
}
/**
* Implement hook_init().
*/
function environment_indicator_init() {
if (!user_access('access environment indicator') || !variable_get('environment_indicator_enabled', 1)) {
return;
}
// Do not show the indicator on select pages.
$off_pages = variable_get('environment_indicator_suppress_pages', "imagecrop/*\n");
$path = drupal_get_path_alias($_GET['q']);
// Compare with the internal and path alias (if any).
$page_match = drupal_match_path($path, $off_pages);
if ($path != $_GET['q']) {
$page_match = $page_match || drupal_match_path($_GET['q'], $off_pages);
}
if ($page_match) {
return;
}
$path = drupal_get_path('module', 'environment_indicator');
drupal_add_css($path .'/environment_indicator.css', array('preprocess' => FALSE));
// Performance: Defer execution.
drupal_add_js($path .'/environment_indicator.min.js');
//drupal_add_js($path .'/environment_indicator.js', array('preprocess' => FALSE));
if ($setting = variable_get('environment_indicator_margin', 1)) {
$settings['margin'] = check_plain($setting);
}
if ($setting = variable_get('environment_indicator_position', 'left')) {
$settings['position'] = check_plain($setting);
}
if ($setting = variable_get('environment_indicator_text', 'ENVIRONMENT INDICATOR')) {
$settings['text'] = check_plain($setting);
}
if ($setting = variable_get('environment_indicator_color', '#d00c0c')) {
$settings['color'] = check_plain($setting);
}
drupal_add_js(array('environment_indicator' => $settings), 'setting');
}
/**
* Suppress display of administration menu.
*
* This function should be called from within another module's page callback
* (preferably using module_invoke()) when the indicator should not be displayed.
* This is useful for modules that implement popup pages or other special
* pages where the menu would be distracting or break the layout.
*
* @param $set
* Defaults to TRUE. If called before hook_footer, the menu will not be
* displayed. If FALSE is passed, the suppression state is returned.
*/
function environment_indicator_suppress($set = TRUE) {
static $suppress = FALSE;
// drupal_add_js() must only be invoked once.
if (!empty($set) && $suppress === FALSE) {
$suppress = TRUE;
drupal_add_js(array('environment_indicator' => array('suppress' => 1)), 'setting');
}
return $suppress;
}