Newer
Older
Dries Buytaert
committed
<?php
Angie Byron
committed
/**
* Implements hook_help().
*/
function dashboard_help($path, $arg) {
switch ($path) {
case 'admin/help#dashboard':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
Angie Byron
committed
$output .= '<p>' . t('The Dashboard module provides a <a href="@dashboard">Dashboard page</a> in the administrative interface for organizing administrative tasks and navigation, and tracking information within your site. The Dashboard page contains blocks, which you can add to and arrange using the drag-and-drop interface that appears when you click on the <em>Customize dashboard</em> link. Within this interface, blocks that are not primarily used for site administration do not appear by default, but can be added via the <em>Add other blocks</em> link. For more information, see the online handbook entry for <a href="@handbook">Dashboard module</a>.', array('@handbook' => 'http://drupal.org/handbook/modules/dashboard', '@dashboard' => url('admin/dashboard'))) . '</p>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Tracking user activity') . '</dt>';
$output .= '<dd>' . t("By enabling blocks such as <em>Who's online</em> and <em>Who's new</em>, site users can track who is logged in and new user signups at a centralized location.") . '</dd>';
$output .= '<dt>' . t('Tracking content activity') . '</dt>';
$output .= '<dd>' . t('By enabling blocks such as <em>New forum topics</em> and <em>Recent comments</em>, site users can view newly added site content at a glance.') . '</dd>';
Angie Byron
committed
$output .= '</dl>';
return $output;
Dries Buytaert
committed
case 'admin/dashboard/configure':
// @todo This assumes the current page is being displayed using the same
// theme that the dashboard is displayed in.
Angie Byron
committed
$output = '<p>' . t('Rearrange blocks for display on the <a href="@dashboard-url">Dashboard page</a>. Blocks placed in the <em>Dashboard (inactive)</em> region are not displayed when viewing the Dashboard page, but are available within its <em>Customize dashboard</em> interface. Removing a block from active dashboard display makes it available on the main <a href="@blocks-url">blocks administration page</a>.', array('@dashboard-url' => url('admin/dashboard'), '@blocks-url' => url("admin/structure/block/list/{$GLOBALS['theme_key']}"))) . '</p>';
return $output;
Angie Byron
committed
}
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
*/
function dashboard_menu() {
$items['admin/dashboard'] = array(
'title' => 'Dashboard',
'description' => 'View and customize your dashboard.',
Dries Buytaert
committed
'page callback' => 'dashboard_admin',
'access arguments' => array('access dashboard'),
Dries Buytaert
committed
// Make this appear first, so for example, in admin menus, it shows up on
// the top corner of the window as a convenient "home link".
'weight' => -15,
Dries Buytaert
committed
);
Dries Buytaert
committed
$items['admin/dashboard/configure'] = array(
'title' => 'Configure available dashboard blocks',
'description' => 'Configure which blocks can be shown on the dashboard.',
'page callback' => 'dashboard_admin_blocks',
'access arguments' => array('administer blocks'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
);
Dries Buytaert
committed
$items['admin/dashboard/customize'] = array(
'title' => 'Customize dashboard',
'description' => 'Customize your dashboard.',
Dries Buytaert
committed
'page callback' => 'dashboard_admin',
'page arguments' => array(TRUE),
'access arguments' => array('access dashboard'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
Dries Buytaert
committed
);
$items['admin/dashboard/drawer'] = array(
'page callback' => 'dashboard_show_disabled',
'access arguments' => array('administer blocks'),
'type' => MENU_CALLBACK,
);
$items['admin/dashboard/block-content/%/%'] = array(
'page callback' => 'dashboard_show_block_content',
'page arguments' => array(3, 4),
'access arguments' => array('administer blocks'),
'type' => MENU_CALLBACK,
);
$items['admin/dashboard/update'] = array(
'page callback' => 'dashboard_update',
'access arguments' => array('administer blocks'),
'type' => MENU_CALLBACK,
);
Dries Buytaert
committed
return $items;
}
Dries Buytaert
committed
/**
* Implements hook_permission().
Dries Buytaert
committed
*/
function dashboard_permission() {
return array(
'access dashboard' => array(
'title' => t('View the administrative dashboard'),
// Note: We translate the 'Administer blocks' permission string here with
// a separate t() call, to make sure it gets the same translation as when
// it's in block_permission().
'description' => t('Customizing the dashboard requires the !permission-name permission.', array(
'!permission-name' => l(t('Administer blocks'), 'admin/people/permissions', array('fragment' => 'module-block')),
)),
),
);
Dries Buytaert
committed
}
Angie Byron
committed
/**
* Implements hook_block_info_alter().
*/
function dashboard_block_info_alter(&$blocks, $theme, $code_blocks) {
$admin_theme = variable_get('admin_theme');
if (($admin_theme && $theme == $admin_theme) || (!$admin_theme && $theme == variable_get('theme_default', 'bartik'))) {
foreach ($blocks as $module => &$module_blocks) {
foreach ($module_blocks as $delta => &$block) {
// Make administrative blocks that are not already in use elsewhere
// available for the dashboard.
if (empty($block['status']) && (empty($block['region']) || $block['region'] == BLOCK_REGION_NONE) && !empty($code_blocks[$module][$delta]['properties']['administrative'])) {
$block['status'] = 1;
$block['region'] = 'dashboard_inactive';
}
}
}
}
}
Dries Buytaert
committed
/**
* Implements hook_block_list_alter().
Dries Buytaert
committed
*
* Skip rendering dashboard blocks when not on the dashboard page itself. This
* prevents expensive dashboard blocks from causing performance issues on pages
* where they will never be displayed.
*/
function dashboard_block_list_alter(&$blocks) {
Dries Buytaert
committed
if (!dashboard_is_visible()) {
foreach ($blocks as $key => $block) {
if (in_array($block->region, dashboard_regions())) {
unset($blocks[$key]);
}
}
}
}
/**
Dries Buytaert
committed
* Implements hook_page_build().
Dries Buytaert
committed
*
* Display dashboard blocks in the main content region.
*/
Dries Buytaert
committed
function dashboard_page_build(&$page) {
Dries Buytaert
committed
global $theme_key;
if (dashboard_is_visible()) {
$block_info = array();
Dries Buytaert
committed
Dries Buytaert
committed
// Create a wrapper for the dashboard itself, then insert each dashboard
// region into it.
$page['content']['dashboard'] = array('#theme_wrappers' => array('dashboard'));
foreach (dashboard_regions() as $region) {
Angie Byron
committed
// Do not show dashboard blocks that are disabled.
if ($region == 'dashboard_inactive') {
continue;
}
Dries Buytaert
committed
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
// Insert regions even when they are empty, so that they will be
// displayed when the dashboard is being configured.
$page['content']['dashboard'][$region] = !empty($page[$region]) ? $page[$region] : array();
$page['content']['dashboard'][$region]['#dashboard_region'] = $region;
// Allow each dashboard region to be themed differently, or fall back on
// the generic theme wrapper function for dashboard regions.
$page['content']['dashboard'][$region]['#theme_wrappers'][] = array($region, 'dashboard_region');
unset($page[$region]);
$blocks_found = array();
foreach ($page['content']['dashboard'][$region] as $item) {
if (isset($item['#theme_wrappers']) && is_array($item['#theme_wrappers']) && in_array('block', $item['#theme_wrappers'])) {
// If this item is a block, ensure it has a subject.
if (empty($item['#block']->subject)) {
// Locally cache info data for the object for all blocks, in case
// we find a block similarly missing title from the same module.
if (!isset($block_info[$item['#block']->module])) {
$block_info[$item['#block']->module] = module_invoke($item['#block']->module, 'block_info');
}
$item['#block']->subject = $block_info[$item['#block']->module][$item['#block']->delta]['info'];
}
$blocks_found[$item['#block']->module . '_' . $item['#block']->delta] = TRUE;
}
}
// Find blocks which were not yet displayed on the page (were empty), and
// add placeholder items in their place for rendering.
$block_list = db_select('block')
->condition('theme', $theme_key)
->condition('status', 1)
->condition('region', $region)
->fields('block')
->execute();
foreach ($block_list as $block) {
if (!isset($blocks_found[$block->module . '_' . $block->delta])) {
$block->enabled = $block->page_match = TRUE;
$block->content = array('#markup' => '<div class="dashboard-block-empty">(empty)</div>');
if (!isset($block_info[$block->module])) {
$block_info[$block->module] = module_invoke($block->module, 'block_info');
}
$block->subject = t('@title', array('@title' => $block_info[$block->module][$block->delta]['info']));
$block_render = array($block->module . '_' . $block->delta => $block);
$build = _block_get_renderable_array($block_render);
$page['content']['dashboard'][$block->region][] = $build;
}
}
}
}
}
/**
Dries Buytaert
committed
* Implements hook_system_info_alter().
Dries Buytaert
committed
*
* Add regions to each theme to store the dashboard blocks.
*/
function dashboard_system_info_alter(&$info, $file, $type) {
if ($type == 'theme') {
Angie Byron
committed
// Add the dashboard regions (the "inactive" region should always appear
// last in the list, for usability reasons).
$dashboard_regions = dashboard_region_descriptions();
if (isset($dashboard_regions['dashboard_inactive'])) {
$inactive_region = $dashboard_regions['dashboard_inactive'];
unset($dashboard_regions['dashboard_inactive']);
$dashboard_regions['dashboard_inactive'] = $inactive_region;
}
$info['regions'] += $dashboard_regions;
Angie Byron
committed
// Indicate that these regions are intended to be displayed whenever the
// dashboard is displayed in an overlay. This information is provided for
// any module that might need to use it, not just the core Overlay module.
$info['overlay_regions'] = !empty($info['overlay_regions']) ? array_merge($info['overlay_regions'], dashboard_regions()) : dashboard_regions();
Dries Buytaert
committed
}
}
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function dashboard_theme() {
return array(
'dashboard' => array(
'render element' => 'element',
Dries Buytaert
committed
),
Dries Buytaert
committed
'dashboard_admin' => array(
'render element' => 'element',
Dries Buytaert
committed
),
Dries Buytaert
committed
'dashboard_region' => array(
'render element' => 'element',
Dries Buytaert
committed
),
'dashboard_disabled_blocks' => array(
'variables' => array('blocks' => NULL),
Dries Buytaert
committed
),
'dashboard_disabled_block' => array(
'variables' => array('block' => NULL),
Dries Buytaert
committed
),
'dashboard_admin_display_form' => array(
// When building the form for configuring dashboard blocks, reuse the
// Block module's template for the main block configuration form.
'template' => 'block-admin-display-form',
'path' => drupal_get_path('module', 'block'),
'file' => 'block.admin.inc',
'render element' => 'form',
),
Dries Buytaert
committed
);
}
/**
* Implements hook_forms().
*/
function dashboard_forms() {
// Reroute the dashboard configuration form to the main blocks administration
// form. This allows us to distinguish them by form ID in hook_form_alter().
$forms['dashboard_admin_display_form'] = array(
'callback' => 'block_admin_display_form',
);
return $forms;
}
Dries Buytaert
committed
/**
* Dashboard page callback.
*
* @param $launch_customize
* Whether to launch in customization mode right away. TRUE or FALSE.
*/
function dashboard_admin($launch_customize = FALSE) {
Dries Buytaert
committed
$js_settings = array(
'dashboard' => array(
'drawer' => url('admin/dashboard/drawer'),
'blockContent' => url('admin/dashboard/block-content'),
'updatePath' => url('admin/dashboard/update'),
'formToken' => drupal_get_token('dashboard-update'),
'launchCustomize' => $launch_customize,
'dashboard' => url('admin/dashboard'),
Angie Byron
committed
'emptyBlockText' => t('(empty)'),
Angie Byron
committed
'emptyRegionTextInactive' => t('This dashboard region is empty. Click <em>Customize dashboard</em> to add blocks to it.'),
Angie Byron
committed
'emptyRegionTextActive' => t('DRAG HERE'),
Dries Buytaert
committed
),
);
$build = array(
'#theme' => 'dashboard_admin',
Dries Buytaert
committed
'#message' => t('To customize the dashboard page, move blocks to the dashboard regions on the <a href="@dashboard">Dashboard administration page</a>, or enable JavaScript on this page to use the drag-and-drop interface.', array('@dashboard' => url('admin/dashboard/configure'))),
Dries Buytaert
committed
'#access' => user_access('administer blocks'),
'#attached' => array(
'js' => array(
drupal_get_path('module', 'dashboard') . '/dashboard.js',
array('data' => $js_settings, 'type' => 'setting'),
Dries Buytaert
committed
),
Dries Buytaert
committed
'library' => array(array('system', 'ui.sortable')),
),
);
return $build;
Dries Buytaert
committed
}
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/**
* Menu page callback: builds the page for administering dashboard blocks.
*
* This page reuses the Block module's administration form but limits editing
* to blocks that are available to appear on the dashboard.
*
* @see block_admin_display()
* @see block_admin_display_form()
* @see dashboard_form_dashboard_admin_display_form_alter()
* @see template_preprocess_dashboard_admin_display_form()
*/
function dashboard_admin_blocks() {
global $theme_key;
drupal_theme_initialize();
module_load_include('inc', 'block', 'block.admin');
// Prepare the blocks for the current theme, and remove those that are
// currently displayed in non-dashboard regions.
// @todo This assumes the current page is being displayed using the same
// theme that the dashboard is displayed in.
$blocks = block_admin_display_prepare_blocks($theme_key);
$dashboard_regions = dashboard_region_descriptions();
$regions_to_remove = array_diff_key(system_region_list($theme_key, REGIONS_VISIBLE), $dashboard_regions);
foreach ($blocks as $id => $block) {
if (isset($regions_to_remove[$block['region']])) {
unset($blocks[$id]);
}
}
// Pass in the above blocks and dashboard regions to the form, so that only
// dashboard-related regions will be displayed.
return drupal_get_form('dashboard_admin_display_form', $blocks, $theme_key, $dashboard_regions);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
Angie Byron
committed
function dashboard_form_block_admin_display_form_alter(&$form, &$form_state, $form_id) {
// Hide dashboard regions (and any blocks placed within them) from the block
Angie Byron
committed
// administration form and from the options list on that form. This
// function is called for both the dashboard block configuration form and the
// standard block configuration form so that both forms can share the same
// constructor. As a result the form_id must be checked.
if ($form_id != 'dashboard_admin_display_form') {
$dashboard_regions = dashboard_region_descriptions();
$form['block_regions']['#value'] = array_diff_key($form['block_regions']['#value'], $dashboard_regions);
foreach (element_children($form['blocks']) as $i) {
$block = &$form['blocks'][$i];
Angie Byron
committed
if (isset($block['region']['#default_value']) && isset($dashboard_regions[$block['region']['#default_value']]) && $block['region']['#default_value'] != 'dashboard_inactive') {
Angie Byron
committed
$block['#access'] = FALSE;
}
elseif (isset($block['region']['#options'])) {
$block['region']['#options'] = array_diff_key($block['region']['#options'], $dashboard_regions);
}
Angie Byron
committed
// Show inactive dashboard blocks as disabled on the main block
// administration form, so that they are available to place in other
// regions of the theme. Note that when the form is submitted, any such
// blocks which still remain disabled will immediately be put back in the
// 'dashboard_inactive' region, because dashboard_block_info_alter() is
// called when the blocks are rehashed. Fortunately, this is the exact
// behavior we want.
if ($block['region']['#default_value'] == 'dashboard_inactive') {
// @todo These do not wind up in correct alphabetical order.
$block['region']['#default_value'] = NULL;
}
}
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function dashboard_form_dashboard_admin_display_form_alter(&$form, &$form_state) {
// Redirect the 'configure' and 'delete' links on each block back to the
// dashboard blocks administration page.
foreach ($form['blocks'] as &$block) {
if (isset($block['configure']['#href'])) {
Dries Buytaert
committed
$block['configure']['#options']['query']['destination'] = 'admin/dashboard/configure';
}
if (isset($block['delete']['#href'])) {
Dries Buytaert
committed
$block['delete']['#options']['query']['destination'] = 'admin/dashboard/configure';
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
}
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function dashboard_form_block_admin_configure_alter(&$form, &$form_state) {
global $theme_key;
drupal_theme_initialize();
// Hide the dashboard regions from the region select list on the block
// configuration form, for all themes except the current theme (since the
// other themes do not display the dashboard).
// @todo This assumes the current page is being displayed using the same
// theme that the dashboard is displayed in.
$dashboard_regions = dashboard_region_descriptions();
foreach (element_children($form['regions']) as $region_name) {
$region = &$form['regions'][$region_name];
if ($region_name != $theme_key && isset($region['#options'])) {
$region['#options'] = array_diff_key($region['#options'], $dashboard_regions);
}
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function dashboard_form_block_add_block_form_alter(&$form, &$form_state) {
dashboard_form_block_admin_configure_alter($form, $form_state);
}
/**
* Preprocesses variables for block-admin-display-form.tpl.php.
*/
function template_preprocess_dashboard_admin_display_form(&$variables) {
template_preprocess_block_admin_display_form($variables);
Angie Byron
committed
if (isset($variables['block_regions'][BLOCK_REGION_NONE])) {
$variables['block_regions'][BLOCK_REGION_NONE] = t('Other blocks');
}
}
Dries Buytaert
committed
/**
Angie Byron
committed
* Determines if the dashboard should be displayed on the current page.
*
* This function checks if the user is currently viewing the dashboard and has
* access to see it. It is used by other functions in the dashboard module to
* decide whether or not the dashboard content should be displayed to the
* current user.
*
* Although the menu system normally handles the above tasks, it only does so
* for the main page content. However, the dashboard is not part of the main
* page content, but rather is displayed in special regions of the page (so it
* can interface with the Block module's method of managing page regions). We
* therefore need to maintain this separate function to check the menu item for
* us.
*
* @return
* TRUE if the dashboard should be visible on the current page, FALSE
* otherwise.
*
* @see dashboard_block_list_alter()
* @see dashboard_page_build()
Dries Buytaert
committed
*/
function dashboard_is_visible() {
Dries Buytaert
committed
static $is_visible;
if (!isset($is_visible)) {
Angie Byron
committed
// If the current menu item represents the page on which we want to display
// the dashboard, and if the current user has access to see it, return
// TRUE.
Dries Buytaert
committed
$menu_item = menu_get_item();
Angie Byron
committed
$is_visible = isset($menu_item['page_callback']) && $menu_item['page_callback'] == 'dashboard_admin' && !empty($menu_item['access']);
Dries Buytaert
committed
}
return $is_visible;
Dries Buytaert
committed
}
/**
* Return an array of dashboard region descriptions, keyed by region name.
*/
function dashboard_region_descriptions() {
Dries Buytaert
committed
$regions = module_invoke_all('dashboard_regions');
drupal_alter('dashboard_regions', $regions);
return $regions;
Dries Buytaert
committed
}
/**
* Return an array of dashboard region names.
*/
function dashboard_regions() {
Angie Byron
committed
$regions = &drupal_static(__FUNCTION__);
Dries Buytaert
committed
if (!isset($regions)) {
$regions = array_keys(dashboard_region_descriptions());
}
return $regions;
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_dashboard_regions().
Dries Buytaert
committed
*/
function dashboard_dashboard_regions() {
return array(
Angie Byron
committed
'dashboard_main' => 'Dashboard (main)',
'dashboard_sidebar' => 'Dashboard (sidebar)',
'dashboard_inactive' => 'Dashboard (inactive)',
Dries Buytaert
committed
);
}
Dries Buytaert
committed
/**
* Ajax callback to show disabled blocks in the dashboard customization mode.
Dries Buytaert
committed
*/
function dashboard_show_disabled() {
global $theme_key;
// Blocks are not necessarily initialized at this point.
$blocks = _block_rehash();
Angie Byron
committed
// Limit the list to blocks that are marked as disabled for the dashboard.
Dries Buytaert
committed
foreach ($blocks as $key => $block) {
Angie Byron
committed
if ($block['theme'] != $theme_key || $block['region'] != 'dashboard_inactive') {
Dries Buytaert
committed
unset($blocks[$key]);
}
}
// Theme the output and end the page request.
print theme('dashboard_disabled_blocks', array('blocks' => $blocks));
Dries Buytaert
committed
drupal_exit();
Dries Buytaert
committed
}
/**
* Ajax callback to display the rendered contents of a specific block.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @param $module
* The block's module name.
Dries Buytaert
committed
* @param $delta
Dries Buytaert
committed
* The block's delta.
*/
function dashboard_show_block_content($module, $delta) {
drupal_theme_initialize();
global $theme_key;
$blocks = array();
$block_object = db_query("SELECT * FROM {block} WHERE theme = :theme AND module = :module AND delta = :delta", array(
":theme" => $theme_key,
":module" => $module,
":delta" => $delta,
))
->fetchObject();
$block_object->enabled = $block_object->page_match = TRUE;
$blocks[$module . "_" . $delta] = $block_object;
$block_content = _block_render_blocks($blocks);
$build = _block_get_renderable_array($block_content);
$rendered_block = drupal_render($build);
print $rendered_block;
Dries Buytaert
committed
drupal_exit();
Dries Buytaert
committed
}
/**
* Set the new weight of each region according to the drag-and-drop order.
*/
function dashboard_update() {
drupal_theme_initialize();
global $theme_key;
// Check the form token to make sure we have a valid request.
if (!empty($_REQUEST['form_token']) && drupal_valid_token($_REQUEST['form_token'], 'dashboard-update')) {
parse_str($_REQUEST['regions'], $regions);
foreach ($regions as $region_name => $blocks) {
if ($region_name == 'disabled_blocks') {
Angie Byron
committed
$region_name = 'dashboard_inactive';
Dries Buytaert
committed
}
foreach ($blocks as $weight => $block_string) {
// Parse the query string to determine the block's module and delta.
preg_match('/block-([^-]+)-(.+)/', $block_string, $matches);
Dries Buytaert
committed
$block = new stdClass();
Dries Buytaert
committed
$block->module = $matches[1];
$block->delta = $matches[2];
$block->region = $region_name;
$block->weight = $weight;
Angie Byron
committed
$block->status = 1;
Dries Buytaert
committed
db_merge('block')
->key(array(
'module' => $block->module,
'delta' => $block->delta,
'theme' => $theme_key,
))
->fields(array(
'status' => $block->status,
'weight' => $block->weight,
'region' => $block->region,
'pages' => '',
))
->execute();
}
}
Dries Buytaert
committed
drupal_set_message(t('The configuration options have been saved.'), 'status', FALSE);
Dries Buytaert
committed
}
Dries Buytaert
committed
drupal_exit();
Dries Buytaert
committed
}
/**
* Returns HTML for the entire dashboard.
Dries Buytaert
committed
*
* @param $variables
* An associative array containing:
* - element: A render element containing the properties of the dashboard
* region element, #dashboard_region and #children.
Dries Buytaert
committed
*
* @ingroup themeable
*/
function theme_dashboard($variables) {
extract($variables);
drupal_add_css(drupal_get_path('module', 'dashboard') . '/dashboard.css');
Dries Buytaert
committed
return '<div id="dashboard" class="clearfix">' . $element['#children'] . '</div>';
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
* Returns HTML for the non-customizable part of the dashboard page.
Dries Buytaert
committed
*
* @param $variables
* An associative array containing:
* - element: A render element containing a #message.
Dries Buytaert
committed
*
* @ingroup themeable
*/
function theme_dashboard_admin($variables) {
// We only return a simple help message, since the actual content of the page
// will be populated via the dashboard regions in dashboard_page_build().
return '<div class="customize-dashboard js-hide">' . $variables['element']['#message'] . '</div>';
}
Dries Buytaert
committed
/**
* Returns HTML for a generic dashboard region.
Dries Buytaert
committed
*
* @param $variables
* An associative array containing:
* - element: A render element containing the properties of the dashboard
* region element, #dashboard_region and #children.
Dries Buytaert
committed
*
* @ingroup themeable
*/
function theme_dashboard_region($variables) {
extract($variables);
$output = '<div id="' . $element['#dashboard_region'] . '" class="dashboard-region">';
Dries Buytaert
committed
$output .= '<div class="region clearfix">';
Dries Buytaert
committed
$output .= $element['#children'];
Dries Buytaert
committed
// Closing div.region
$output .= '</div>';
// Closing div.dashboard-region
Dries Buytaert
committed
$output .= '</div>';
return $output;
}
/**
* Returns HTML for a set of disabled blocks, for display in dashboard customization mode.
Dries Buytaert
committed
*
* @param $variables
* An associative array containing:
Dries Buytaert
committed
* - blocks: An array of block objects from _block_rehash().
*
* @ingroup themeable
*/
function theme_dashboard_disabled_blocks($variables) {
extract($variables);
Dries Buytaert
committed
$output = '<div class="canvas-content"><p>' . t('Drag and drop these blocks to the columns below. Changes are automatically saved. More options are available on the <a href="@dashboard-url">configuration page</a>.', array('@dashboard-url' => url('admin/dashboard/configure'))) . '</p>';
Dries Buytaert
committed
$output .= '<div id="disabled-blocks"><div class="region disabled-blocks clearfix">';
Dries Buytaert
committed
foreach ($blocks as $block) {
$output .= theme('dashboard_disabled_block', array('block' => $block));
}
Angie Byron
committed
$output .= '<div class="clearfix"></div>';
$output .= '<p class="dashboard-add-other-blocks">' . l(t('Add other blocks'), 'admin/dashboard/configure') . '</p>';
Dries Buytaert
committed
$output .= '</div></div></div>';
return $output;
}
/**
* Returns HTML for a disabled block, for display in dashboard customization mode.
Dries Buytaert
committed
*
* @param $variables
* An associative array containing:
Dries Buytaert
committed
* - block: A block object from _block_rehash().
*
* @ingroup themeable
*/
function theme_dashboard_disabled_block($variables) {
extract($variables);
$output = "";
if (isset($block)) {
$output .= '<div id="block-' . $block['module'] . '-' . $block['delta']
. '" class="disabled-block block block-' . $block['module'] . '-' . $block['delta']
Angie Byron
committed
. ' module-' . $block['module'] . ' delta-' . $block['delta'] . '">'
. '<h2>' . (!empty($block['title']) && $block['title'] != '<none>' ? check_plain($block['title']) : check_plain($block['info'])) . '</h2>'
Dries Buytaert
committed
. '<div class="content"></div>'
. '</div>';
}
return $output;
}