manuelcillero/suitedesk
manuelcillero/suitedesk
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

New module 'Custom breadcrumbs'

Browse source
This commit is contained in:
Manuel Cillero 2017-07-26 10:57:18 +02:00
parent 89b4aad0f8
commit 3813ae0e06
26 changed files with 6004 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
modules/custom_breadcrumbs/custom_breadcrumbsapi/custom_breadcrumbsapi.info Normal file
View file

@ -0,0 +1,16 @@
; $Id: custom_breadcrumbsapi.info,v 1.1.2.1 2009/09/08 01:31:48 mgn Exp $
name = Custom Breadcrumbs API
package = Custom Breadcrumbs
dependencies[] = custom_breadcrumbs
description = Provides a simple API to set breadcrumbs on module pages not served by other custom breadcrumbs submodules.
core = 6.x
; Information added by drupal.org packaging script on 2011-01-08
version = "6.x-2.0-rc1"
core = "6.x"
project = "custom_breadcrumbs"
datestamp = "1294462254"

91
modules/custom_breadcrumbs/custom_breadcrumbsapi/custom_breadcrumbsapi.install Normal file
View file

@ -0,0 +1,91 @@
<?php
// $Id: custom_breadcrumbsapi.install,v 1.1.2.3 2010/05/03 22:49:15 mgn Exp $
/**
* @file
* Install file for the custom_breadcrumbsapi module.
*/
/**
* Implements hook_install().
*/
function custom_breadcrumbsapi_install() {
drupal_install_schema('custom_breadcrumbsapi');
}
/**
* Implements hook_schema().
*/
function custom_breadcrumbsapi_schema() {
$schema['custom_breadcrumbsapi'] = array(
'description' => 'Stores custom breadcrumb for module pages.',
'fields' => array(
'bid' => array(
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => 'Unique identifier for the {custom_breadcrumbsapi}.',
),
'name' => array(
'type' => 'varchar',
'length' => 128,
'not null' => FALSE,
'description' => 'An optional name for the custom breadcrumb.',
),
'titles' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => "A return-delimited list of titles for the breadcrumb links.",
),
'paths' => array(
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
'description' => "A return-delimited list of url paths for the breadcrumb links.",
),
'visibility_php' => array(
'type' => 'text',
'not null' => TRUE,
'size' => 'medium',
'description' => 'An optional PHP snippet to control the {custom_breadcrumbsapi} visibility.',
),
'module_page' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'description' => "Name of module page implementing custom breadcrumbs.",
),
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
'description' => 'The language this breadcrumb is for; if blank, the breadcrumb will be used for unknown languages.',
),
),
'indexes' => array(
'language' => array('language'),
'module_language' => array('module_page', 'language'),
),
'primary key' => array('bid'),
);
return $schema;
}
/**
* Adds name field for improved organization of breadcrumbs
* Remove set_active_menu field because it is no longer used.
*/
function custom_breadcrumbsapi_update_6200() {
$ret = array();
db_add_field($ret, 'custom_breadcrumbsapi', 'name', array('type' => 'varchar', 'length' => 128, 'NOT NULL' => FALSE, 'description' => 'An optional name for the custom breadcrumb.'));
return $ret;
}
/**
* Implements hook_uninstall().
*/
function custom_breadcrumbsapi_uninstall() {
drupal_uninstall_schema('custom_breadcrumbsapi');
}

190
modules/custom_breadcrumbs/custom_breadcrumbsapi/custom_breadcrumbsapi.module Normal file
View file

@ -0,0 +1,190 @@
<?php
// $Id: custom_breadcrumbsapi.module,v 1.1.2.9 2010/10/22 15:55:33 mgn Exp $
/**
* @file
* Provide custom breadcrumbs for module pages.
*/
module_load_include('inc', 'custom_breadcrumbs', 'custom_breadcrumbs.admin');
/**
* Implements hook_cb_breadcrumb_info().
*
* @return an array with elements:
* 'table' indicating the db_table to load the breadcrumb from,
* 'field' a unique field of the database table used to identify the breadcrumb,
* 'type' a string used for indicating the breadcrumb type on the admin list,
* 'name_constructor' a function which generates the breadcrumb name from the breadcrumb.
*/
function custom_breadcrumbsapi_cb_breadcrumb_info() {
$breadcrumb_type_info = array();
$breadcrumb_type_info['module'] = array(
'table' => 'custom_breadcrumbsapi',
'field' => 'module_page',
'type' => 'module',
'name_constructor' => '_custom_breadcrumbsapi_breadcrumb_name',
);
return $breadcrumb_type_info;
}
/**
* Constructs a default name to display in the admin screen.
*
* @param $breadcrumb
* The breadcrumb object.
*
* @return
* A text string that will be used as the breadcrumb name.
*/
function _custom_breadcrumbsapi_breadcrumb_name($breadcrumb) {
if (isset($breadcrumb->module_page)) {
return $breadcrumb->module_page;
}
}
/**
* Implements hook_help().
*/
function custom_breadcrumbsapi_help($path, $arg) {
switch ($path) {
case 'admin/help#custom_breadcrumbsapi':
$output = '<p>' . t("Custom Breadcrumbsapi provides a simple api that allows custom breadcrumbs to be defined for module pages that use a theme template or a custom_breadcrumbsapi hook. For the latter, module developers need to provide a <em>moduleName</em>_custom_breadcrumbsapi() function that returns an array containing the names of the module pages for which custom breadcrumbs may be defined. Then, in the callback functions for each of those pages, the following lines needs to be inserted:") . '</p>';
$output .= '<p><strong>' . t("drupal_alter('breadcrumb', \$breadcrumb, '<em>module_page_name</em>');") . '</strong></p>';
$output .= t('within the function, preferably after defining $breadcrumb but before setting the breadcrumb.');
return $output;
}
}
/**
* Implements hook_menu().
*/
function custom_breadcrumbsapi_menu() {
$items = array();
$items['admin/build/custom_breadcrumbs/module/add'] = array(
'title' => 'Module Pages',
'page callback' => 'drupal_get_form',
'page arguments' => array('custom_breadcrumbsapi_form', 'module'),
'access arguments' => array('administer custom breadcrumbs'),
'type' => MENU_LOCAL_TASK,
);
$items['admin/build/custom_breadcrumbs/module/edit'] = array(
'title' => 'Edit custom breadcrumb for module page',
'page callback' => 'drupal_get_form',
'page arguments' => array('custom_breadcrumbsapi_form', 'module'),
'access arguments' => array('administer custom breadcrumbs'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_breadcrumb_alter().
*
* Provide a function for module developers to provide custom breadcrumbs for module pages.
* Modules wishing to provide custom breadcrumbs access to specific pages should include
* drupal_alter('breadcrumb', $breadcrumb, $modulepage, $objs);
* at the end of the function providing the page.
*
* @param $breadcrumb
* The breadcrumb array to be altered
* @param $modulepage
* a string identifying the module page. This name will be displayed on the customb breadcrumb list.
* @param $objs
* an array of objects that can be used in token replacement with array keys indicating the type of object.
*/
function custom_breadcrumbsapi_breadcrumb_alter($breadcrumb, $modulepage, $objs = array()) {
global $language;
$languages = array('language' => $language->language, 'all' => '');
$breadcrumbs = custom_breadcrumbs_load_breadcrumbs('custom_breadcrumbsapi', NULL, array('module_page' => $modulepage), $languages);
if (!empty($breadcrumbs)) {
if ($breadcrumb = custom_breadcrumbs_select_breadcrumb($breadcrumbs, $objs)) {
custom_breadcrumbs_set_breadcrumb($breadcrumb, $objs);
// Return the modified breadcrumb which has now been set.
$breadcrumb = drupal_get_breadcrumb();
}
}
}
/**
* Form builder; Displays an edit form for a module page breadcrumb.
*
* @ingroup forms
* @see custom_breadcrumbs_form_validate()
* @see custom_breadcrumbs_form_submit()
*/
function custom_breadcrumbsapi_form(&$form_state, $type) {
$form = array();
$breadcrumb = NULL;
$bid = arg(5);
if (isset($bid)) {
drupal_set_title(t('Edit Custom Breadcrumb for Module Page'));
$breadcrumbs = custom_breadcrumbs_load_breadcrumbs('custom_breadcrumbsapi', NULL, array('bid' => $bid));
$breadcrumb = array_pop($breadcrumbs);
}
else {
drupal_set_title(t('Add Custom Breadcrumb for Module Page'));
}
$options = array();
// Include any templates in the theme registry.
init_theme();
$hooks = theme_get_registry();
if (is_array($hooks)) {
foreach ($hooks as $name => $hook) {
if (isset($hook['template'])) {
$options[$name] = $hook['template'];
}
}
}
// Include all module functions specified in hook_custom_breadcrumbsapi.
$modules = module_implements('custom_breadcrumbsapi');
foreach ($modules as $module) {
$func = $module . '_custom_breadcrumbsapi';
$names = $func();
foreach ($names as $name) {
$options[$name] = $name;
}
}
if (empty($options)) {
$form['notice'] = array('#value' => t('No module pages using theme templates or currently implementing the custom breadcrumbs api. Read the <a href="@help">documentation</a> to learn how to do this.', array('@help' => url('admin/help/custom_breadcrumbsapi'))));
}
else {
$form['module_page'] = array(
'#type' => 'select',
'#title' => t('Module Page'),
'#required' => TRUE,
'#options' => $options,
'#description' => t('The module page that this custom breadcrumb trail will apply to.'),
'#default_value' => isset($breadcrumb->module_page) ? $breadcrumb->module_page : NULL,
'#weight' => -10,
);
// Store information needed to save this breadcrumb.
$form['#module'] = 'custom_breadcrumbsapi';
$form['#infokey'] = 'module';
$form += custom_breadcrumbs_common_form_elements($bid, $breadcrumb);
$form['visibility_php']['#description'] = t('Determine whether this breadcrumb should be displayed by using a PHP snippet to return TRUE or FALSE. For module pages in the theme registry, you will have access to the %var array. Consult the individual template files for variable names that are used as the arguments of this array.', array('%var' => '$variables'));
$form['#submit'][] = 'custom_breadcrumbs_form_submit';
$form['#validate'][] = 'custom_breadcrumbs_form_validate';
}
return $form;
}
/**
* Implements hook_preprocess().
*/
function custom_breadcrumbsapi_preprocess(&$variables, $hook) {
// Check to see if hook has a defined custom breadcrumb.
static $tried = array();
// Only respond to the first call for this hook.
if (!isset($tried[$hook])) {
$tried[$hook] = TRUE;
global $language;
$languages = array('language' => $language->language, 'all' => '');
$breadcrumbs = custom_breadcrumbs_load_breadcrumbs('custom_breadcrumbsapi', NULL, array('module_page' => $hook), $languages);
if (!empty($breadcrumbs)) {
$objs = (isset($variables) && is_array($variables)) ? $variables : array();
if ($breadcrumb = custom_breadcrumbs_select_breadcrumb($breadcrumbs, $objs)) {
custom_breadcrumbs_set_breadcrumb($breadcrumb, $objs);
$variables['breadcrumb'] = theme('breadcrumb', drupal_get_breadcrumb());
}
}
}
}