custom_breadcrumbs.admin.inc in Custom Breadcrumbs 7.2
Same filename and directory in other branches
Admin page callback file for the custom_breadcrumbs module.
File
custom_breadcrumbs.admin.incView source
<?php
/**
* @file
* Admin page callback file for the custom_breadcrumbs module.
*/
/**
* Lists all current custom breadcrumbs and provides a link to the edit page.
*/
function custom_breadcrumbs_page() {
$custom_breadcrumbs_sort = variable_get('custom_breadcrumbs_sort', array(
'direction' => array(
'name' => 'asc',
'breadcrumb_type' => 'asc',
'language' => 'asc',
),
'column' => 'name',
));
$sort = $custom_breadcrumbs_sort['direction'];
$multilingual = _custom_breadcrumbs_multilingual();
$breadcrumbs = array();
// Read session variable to load breadcrumbs of type and language selected by
// user.
if (empty($_SESSION['custom_breadcrumbs_overview_filter'])) {
$breadcrumbs = _custom_breadcrumbs_load_all_breadcrumbs(TRUE);
}
else {
// Determine a list of selected languages, and a list of modules to load
// them from.
$modules = array();
$tables = array();
$languages = array();
foreach ($_SESSION['custom_breadcrumbs_overview_filter'] as $filter) {
if ($filter[0] == 'type') {
list($module, $table) = explode('-', $filter[1]);
$modules[] = $module;
$tables[] = $table;
}
elseif ($filter[0] == 'language') {
$languages[] = $filter[1];
}
}
if (empty($modules)) {
$modules = module_implements('cb_breadcrumb_info');
}
foreach ($modules as $key => $module) {
$more = custom_breadcrumbs_load_breadcrumbs($module, $tables[$key], NULL, $languages);
if (!empty($more)) {
$breadcrumbs = array_merge($breadcrumbs, $more);
}
}
}
// Sort the breadcrumbs according to $sort and $order.
$columns = array(
'name' => 'Name',
'breadcrumb_type' => 'Breadcrumb Type',
);
if ($multilingual) {
$columns['language'] = 'Language';
}
$order = isset($_GET['order']) && in_array($_GET['order'], array_keys($columns)) ? $_GET['order'] : 'name';
$sort[$order] = isset($_GET['sort']) && $_GET['sort'] == 'desc' ? 'desc' : 'asc';
variable_set('custom_breadcrumbs_sort', array(
'direction' => $sort,
'column' => $order,
));
usort($breadcrumbs, '_custom_breadcrumbs_sort_cmp');
// Make the breadcrumb list table sortable by name, type and language.
$path = 'admin/structure/custom_breadcrumbs';
$sort[$order] = $sort[$order] == 'asc' ? 'desc' : 'asc';
// Add an arrow indicating sort direction.
$image = array(
$order => theme('tablesort_indicator', array(
'style' => array(
'style' => $sort[$order],
),
)),
);
$headers = array();
foreach ($columns as $key => $title) {
$options = array(
'attributes' => array(
'title' => t('sort by @s', array(
'@s' => $title,
)),
),
);
$options['query'] = array(
'order' => $key,
'sort' => $sort[$key],
);
if (isset($image[$key])) {
$options['html'] = TRUE;
$title .= $image[$key];
}
$headers[] = array(
'data' => l($title, $path, $options),
);
}
$headers[] = t('Operations');
$rows = array();
foreach ($breadcrumbs as $breadcrumb) {
$row = array();
$name = $breadcrumb->name;
$type = $breadcrumb->breadcrumb_type;
$row['name'] = array(
'data' => $name . (!empty($breadcrumb->visibility_php) ? ' ' . t('with PHP snippet') : ''),
);
$row['breadcrumb_type'] = array(
'data' => $type,
);
if ($multilingual) {
$row['language'] = array(
'data' => module_invoke('locale', 'language_name', $breadcrumb->language),
);
}
$row['edit'] = l(t('edit'), $path . '/' . $breadcrumb->breadcrumb_type . '/edit/' . $breadcrumb->bid);
$row[$order]['class'] = 'active';
$rows[] = $row;
}
if (count($rows) == 0) {
$rows[] = array(
array(
'data' => t('No custom breadcrumbs have been defined.'),
'colspan' => 2 + (int) $multilingual,
),
);
}
// Prepare help text for this page. Not sure why this doesn't work in
// hook_help().
$output = '<p>' . t("To create a custom breadcrumb, choose one of the breadcrumb types listed above. The following table lists all of the custom breadcrumbs that have been defined. The list can be filtered by breadcrumb type or language, or sorted by clicking on one of the column headings.") . '</p>';
$output .= '<p>' . t('You can configure Custom Breadcrumb settings at <a href="@link">admin/config/user-interface/custom-breadcrumbs</a>.', array(
'@link' => url('admin/config/user-interface/custom-breadcrumbs'),
)) . '</p>';
$build = array();
$build['help_text'] = array(
'#markup' => $output,
);
$build['filter_form'] = drupal_get_form('custom_breadcrumbs_filter_form');
$build['breadcrumb_table'] = array(
'#markup' => theme('table', array(
'header' => $headers,
'rows' => $rows,
)),
);
return $build;
}
/**
* Sorts two custom_breadcrumbs objects by name, type, or language.
*
* Each column can be independently sorted as asc or desc.
*
* @param object $bc1
* First breadcrumb object.
* @param object $bc2
* Second breadcrumb object.
*
* @return int
* 0 if the two objects have equal ranking,
* 1 if the first object is greater than the second,
* -1 if the second object is greater than the first,
*/
function _custom_breadcrumbs_sort_cmp($bc1, $bc2) {
$custom_breadcrumbs_sort = variable_get('custom_breadcrumbs_sort', array(
'direction' => array(
'name' => 'asc',
'breadcrumb_type' => 'asc',
'language' => 'asc',
),
'column' => 'name',
));
$options = array(
'name',
'breadcrumb_type',
'language',
);
$first = $custom_breadcrumbs_sort['column'];
$keys = array_keys($options, $first);
$key = array_pop($keys);
unset($options[$key]);
// Reindex the array.
$options = array_values($options);
$sortdir = array();
foreach ($custom_breadcrumbs_sort['direction'] as $key => $sort) {
$sortdir[$key] = $sort == 'asc' ? 1 : -1;
}
if ($bc1->{$first} == $bc2->{$first}) {
if (!empty($bc1->{$options[0]}) && !empty($bc2->{$options[0]}) && $bc1->{$options[0]} == $bc2->{$options[0]}) {
if ($bc1->{$options[1]} == $bc2->{$options[1]}) {
return 0;
}
return $bc1->{$options[1]} > $bc2->{$options[1]} ? $sortdir[$options[1]] : -1 * $sortdir[$options[1]];
}
return $bc1->{$options[0]} > $bc2->{$options[0]} ? $sortdir[$options[0]] : -1 * $sortdir[$options[0]];
}
return $bc1->{$first} > $bc2->{$first} ? $sortdir[$first] : -1 * $sortdir[$first];
}
/**
* Form builder to edit a custom breadcrumb record.
*
* @param string $type
* The type of custom breadcrumb to edit.
*
* @ingroup forms
* @see custom_breadcrumbs_form_validate()
* @see custom_breadcrumbs_form_submit()
* @see custom_breadcrumbs_form_delete()
* @see custom_breadcrumbs_form_cancel()
*/
function custom_breadcrumbs_form($form, &$form_state, $type) {
$breadcrumb = NULL;
$bid = arg(5);
if (isset($bid)) {
drupal_set_title(t('Edit Custom Breadcrumb for Node'));
$breadcrumbs = custom_breadcrumbs_load_breadcrumbs('custom_breadcrumbs', NULL, array(
'bid' => $bid,
));
$breadcrumb = array_pop($breadcrumbs);
}
else {
drupal_set_title(t('Add Custom Breadcrumb for Node'));
}
$options = array();
foreach (node_type_get_names() as $type => $name) {
$options[$type] = $name;
}
$form['node_type'] = array(
'#type' => 'select',
'#title' => t('Node type'),
'#required' => TRUE,
'#options' => $options,
'#description' => t('The node type this custom breadcrumb trail will apply to.'),
'#default_value' => isset($breadcrumb->node_type) ? $breadcrumb->node_type : NULL,
'#weight' => -10,
);
// Store information needed to save this breadcrumb.
$form['#module'] = 'custom_breadcrumbs';
$form['#infokey'] = 'node';
$form += custom_breadcrumbs_common_form_elements($bid, $breadcrumb);
return $form;
}
/**
* Form validation handler for custom_breadcrumbs_form().
*
* @see custom_breadcrumbs_form()
* @see custom_breadcrumbs_form_submit()
*/
function custom_breadcrumbs_form_validate($form, &$form_state) {
// Check to make sure there are an equal number of paths and titles.
$check = TRUE;
if (!user_access('use php in custom breadcrumbs') || !variable_get('custom_breadcrumbs_use_php_in_titles', FALSE)) {
// Strip any PHP tags from paths and titles since they are not allowed.
$elements = array(
'titles',
'paths',
);
foreach ($elements as $element) {
if (strpos($form_state['values'][$element], '<?php') !== FALSE) {
$form_state['values'][$element] = str_replace(array(
'<?php',
'?>',
), '', $form_state['values'][$element]);
form_set_error($element, t('Use of PHP in !element is not permitted and will be filtered out.', array(
'!element' => $element,
)));
}
}
}
else {
// If PHP is used, don't validate number of paths and titles.
if (strpos($form_state['values']['titles'], '<?php') !== FALSE || strpos($form_state['values']['paths'], '<?php') !== FALSE) {
$check = FALSE;
}
}
if ($check) {
$path_count = count(explode("\n", trim($form_state['values']['paths'])));
$title_count = count(explode("\n", trim($form_state['values']['titles'])));
if ($title_count != $path_count) {
$error_field = $title_count < $path_count ? 'titles' : 'paths';
form_set_error($error_field, t('Every link path must have a matching title. There are !paths paths, and !titles titles.', array(
'!paths' => $path_count,
'!titles' => $title_count,
)));
}
}
}
/**
* Form submission handler for custom_breadcrumbs_form().
*
* @see custom_breadcrumbs_form()
* @see custom_breadcrumbs_form_validate()
*/
function custom_breadcrumbs_form_submit($form, &$form_state) {
$breadcrumb = (object) $form_state['values'];
_custom_breadcrumbs_save_breadcrumb($form['#module'], $form['#infokey'], $breadcrumb);
$form_state['redirect'] = 'admin/structure/custom_breadcrumbs';
}
/**
* Form delete.
*/
function custom_breadcrumbs_form_delete($form, &$form_state) {
_custom_breadcrumbs_delete_breadcrumb($form['#module'], $form['#infokey'], $form_state['values']['bid']);
$form_state['redirect'] = 'admin/structure/custom_breadcrumbs';
}
/**
* Form disable.
*/
function custom_breadcrumbs_form_cancel($form, &$form_state) {
$form_state['redirect'] = 'admin/structure/custom_breadcrumbs';
}
/**
* Provides form elements commonly used by custom breadcrumbs submodules.
*
* @param string $bid
* The breadcrumb id.
* @param object $breadcrumb
* The breadcrumb object.
*
* @return form
* A form array with common custom breadcrumb elements.
*/
function custom_breadcrumbs_common_form_elements($bid, $breadcrumb) {
// TODO: consider removing the $bid parameter since its part of the breadcrumb
// object.
// TODO: or should $breadcrumb default to NULL?
$form = array();
$form['bid'] = array(
'#type' => 'hidden',
'#value' => $bid,
);
$form['name'] = array(
'#type' => 'textfield',
'#title' => t('Breadcrumb Name'),
'#default_value' => isset($breadcrumb->name) ? $breadcrumb->name : '',
'#description' => t('This name will only appear when listing custom breadcrumbs. If left blank, a name for this breadcrumb will be generated for you.'),
'#weight' => -50,
);
if (isset($breadcrumb)) {
$cbid = custom_breadcrumbs_unique_breadcrumb_id($breadcrumb->breadcrumb_type, $breadcrumb->bid);
}
if (isset($cbid)) {
$form['classid'] = array(
'#markup' => '<strong>' . t('The CSS class name for this breadcrumb is !name', array(
'!name' => $cbid,
)) . '</strong>',
);
}
$multilingual = _custom_breadcrumbs_multilingual();
if ($multilingual) {
$form['language'] = array(
'#type' => 'select',
'#title' => t('Language'),
'#options' => array(
'' => t('All languages'),
) + locale_language_list('name'),
'#default_value' => isset($breadcrumb->language) ? $breadcrumb->language : NULL,
'#description' => t('A breadcrumb set for a specific language will always be used when displaying a node in that language, and takes precedence over breadcrumbs set for <em>All languages</em>.'),
);
}
else {
$form['language'] = array(
'#type' => 'value',
'#value' => '',
);
}
$form['visibility_php'] = array(
'#type' => 'textarea',
'#title' => t('Breadcrumb visibility'),
'#access' => user_access('use php in custom breadcrumbs'),
'#description' => t('Determine whether this breadcrumb should be displayed by using a PHP snippet to return TRUE or FALSE. Note that this code has access to the $node variable, and can check its type or any other property. Do not use opening and closing php tags.'),
'#default_value' => isset($breadcrumb->visibility_php) ? $breadcrumb->visibility_php : '',
);
$description = t('A list of titles for the breadcrumb links, one on each line. For each crumb title you can also specify a title attribute to add to the link. Separate the crumb title and the title attribute with a pipe (|) symbol.');
if (variable_get('custom_breadcrumbs_use_php_in_titles', FALSE) && user_access('use php in custom breadcrumbs')) {
$description .= ' ' . t("Or, you can enter a small PHP code snippet (less than 250 characters) returning either an array of text strings for the breadcrumb titles, with one title per array element, or an associative array with elements 'titles' and 'paths' each containing an array of text strings for the breadcrumb titles and paths, respectively. Include the snippet between %php. Use with caution since incorrect PHP code can break your Drupal site. Token replacement will occur after any PHP is evaluated.", array(
'%php' => '<?php ?>',
));
}
$form['titles'] = array(
'#type' => 'textarea',
'#title' => t('Titles'),
'#required' => TRUE,
'#description' => $description,
'#default_value' => isset($breadcrumb->titles) ? $breadcrumb->titles : NULL,
);
$description = t('A list of Drupal paths for the breadcrumb links, one on each line.');
if (variable_get('custom_breadcrumbs_use_php_in_titles', FALSE) && user_access('use php in custom breadcrumbs')) {
$description .= ' ' . t("You can also enter a small PHP code snippet (less than 250 characters) returning an array of drupal paths for the breadcrumb links, with one path per array element. Include the snippet between %php. Use with caution since incorrect PHP code can break your Drupal site. Token replacement will occur after any PHP is evaluated.", array(
'%php' => '<?php ?>',
));
}
$form['paths'] = array(
'#type' => 'textarea',
'#title' => t('Paths'),
'#required' => FALSE,
'#description' => $description,
'#default_value' => isset($breadcrumb->paths) ? $breadcrumb->paths : NULL,
);
$form['help'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Placeholder tokens'),
'#description' => t("The following placeholder tokens can be used in both paths and titles. When used in a path or title, they will be replaced with the appropriate values."),
);
if (module_exists('token')) {
$form['help']['tokens'] = array(
'#theme' => 'token_tree_link',
'#token_types' => array(
'node',
),
);
}
else {
$form['help']['#description'] = t("Core tokens can be used as dynamic placeholder tokens in your breadcrumb trails. To view a list of available tokens here, download and install the <a href='@token'>Token module</a> from Drupal.org.", array(
'@token' => 'http://www.drupal.org/project/token',
));
$form['help']['#collapsible'] = FALSE;
$form['help']['#collapsed'] = FALSE;
}
$form['help2'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#title' => t('Special identifiers'),
'#description' => t("The following identifiers can be used to achieve a special behavior. Identifiers should be added to the paths area in the following format: identifier|path.<br />For example: %pathauto_id|[ogname-raw]", array(
'%pathauto_id' => '<pathauto>',
)),
);
$form['help2']['tokens'] = array(
'#markup' => theme('custom_breadcrumbs_help_identifiers'),
);
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
if (isset($bid)) {
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete'),
'#submit' => array(
'custom_breadcrumbs_form_delete',
),
);
}
$form['actions']['cancel'] = array(
'#type' => 'submit',
'#value' => t('Cancel'),
'#submit' => array(
'custom_breadcrumbs_form_cancel',
),
);
return $form;
}
/**
* Admin Settings.
*
* Form builder; Configure basic and advanced custom breadcrumbs settings for
* this site.
*
* @ingroup forms
* @see system_settings_form()
*/
function custom_breadcrumbs_admin_settings($form, &$form_state) {
drupal_set_title(t('Custom breadcrumbs configuration'));
$form['settings'] = array(
'#type' => 'fieldset',
'#title' => t('Basic settings'),
'#collapsible' => TRUE,
);
$form['settings']['custom_breadcrumb_home'] = array(
'#type' => 'textfield',
'#title' => t('Home breadcrumb text'),
// @codingStandardsIgnoreLine
'#default_value' => variable_get('custom_breadcrumb_home', t('Home')),
'#description' => t('This text will be displayed as the first item of the breadcrumb trail. Typically Home or your site name. Leave blank to have no home breadcrumb. You can also specify a title attribute (tooltip text) to add to the link. Just separate the crumb text and the title attribute text with a pipe (|) symbol (i.e. Home crumb text|attribute title text).'),
);
$form['settings']['custom_breadcrumb_home_link'] = array(
'#type' => 'textfield',
'#title' => t('Home breadcrumb link'),
// @codingStandardsIgnoreLine
'#default_value' => variable_get('custom_breadcrumb_home_link', '<front>'),
'#description' => t('This link will be the link of the first item of the breadcrumb trail. Typically <front>.'),
);
$form['settings']['custom_breadcrumbs_append_page_title_fieldset'] = array(
'#type' => 'fieldset',
'#title' => t('Page Title'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['settings']['custom_breadcrumbs_append_page_title_fieldset']['custom_breadcrumbs_append_page_title'] = array(
'#type' => 'checkbox',
'#title' => t('Append page title'),
'#default_value' => variable_get('custom_breadcrumbs_append_page_title', FALSE),
'#description' => t('Append the page title at the end of every breadcrumb.'),
);
$form['settings']['custom_breadcrumbs_append_page_title_fieldset']['custom_breadcrumbs_append_page_title_no_link'] = array(
'#type' => 'checkbox',
'#title' => t('Use plain text page title crumb'),
'#default_value' => variable_get('custom_breadcrumbs_append_page_title_no_link', FALSE),
'#description' => t('Enable this option to remove the link from the appended page title crumb.'),
);
$form['settings']['custom_breadcrumbs_menu_structure'] = array(
'#type' => 'fieldset',
'#title' => t('Menu structure'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['settings']['custom_breadcrumbs_menu_structure']['custom_breadcrumbs_set_menu_breadcrumb'] = array(
'#type' => 'checkbox',
'#title' => t('Use the menu structure to set the breadcrumb trail'),
'#default_value' => variable_get('custom_breadcrumbs_set_menu_breadcrumb', FALSE),
'#description' => t("If enabled, the default breadcrumb trail will be patterned after the page's placement in the menu structure. Select the menus that this option will apply to below. Note that this default can be superceded by other custom breadcrumbs."),
'#weight' => -30,
);
$menu_options = array();
foreach (menu_get_names() as $name) {
$menu_options[$name] = $name;
}
$form['settings']['custom_breadcrumbs_menu_structure']['custom_breadcrumbs_menu_list'] = array(
'#type' => 'select',
'#title' => t('Menu name'),
'#options' => $menu_options,
'#default_value' => variable_get('custom_breadcrumbs_menu_list', FALSE),
'#description' => t("Pages within selected menus will have a default breadcrumb patterned after the menu structure."),
'#multiple' => TRUE,
'#weight' => -20,
);
$form['adv_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Advanced settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['adv_settings']['custom_breadcrumbs_set_global_home_breadcrumb'] = array(
'#type' => 'checkbox',
'#title' => t('Set the home breadcrumb text on all pages'),
'#default_value' => variable_get('custom_breadcrumbs_set_global_home_breadcrumb', FALSE),
'#description' => t("If enabled, the home breadcrumb text will be used on all pages, not just those with defined custom breadcrumbs. If you don't want a home breadcrumb to be displayed, just enable this option and make sure that the <em>home breadcrumb text</em> above is empty."),
'#weight' => -40,
);
$form['adv_settings']['custom_breadcrumbs_use_php_in_titles'] = array(
'#type' => 'checkbox',
'#title' => t('Allow the use of PHP to set titles and paths'),
'#default_value' => variable_get('custom_breadcrumbs_use_php_in_titles', FALSE),
'#description' => t("If enabled, small PHP code snippets (less than 250 characters) can be used in the titles and paths section of the create breadcrumb forms. Each should return an array with text strings for each part of the crumb. Alternatively, a PHP code snippet placed in the titles box can return an associative array with elements 'titles' and 'paths', each an array of text strings. If this is done, the paths text field will be ignored."),
'#weight' => -35,
);
$form['adv_settings']['custom_breadcrumbs_experimental'] = array(
'#type' => 'fieldset',
'#title' => t('Experimental'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['adv_settings']['custom_breadcrumbs_experimental']['custom_breadcrumbs_force_active_trail'] = array(
'#type' => 'checkbox',
'#title' => t('Force the active trail'),
'#description' => t('This options sets the active trail to match the custom breadcrumb trail and overrides the normal theme_links() implementation to add the active-trail class to links. This is experimental and may not work as expected. If this is of interest to you, please test and report back to the custom breadcrumbs issue queue.'),
'#default_value' => variable_get('custom_breadcrumbs_force_active_trail', FALSE),
'#weight' => -10,
);
$form['adv_settings']['custom_breadcrumbs_excluded'] = array(
'#type' => 'fieldset',
'#title' => t('Excluded paths'),
'#description' => t("If enabled, the custom breadcrumbs module will not modify breadcrumbs set on the paths defined below."),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['adv_settings']['custom_breadcrumbs_excluded']['custom_breadcrumbs_use_exclude_list'] = array(
'#type' => 'checkbox',
'#title' => t('Exclude custom breadcrumbs from some pages'),
'#default_value' => variable_get('custom_breadcrumbs_use_exclude_list', FALSE),
);
$default_exclude_paths = array();
if (module_exists('admin_menu')) {
$default_exclude_paths[] = 'admin/user/user';
$default_exclude_paths[] = 'user';
}
$default = implode(',', $default_exclude_paths);
$form['adv_settings']['custom_breadcrumbs_excluded']['custom_breadcrumbs_exclude_list'] = array(
'#type' => 'textfield',
'#title' => t('Do not set custom breadcrumbs on the following paths'),
'#default_value' => variable_get('custom_breadcrumbs_exclude_list', $default),
'#description' => t("A comma delimited set of paths to exclude from custom breadcrumbs. The '*' character can be used as a wildcard."),
);
$form['adv_settings']['custom_breadcrumbs_identifiers'] = array(
'#type' => 'fieldset',
'#title' => t('HTML element identifiers'),
'#description' => t("Enabling one or more of these options will provide html identifiers (class or id) for theming custom breadcrumbs links. Style rules can then be defined in the styles.css file located in the site's theme directory."),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options'] = array(
'#type' => 'fieldset',
'#collapsible' => FALSE,
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_home_id'] = array(
'#type' => 'checkbox',
'#title' => t("Add a custom-breadcrumbs-home ID attribute to the home breadcrumb item."),
'#default_value' => variable_get('custom_breadcrumbs_home_id', FALSE),
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_home_class'] = array(
'#type' => 'checkbox',
'#title' => t("Add a custom-breadcrumbs-home class attribute to the home breadcrumb item."),
'#default_value' => variable_get('custom_breadcrumbs_home_class', FALSE),
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_parts_class'] = array(
'#type' => 'checkbox',
'#title' => t("Add a numbered class attribute for each breadcrumb item."),
'#description' => t("If enabled, a custom-breadcrumbs-item-N class attribute will be assigned for each item, where N designates the item number, starting with the first item after the home breadcrumb."),
'#default_value' => variable_get('custom_breadcrumbs_parts_class', FALSE),
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_even_odd_class'] = array(
'#type' => 'checkbox',
'#title' => t("Add even and odd classes to breadcrumb items."),
'#default_value' => variable_get('custom_breadcrumbs_even_odd_class', FALSE),
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_type_class'] = array(
'#type' => 'checkbox',
'#title' => t("Store an identifier for breadcrumb theming."),
'#description' => t("If enabled, the breadcrumb class 'custom-breadcrumbs-<em>type</em>' (where <em>type</em> is the breadcrumb type) can be retrieved and used in the breadcrumb theme override. The function <strong>custom_breadcrumbs_unique_breadcrumb_id()</strong> will return a string containing the class name."),
'#default_value' => variable_get('custom_breadcrumbs_type_class', FALSE),
);
$form['adv_settings']['custom_breadcrumbs_identifiers']['cb_identifier_options']['custom_breadcrumbs_append_bid_class'] = array(
'#type' => 'checkbox',
'#title' => t("Append a unique breadcrumb id number to the custom-breadcrumbs-<em>type</em> identifier."),
'#description' => t("If this option and 'Store an identifier for breadcrumb theming' are both enabled, the identifer will be custom-breadcrumbs-<em>type</em>-<em>id</em>, where id is the unique breadcrumb id number."),
'#default_value' => variable_get('custom_breadcrumbs_append_bid_class', FALSE),
);
$form['adv_settings']['module_weights'] = array(
'#type' => 'fieldset',
'#title' => t('Module weights'),
'#description' => t('The relative module weights can be adjusted in the table below. Modules with lighter weights will provide custom breadcrumbs that can be modified, or overridden, by heavier modules.'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
$form['adv_settings']['module_weights']['table'] = custom_breadcrumbs_module_weight();
if (!empty($form['adv_settings']['module_weights']['table'])) {
$form['adv_settings']['module_weights']['table']['#theme'] = 'custom_breadcrumbs_module_weight';
}
else {
unset($form['adv_settings']['module_weights']);
}
$form['#submit'][] = 'custom_breadcrumbs_admin_settings_submit';
return system_settings_form($form);
}
/**
* Form submission handler for custom_breadcrumbs_admin_settings().
*
* @see custom_breadcrumbs_admin_settings()
*/
function custom_breadcrumbs_admin_settings_submit($form, &$form_state) {
if (!empty($form['adv_settings']['module_weights']['table'])) {
// Set the initial weight of the lightest module to zero.
$current_mod_weight = 0;
$table = array(
'module name' => array(),
'table weight' => array(),
'module weight' => array(),
);
// Prepare module table that can be sorted by table weight.
foreach ($form_state['values']['table'] as $module_id => $value) {
if (is_numeric($module_id)) {
$module = $form['adv_settings']['module_weights']['table'][$module_id]['#module'];
$table['table weight'][$module] = $form_state['values']['table'][$module_id]['weight'];
$table['module weight'][$module] = $form['adv_settings']['module_weights']['table'][$module_id]['#weight'];
}
}
// Sort module list by table weight.
array_multisort($table['table weight'], $table['module weight']);
foreach ($table['module weight'] as $module => $orig_weight) {
// Find the module's minimum weight determined by dependence on other
// modules.
$func = $module . '_minimum_module_weight';
$min = function_exists($func) ? $func() : 0;
$weight = max($min, $current_mod_weight);
// Update module weight in the system table if it has changed.
if ($orig_weight != $weight) {
db_update('system')
->fields(array(
'weight' => $weight,
))
->condition('name', $module)
->execute();
variable_set('menu_rebuild_needed', TRUE);
}
$current_mod_weight = $weight + 1;
}
}
// Rebuild the theme registry if custom_breadcrumbs_force_active_trail has
// changed.
if ($form_state['values']['custom_breadcrumbs_force_active_trail'] != $form['adv_settings']['custom_breadcrumbs_experimental']['custom_breadcrumbs_force_active_trail']['#default_value']) {
drupal_theme_rebuild();
drupal_set_message(t('The theme registry has been rebuilt'));
}
}
/**
* Lists and manages custom breadcrumb module weights.
*
* @see theme_custom_breadcrumbs_module_weight()
* @see custom_breadcrumbs_admin_settings_submit()
*/
function custom_breadcrumbs_module_weight() {
// Get a list of all custom_breadcrumbs submodules and their module weights.
$modules = module_implements('cb_breadcrumb_info');
$form = array(
'#tree' => TRUE,
);
$module_id = 0;
$weights = _custom_breadcrumbs_get_module_weight($modules);
foreach ($weights as $module => $weight) {
$info = drupal_parse_info_file(drupal_get_path('module', $module) . '/' . $module . '.info');
$form[$module_id]['#weight'] = $weight;
$form[$module_id]['#module'] = $module;
$form[$module_id]['name'] = array(
'#markup' => check_plain($info['name']),
);
$form[$module_id]['weight'] = array(
'#type' => 'weight',
'#delta' => 200,
'#default_value' => $weight,
);
++$module_id;
}
// Only add this form if there is more than one module.
return $module_id > 1 ? $form : array();
}
/**
* Returns HTML for the module weights as a sortable list.
*
* @ingroup themeable
* @see custom_breadcrumbs_module_weight()
*/
function theme_custom_breadcrumbs_module_weight($variables) {
$form = $variables['form'];
$header = array(
t('Module Name'),
t('Weight'),
);
$rows = array();
foreach (element_children($form) as $key) {
if (isset($form[$key]['name'])) {
$row = array();
$row[] = drupal_render($form[$key]['name']);
if (isset($form[$key]['weight'])) {
$form[$key]['weight']['#attributes']['class'] = array(
'module-weight',
);
$row[] = drupal_render($form[$key]['weight']);
}
$rows[] = array(
'data' => $row,
'class' => array(
'draggable',
),
);
}
}
drupal_add_tabledrag('custom_breadcrumbs', 'order', 'self', 'module-weight');
$output = theme('table', array(
'header' => $header,
'rows' => $rows,
'attributes' => array(
'id' => 'custom_breadcrumbs',
),
));
$output .= drupal_render_children($form);
return $output;
}
/**
* Function multilingual.
*
* Checks whether the administration interface should show multilingual
* features.
*/
function _custom_breadcrumbs_multilingual() {
return module_exists('locale');
}
/**
* Lists custom_breadcrumbs administration filters that can be applied.
*/
function custom_breadcrumbs_filters() {
$filters = array();
$options = array();
foreach (module_implements('cb_breadcrumb_info') as $module) {
$bc_info = module_invoke($module, 'cb_breadcrumb_info');
foreach ($bc_info as $info) {
$options[$module . '-' . $info['table']] = $info['type'];
}
}
$filters['type'] = array(
'title' => t('Type'),
'options' => array(
'[any]' => t('any'),
) + $options,
);
if (_custom_breadcrumbs_multilingual()) {
$filters['language'] = array(
'title' => t('Language'),
'options' => array(
'' => t('All languages'),
) + locale_language_list('name'),
);
}
return $filters;
}
/**
* Form builder; Return form for custom_breadcrumbs administration filters.
*
* @ingroup forms
* @see custom_breadcrumbs_filter_form_submit()
*/
function custom_breadcrumbs_filter_form($form) {
$session = isset($_SESSION['custom_breadcrumbs_overview_filter']) ? $_SESSION['custom_breadcrumbs_overview_filter'] : array();
$filters = custom_breadcrumbs_filters();
$i = 0;
$form['filters'] = array(
'#type' => 'fieldset',
'#title' => t('Show only custom_breadcrumbs where'),
'#theme' => 'exposed_filters',
);
foreach ($session as $filter) {
list($type, $value) = $filter;
// @codingStandardsIgnoreLine
$options = $filters[$type]['options'];
$t_args = array(
'%property' => $filters[$type]['title'],
'%value' => $filters[$type]['options'][$value],
);
if ($i++) {
$form['filters']['current'][] = array(
'#markup' => t('and where <strong>%property</strong> is <strong>%value</strong>', $t_args),
);
}
else {
$form['filters']['current'][] = array(
'#markup' => t('<strong>%property</strong> is <strong>%value</strong>', $t_args),
);
}
unset($filters[$type]);
}
$form['filters']['status'] = array(
'#type' => 'container',
'#attributes' => array(
'class' => array(
'clearfix',
),
),
'#prefix' => $i && count($filters) > 0 ? '<div class="additional-filters">' . t('and where') . '</div>' : '',
);
$form['filters']['status']['filters'] = array(
'#type' => 'container',
'#attributes' => array(
'class' => array(
'filters',
),
),
);
foreach ($filters as $key => $filter) {
// @codingStandardsIgnoreLine
$names[$key] = $filter['title'];
$form['filters']['status']['filters'][$key] = array(
'#type' => 'select',
'#options' => $filter['options'],
'#title' => $filter['title'],
'#default_value' => '[any]',
);
}
$form['filters']['status']['actions'] = array(
'#type' => 'actions',
'#attributes' => array(
'class' => array(
'container-inline',
),
),
);
if (count($filters) > 0) {
$form['filters']['status']['actions']['submit'] = array(
'#type' => 'submit',
'#value' => count($session) ? t('Refine') : t('Filter'),
);
}
if (count($session)) {
$form['filters']['status']['actions']['undo'] = array(
'#type' => 'submit',
'#value' => t('Undo'),
);
$form['filters']['status']['actions']['reset'] = array(
'#type' => 'submit',
'#value' => t('Reset'),
);
}
$form['#submit'][] = 'custom_breadcrumbs_filter_form_submit';
drupal_add_library('system', 'drupal.form');
return $form;
}
/**
* Form submission handler for custom_breadcrumbs_filter_form().
*
* @see custom_breadcrumbs_filter_form()
*/
function custom_breadcrumbs_filter_form_submit($form, &$form_state) {
$op = $form_state['values']['op'];
$filters = custom_breadcrumbs_filters();
switch ($op) {
case t('Filter'):
case t('Refine'):
foreach ($filters as $filter => $options) {
if (isset($form_state['values'][$filter]) && $form_state['values'][$filter] != '[any]') {
if (isset($options['options'][$form_state['values'][$filter]])) {
$_SESSION['custom_breadcrumbs_overview_filter'][] = array(
$filter,
$form_state['values'][$filter],
);
}
}
}
break;
case t('Undo'):
array_pop($_SESSION['custom_breadcrumbs_overview_filter']);
break;
case t('Reset'):
$_SESSION['custom_breadcrumbs_overview_filter'] = array();
break;
case t('Update'):
return;
}
$form_state['redirect'] = 'admin/structure/custom_breadcrumbs';
}
/**
* Provides a simple breadcrumb table for the node edit form.
*
* @param array $breadcrumbs
* An array of breadcrumbs that apply to the node.
*
* @return string
* A themed table of custom breadcrumbs.
*
* @codingStandardsIgnoreStart
*/
function custom_breadcrumbs_simple_breadcrumb_table($breadcrumbs) {
// @codingStandardsIgnoreEnd
$header = array(
t('Name'),
t('Type'),
t('Titles'),
t('Paths'),
);
$multilingual = _custom_breadcrumbs_multilingual();
if ($multilingual) {
$header[] = t('Language');
}
$header[] = t('Operations');
$rows = array();
foreach ($breadcrumbs as $breadcrumb) {
$row = array();
$row[] = array(
'data' => $breadcrumb->name . (!empty($breadcrumb->visibility_php) ? ' ' . t('with PHP snippet') : ''),
);
$row[] = array(
'data' => $breadcrumb->breadcrumb_type,
);
$row[] = array(
'data' => check_plain($breadcrumb->titles),
);
$row[] = array(
'data' => check_plain($breadcrumb->paths),
);
if ($multilingual) {
$row[] = array(
'data' => module_invoke('locale', 'language_name', $breadcrumb->language),
);
}
$row[] = l(t('edit'), 'admin/structure/custom_breadcrumbs/' . $breadcrumb->breadcrumb_type . '/edit/' . $breadcrumb->bid);
$rows[] = $row;
}
if (count($rows) == 0) {
$rows[] = array(
array(
'data' => t('You can define custom breadcrumbs at <a href ="@link">Custom Breadcrumbs Administration Page</a>.', array(
'@link' => url('admin/structure/custom_breadcrumbs'),
)),
'colspan' => 5 + (int) $multilingual,
),
);
}
return theme('table', array(
'header' => $header,
'rows' => $rows,
));
}Functions
Name |
Description |
|---|---|
| custom_breadcrumbs_admin_settings | Admin Settings. |
| custom_breadcrumbs_admin_settings_submit | Form submission handler for custom_breadcrumbs_admin_settings(). |
| custom_breadcrumbs_common_form_elements | Provides form elements commonly used by custom breadcrumbs submodules. |
| custom_breadcrumbs_filters | Lists custom_breadcrumbs administration filters that can be applied. |
| custom_breadcrumbs_filter_form | Form builder; Return form for custom_breadcrumbs administration filters. |
| custom_breadcrumbs_filter_form_submit | Form submission handler for custom_breadcrumbs_filter_form(). |
| custom_breadcrumbs_form | Form builder to edit a custom breadcrumb record. |
| custom_breadcrumbs_form_cancel | Form disable. |
| custom_breadcrumbs_form_delete | Form delete. |
| custom_breadcrumbs_form_submit | Form submission handler for custom_breadcrumbs_form(). |
| custom_breadcrumbs_form_validate | Form validation handler for custom_breadcrumbs_form(). |
| custom_breadcrumbs_module_weight | Lists and manages custom breadcrumb module weights. |
| custom_breadcrumbs_page | Lists all current custom breadcrumbs and provides a link to the edit page. |
| custom_breadcrumbs_simple_breadcrumb_table | Provides a simple breadcrumb table for the node edit form. |
| theme_custom_breadcrumbs_module_weight | Returns HTML for the module weights as a sortable list. |
| _custom_breadcrumbs_multilingual | Function multilingual. |
| _custom_breadcrumbs_sort_cmp | Sorts two custom_breadcrumbs objects by name, type, or language. |