Commit 66f740c5 authored by Dries's avatar Dries

- Patch #626286 by sun, David_Rothstein, Rob Loach: make contextual links a module.

parent 882fa0ab
......@@ -1854,7 +1854,7 @@ function menu_local_tasks($level = 0) {
* @return
* A list of menu router items that are local tasks for the passed in path.
*
* @see system_preprocess()
* @see contextual_links_preprocess()
*/
function menu_contextual_links($module, $parent_path, $args) {
static $path_empty = array();
......
......@@ -38,7 +38,7 @@
?>
<div id="block-<?php print $block->module . '-' . $block->delta; ?>" class="<?php print $classes; ?>"<?php print $attributes; ?>>
<?php if ($contextual_links): ?>
<?php if (!empty($contextual_links)): ?>
<?php print render($contextual_links); ?>
<?php endif; ?>
......
......@@ -26,7 +26,7 @@ html.js div.contextual-links-wrapper {
display: block;
}
a.contextual-links-trigger {
background: transparent url(cog-select.png) no-repeat center center;
background: transparent url(images/cog-select.png) no-repeat center center;
display: none;
height: 20px;
margin-top: 2px;
......
; $Id$
name = Contextual links
description = Provides contextual links to perform actions related to elements on a page.
package = Core
version = VERSION
core = 7.x
files[] = contextual.module
<?php
// $Id$
/**
* @file
* Adds contextual links to perform actions related to elements on a page.
*/
/**
* Implements hook_permission().
*/
function contextual_permission() {
return array(
'access contextual links' => array(
'title' => t('Use contextual links'),
'description' => t('Use contextual links to perform actions related to elements on a page.'),
),
);
}
/**
* Implements hook_library().
*/
function contextual_library() {
$path = drupal_get_path('module', 'contextual');
$libraries['contextual-links'] = array(
'title' => 'Contextual links',
'website' => 'http://drupal.org/node/473268',
'version' => '1.0',
'js' => array(
$path . '/contextual.js' => array(),
),
'css' => array(
$path . '/contextual.css' => array(),
),
);
return $libraries;
}
/**
* Template variable preprocessor for contextual links.
*
* @see contextual_links_build()
*/
function contextual_preprocess(&$variables, $hook) {
static $hooks;
// Initialize the $contextual_links template variable.
$variables['contextual_links'] = array();
// Nothing to do here if the user is not permitted to access contextual links.
if (!user_access('access contextual links')) {
return;
}
if (!isset($hooks)) {
$hooks = theme_get_registry();
}
// Determine the primary theme function argument.
if (isset($hooks[$hook]['variables'])) {
$keys = array_keys($hooks[$hook]['variables']);
$key = $keys[0];
}
else {
$key = $hooks[$hook]['render element'];
}
if (isset($variables[$key])) {
$element = $variables[$key];
}
if (isset($element) && is_array($element) && !empty($element['#contextual_links'])) {
$variables['contextual_links'] = contextual_links_build($element);
if (!empty($variables['contextual_links'])) {
$variables['classes_array'][] = 'contextual-links-region';
}
}
}
/**
* Build a renderable array for contextual links.
*
* @param $element
* A renderable array containing a #contextual_links property, which is a
* keyed array. Each key is the name of the implementing module, and each
* value is an array that forms the function arguments for
* menu_contextual_links(). For example:
* @code
* array('#contextual_links' => array(
* 'block' => array('admin/structure/block/manage', array('system', 'navigation')),
* 'menu' => array('admin/structure/menu/manage', array('navigation')),
* ))
* @endcode
*
* @return
* A renderable array representing contextual links.
*
* @see menu_contextual_links()
*/
function contextual_links_build($element) {
static $destination;
// Retrieve contextual menu links.
$items = array();
foreach ($element['#contextual_links'] as $module => $args) {
$items += menu_contextual_links($module, $args[0], $args[1]);
}
// Transform contextual links into parameters suitable for theme_link().
if (!isset($destination)) {
$destination = drupal_get_destination();
}
$links = array();
foreach ($items as $class => $item) {
$class = drupal_html_class($class);
$links[$class] = array(
'title' => $item['title'],
'href' => $item['href'],
);
// @todo theme_links() should *really* use the same parameters as l()...
if (!isset($item['localized_options']['query'])) {
$item['localized_options']['query'] = array();
}
$item['localized_options']['query'] += $destination;
$links[$class] += $item['localized_options'];
}
$build = array();
if ($links) {
$build = array(
'#prefix' => '<div class="contextual-links-wrapper">',
'#suffix' => '</div>',
'#theme' => 'links',
'#links' => $links,
'#attributes' => array('class' => array('contextual-links')),
'#attached' => array(
'library' => array(array('contextual', 'contextual-links')),
),
);
}
return $build;
}
......@@ -75,7 +75,7 @@
<?php print $user_picture; ?>
<?php if (!$page && $contextual_links): ?>
<?php if (!$page && !empty($contextual_links)): ?>
<?php print render($contextual_links); ?>
<?php endif; ?>
......
......@@ -226,10 +226,6 @@ function system_permission() {
'access administration pages' => array(
'title' => t('Use the administration pages and help'),
),
'access contextual links' => array(
'title' => t('Use contextual links'),
'description' => t('Use contextual links to perform actions related to elements on a page.'),
),
'access site in maintenance mode' => array(
'title' => t('Use the site in maintenance mode'),
),
......@@ -1102,19 +1098,6 @@ function system_library() {
),
);
// Contextual links.
$libraries['contextual-links'] = array(
'title' => 'Contextual links',
'website' => 'http://drupal.org/node/473268',
'version' => '1.0',
'js' => array(
'misc/contextual_links.js' => array(),
),
'css' => array(
'misc/contextual_links.css' => array(),
),
);
// Vertical Tabs.
$libraries['vertical-tabs'] = array(
'title' => 'Vertical Tabs',
......@@ -3579,110 +3562,6 @@ function theme_system_settings_form($variables) {
return drupal_render_children($variables['form']);
}
/**
* Template variable preprocessor for contextual links.
*
* @see system_build_contextual_links()
*/
function system_preprocess(&$variables, $hook) {
static $hooks;
// Initialize the $contextual_links template variable.
$variables['contextual_links'] = array();
// Nothing to do here if the user is not permitted to access contextual links.
if (!user_access('access contextual links')) {
return;
}
if (!isset($hooks)) {
$hooks = theme_get_registry();
}
// Determine the primary theme function argument.
if (isset($hooks[$hook]['variables'])) {
$keys = array_keys($hooks[$hook]['variables']);
$key = $keys[0];
}
else {
$key = $hooks[$hook]['render element'];
}
if (isset($variables[$key])) {
$element = $variables[$key];
}
if (isset($element) && is_array($element) && !empty($element['#contextual_links'])) {
$variables['contextual_links'] = system_build_contextual_links($element);
if (!empty($variables['contextual_links'])) {
$variables['classes_array'][] = 'contextual-links-region';
}
}
}
/**
* Build a renderable array for contextual links.
*
* @param $element
* A renderable array containing a #contextual_links property, which is a
* keyed array. Each key is the name of the implementing module, and each
* value is an array that forms the function arguments for
* menu_contextual_links(). For example:
* @code
* array('#contextual_links' => array(
* 'block' => array('admin/structure/block/manage', array('system', 'navigation')),
* 'menu' => array('admin/structure/menu/manage', array('navigation')),
* ))
* @endcode
*
* @return
* A renderable array representing contextual links.
*
* @see menu_contextual_links()
*/
function system_build_contextual_links($element) {
static $destination;
// Retrieve contextual menu links.
$items = array();
foreach ($element['#contextual_links'] as $module => $args) {
$items += menu_contextual_links($module, $args[0], $args[1]);
}
// Transform contextual links into parameters suitable for theme_link().
if (!isset($destination)) {
$destination = drupal_get_destination();
}
$links = array();
foreach ($items as $class => $item) {
$class = drupal_html_class($class);
$links[$class] = array(
'title' => $item['title'],
'href' => $item['href'],
);
// @todo theme_links() should *really* use the same parameters as l()...
if (!isset($item['localized_options']['query'])) {
$item['localized_options']['query'] = array();
}
$item['localized_options']['query'] += $destination;
$links[$class] += $item['localized_options'];
}
$build = array();
if ($links) {
$build = array(
'#prefix' => '<div class="contextual-links-wrapper">',
'#suffix' => '</div>',
'#theme' => 'links',
'#links' => $links,
'#attributes' => array('class' => array('contextual-links')),
'#attached' => array(
'library' => array(array('system', 'contextual-links')),
),
);
}
return $build;
}
/**
* Implements hook_admin_paths().
*/
......
......@@ -6,6 +6,7 @@ core = 7.x
dependencies[] = block
dependencies[] = color
dependencies[] = comment
dependencies[] = contextual
dependencies[] = dashboard
dependencies[] = help
dependencies[] = image
......
......@@ -3,7 +3,7 @@
?>
<div id="block-<?php print $block->module . '-' . $block->delta; ?>" class="<?php print $classes; ?> clearfix"<?php print $attributes; ?>>
<?php if ($contextual_links): ?>
<?php if (!empty($contextual_links)): ?>
<?php print render($contextual_links); ?>
<?php endif; ?>
......
......@@ -3,7 +3,7 @@
?>
<div id="node-<?php print $node->nid; ?>" class="<?php print $classes; ?>"<?php print $attributes; ?>>
<?php if (!$page && $contextual_links): ?>
<?php if (!$page && !empty($contextual_links)): ?>
<?php print render($contextual_links); ?>
<?php endif; ?>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment