drupal/modules/simpletest/tests/menu_test.module

316 lines
9.4 KiB
Plaintext

<?php
// $Id$
/**
* @file
* Dummy module implementing hook menu.
*/
/**
* Implements hook_menu().
*/
function menu_test_menu() {
// The name of the menu changes during the course of the test. Using a $_GET.
$items['menu_name_test'] = array(
'title' => 'Test menu_name router item',
'page callback' => 'node_save',
'menu_name' => menu_test_menu_name(),
);
// Use FALSE as 'title callback' to bypass t().
$items['menu_no_title_callback'] = array(
'title' => 'A title with @placeholder',
'title callback' => FALSE,
'title arguments' => array('@placeholder' => 'some other text'),
'page callback' => 'menu_test_callback',
'access arguments' => array('access content'),
);
// Hidden link for menu_link_maintain tests
$items['menu_test_maintain/%'] = array(
'title' => 'Menu maintain test',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
// Hierarchical tests.
$items['menu-test/hierarchy/parent'] = array(
'title' => 'Parent menu router',
'page callback' => 'node_page_default',
);
$items['menu-test/hierarchy/parent/child'] = array(
'title' => 'Child menu router',
'page callback' => 'node_page_default',
);
$items['menu-test/hierarchy/parent/child2/child'] = array(
'title' => 'Unattached subchild router',
'page callback' => 'node_page_default',
);
// Theme callback tests.
$items['menu-test/theme-callback/%'] = array(
'title' => 'Page that displays different themes',
'page callback' => 'menu_test_theme_page_callback',
'access arguments' => array('access content'),
'theme callback' => 'menu_test_theme_callback',
'theme arguments' => array(2),
);
$items['menu-test/theme-callback/%/inheritance'] = array(
'title' => 'Page that tests theme callback inheritance.',
'page callback' => 'menu_test_theme_page_callback',
'page arguments' => array(TRUE),
'access arguments' => array('access content'),
);
// Path containing "exotic" characters.
$path = "menu-test/ -._~!$'\"()*@[]?&+%#,;=:" . // "Special" ASCII characters.
"%23%25%26%2B%2F%3F" . // Characters that look like a percent-escaped string.
"éøïвβ中國書۞"; // Characters from various non-ASCII alphabets.
$items[$path] = array(
'title' => '"Exotic" path',
'page callback' => 'menu_test_callback',
'access arguments' => array('access content'),
);
// Hidden tests; base parents.
// Same structure as in Menu and Block modules. Since those structures can
// change, we need to simulate our own in here.
$items['menu-test'] = array(
'title' => 'Menu test root',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
$items['menu-test/hidden'] = array(
'title' => 'Menu test parent',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
// Hidden tests; one dynamic argument.
$items['menu-test/hidden/menu'] = array(
'title' => 'Menus',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
$items['menu-test/hidden/menu/list'] = array(
'title' => 'List menus',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['menu-test/hidden/menu/add'] = array(
'title' => 'Add menu',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_ACTION,
);
$items['menu-test/hidden/menu/settings'] = array(
'title' => 'Settings',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK,
'weight' => 5,
);
$items['menu-test/hidden/menu/manage/%menu'] = array(
'title' => 'Customize menu',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
$items['menu-test/hidden/menu/manage/%menu/list'] = array(
'title' => 'List links',
'weight' => -10,
'type' => MENU_DEFAULT_LOCAL_TASK,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
);
$items['menu-test/hidden/menu/manage/%menu/add'] = array(
'title' => 'Add link',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_ACTION,
);
$items['menu-test/hidden/menu/manage/%menu/edit'] = array(
'title' => 'Edit menu',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
);
$items['menu-test/hidden/menu/manage/%menu/delete'] = array(
'title' => 'Delete menu',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
);
// Hidden tests; two dynamic arguments.
$items['menu-test/hidden/block'] = array(
'title' => 'Blocks',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
$items['menu-test/hidden/block/list'] = array(
'title' => 'List',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['menu-test/hidden/block/add'] = array(
'title' => 'Add block',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_ACTION,
);
$items['menu-test/hidden/block/manage/%/%'] = array(
'title' => 'Configure block',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
);
$items['menu-test/hidden/block/manage/%/%/configure'] = array(
'title' => 'Configure block',
'type' => MENU_DEFAULT_LOCAL_TASK,
'context' => MENU_CONTEXT_INLINE,
);
$items['menu-test/hidden/block/manage/%/%/delete'] = array(
'title' => 'Delete block',
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_NONE,
);
return $items;
}
/**
* Dummy callback for hook_menu() to point to.
*
* @return
* A random string.
*/
function menu_test_callback() {
return 'This is menu_test_callback().';
}
/**
* Page callback to use when testing the theme callback functionality.
*
* @param $inherited
* An optional boolean to set to TRUE when the requested page is intended to
* inherit the theme of its parent.
* @return
* A string describing the requested custom theme and actual theme being used
* for the current page request.
*/
function menu_test_theme_page_callback($inherited = FALSE) {
global $theme_key;
// Initialize the theme system so that $theme_key will be populated.
drupal_theme_initialize();
// Now check both the requested custom theme and the actual theme being used.
$custom_theme = menu_get_custom_theme();
$requested_theme = empty($custom_theme) ? 'NONE' : $custom_theme;
$output = "Custom theme: $requested_theme. Actual theme: $theme_key.";
if ($inherited) {
$output .= ' Theme callback inheritance is being tested.';
}
return $output;
}
/**
* Theme callback to use when testing the theme callback functionality.
*
* @param $argument
* The argument passed in from the URL.
* @return
* The name of the custom theme to request for the current page.
*/
function menu_test_theme_callback($argument) {
// Test using the variable administrative theme.
if ($argument == 'use-admin-theme') {
return variable_get('admin_theme');
}
// Test using a theme that exists, but may or may not be enabled.
elseif ($argument == 'use-stark-theme') {
return 'stark';
}
// Test using a theme that does not exist.
elseif ($argument == 'use-fake-theme') {
return 'fake_theme';
}
// For any other value of the URL argument, do not return anything. This
// allows us to test that returning nothing from a theme callback function
// causes the page to correctly fall back on using the main site theme.
}
/**
* Implement hook_custom_theme().
*
* @return
* The name of the custom theme to use for the current page.
*/
function menu_test_custom_theme() {
// If an appropriate variable has been set in the database, request the theme
// that is stored there. Otherwise, do not attempt to dynamically set the
// theme.
if ($theme = variable_get('menu_test_hook_custom_theme_name', FALSE)) {
return $theme;
}
}
/**
* Helper function for the testMenuName() test. Used to change the menu_name
* parameter of a menu.
*
* @param $new_name
* If set, will change the menu_name value.
* @return
* The menu_name value to use.
*/
function menu_test_menu_name($new_name = '') {
static $name = 'original';
if ($new_name) {
$name = $new_name;
}
return $name;
}
/**
* Implements hook_menu_link_insert().
*
* @return
* A random string.
*/
function menu_test_menu_link_insert($item) {
menu_test_static_variable('insert');
}
/**
* Implements hook_menu_link_update().
*
* @return
* A random string.
*/
function menu_test_menu_link_update($item) {
menu_test_static_variable('update');
}
/**
* Implements hook_menu_link_delete().
*
* @return
* A random string.
*/
function menu_test_menu_link_delete($item) {
menu_test_static_variable('delete');
}
/**
* Static function for testing hook results.
*
* @param $value
* The value to set or NULL to return the current value.
* @return
* A text string for comparison to test assertions.
*/
function menu_test_static_variable($value = NULL) {
static $variable;
if (!empty($value)) {
$variable = $value;
}
return $variable;
}