? .magic_tabs.example.inc.swp ? .magic_tabs.module.swp ? magic_tabs_5_to_6_pages.patch Index: magic_tabs.example.inc =================================================================== RCS file: magic_tabs.example.inc diff -N magic_tabs.example.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ magic_tabs.example.inc 27 Sep 2008 19:51:00 -0000 @@ -0,0 +1,34 @@ + t('First magic tab'), + 'content' => t('%param: Content of first magic tab', array('%param' => $a1)), + ); + $tabs[] = array( + 'title' => t('Second magic tab'), + 'content' => t('%param: Content of the second magic tab', array('%param' => $a2)), + ); + $tabs[] = array( + 'title' => t('Third magic tab'), + 'content' => ($active == 2 || $active == -1) ? magic_tabs_get('magic_tabs_inline_callback') : '', + ); + /* + ** Uncomment to display a custom block with $bid==2 + */ + /* + $bid = 2; + $block = (object)module_invoke('block', 'block', 'view', $bid); + $block->module = 'block'; + $block->delta = $bid; + $tabs[] = array( + 'title' => t('Display a custom block'), + 'content' => theme('block', $block), + ); + */ + return $tabs; +} Index: magic_tabs.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/magic_tabs/Attic/magic_tabs.module,v retrieving revision 1.3.2.13 diff -u -p -r1.3.2.13 magic_tabs.module --- magic_tabs.module 23 Sep 2008 07:36:13 -0000 1.3.2.13 +++ magic_tabs.module 27 Sep 2008 19:51:00 -0000 @@ -2,284 +2,29 @@ // $Id: magic_tabs.module,v 1.3.2.13 2008/09/23 07:36:13 yhager Exp $ /** - * Prints the tabs as defined in the specified callback - * - * @param $callback - * The callback used to prepare the tabs array. It should return an array - * of arrays, each contains a 'title' and a 'content' element. Note that all - * titles are required each time, while only the content from the active - * tab is presented to the user. - * - * @param $active - * The active tab. a numerical value, or 'first'(0) or 'last'(-1). In any way, - * the value that will be sent to the callback is numerical. - * - * @param ... - * Additional parameters that will get passed to the callback. An example - * usage for this for example to display dynamic tabs based on the node - * displayed. - * - * @return - * Rendered tabs - */ -function magic_tabs_get($callback, $active = 'first') { - global $theme; - global $user; - global $_menu; - - if (!isset($theme)) { - init_theme(); - } - drupal_add_css(drupal_get_path('module', 'magic_tabs') .'/magic_tabs.css'); - - // get additional arguments passed to this function - $args = func_get_args(); - array_shift($args); - - // Is this an ajax request? - $ajax = _magic_tabs_first_time_ajax(); - - // switch to referer path, to allow called functions to refer to the original path - $q = $_GET['q']; - if ($ajax) { - unset($_menu['items']); - menu_set_active_item($_GET['referer']); - if (!_menu_item_is_accessible(menu_get_active_item())) { - // no access to this URL. Return nothing and report. - watchdog('magic_tabs', t('User %user possibly tried to access %path using an AJAX call, but has no permission to access this URL.', array('%user' => $user->name, '%path' => $_GET['referer'])), WATCHDOG_WARNING); - return; - } - } else { - // not ajax, register the callback before executing - magic_tabs_register_callback($callback); - } - - if (!magic_tabs_check_callback($callback)) { - // callback not registered. report and bail out - watchdog('magic_tabs', t('User %user tried to use a callback %callback without it being registered first.', array('%user' => $user->name, '%callback' => $callback)), WATCHDOG_WARNING); - return; - } - - $output = ''; - $index = 0; - if (isset($_GET[$callback .'_tab'])) { - // save user's request - if ($user->uid) { - $_SESSION['magic_tabs'][$callback .'_tab'] = $_GET[$callback .'_tab']; - } - else { - $active = $_GET[$callback .'_tab']; - } - } - if ($user->uid && isset($_SESSION['magic_tabs'][$callback .'_tab'])) { - // serve user's last request - $active = $_SESSION['magic_tabs'][$callback .'_tab']; - } - if (!is_numeric($active)) { - switch ($active) { - case 'last': - $active = -1; - break; - default: // case 'first', but cover up for garbage - $active = 0; - } - } - - // $active might have changed, update it. - $args[0] = $active; - $tabs = call_user_func_array($callback, $args); - - // go back to our original path - if ($ajax) { - unset($_menu['items']); - menu_set_active_item($q); - } - - if (empty($tabs)) { - return; - } - - // ensure $active is within limits and positive - $tabs_count = count($tabs); - $active = ($active + $tabs_count) % $tabs_count; - - // we don't need the $active parameter - array_shift($args); - $cb_args = !empty($args) ? urlencode(serialize($args)) : ''; - - // extract titles and contents - foreach ($tabs as $tab) { - $title = $tab['title'] ? $tab['title'] : t('Tab %index', array('%index' => $index)); - $class = strtolower(preg_replace('/[^a-zA-Z0-9]+/ ', '-', $tab['title'])); - $path = $ajax ? $_GET['referer'] :$_GET['q']; - $cb_path = url("magic_tabs/$callback", "${callback}_tab=$index&referer=". urlencode($path) . "&args=". $cb_args); - $items[] = l( - ''. $title .'', - $path, - array( - 'class' => ($index == $active) ? 'selected '. $class .'-active' : $class, - 'onclick' => " - $('#$callback .magic_content').addClass('hidden'); - $('#$callback .loading').removeClass('hidden'); - $('#$callback').load('$cb_path'); - return false", - ), - magic_tabs_query_string(array($callback . '_tab' => $index, 'referer' => urlencode($path), 'args' => $cb_args)), - NULL, FALSE, TRUE - ); - $index++; - } - - // find the correct theme function - $theme_func = $callback; - if (!theme_get_function($theme_func)) { - // default theme for tabs - $theme_func = 'magic_tabs'; - } - - $output = theme($theme_func, $callback, $items, $tabs[$active]['content']) .''; - if (!$ajax) { - $output = "
". $output .'
'; - } - return $output; -} - -/** * Implementation of hook_menu(). */ -function magic_tabs_menu($may_cache) { - if (!$may_cache) { - $items[] = array( - 'path' => 'magic_tabs', +function magic_tabs_menu() { + $items['magic_tabs'] = array( + 'title' => 'Magic Tabs', 'callback' => 'magic_tabs_ajax', 'access' => user_access('access content'), 'type' => MENU_CALLBACK, ); - } return $items; } -function magic_tabs_ajax($callback) { - - global $theme; - - $args = array(); - if ($_GET['args']) { - $args = unserialize($_GET['args']); - } - array_unshift($args, $callback, 'first'); - - /** - * need to initialize the theme engine first, otherwise, $callback might not - * be in the function list - */ - if (!isset($theme)) { - init_theme(); - } - - if (function_exists($callback)) { - print call_user_func_array('magic_tabs_get', $args); - exit(); - } -} - -function magic_tabs_query_string($params = array()) { - $q = array_merge($_GET, $params); - $querystring = array(); - unset($q['q']); - foreach ($q as $key => $value) { - if ($key != 'q') { - $querystring[] = $key .'='. $value; - } - } - return !empty($querystring) ? implode('&', $querystring) : NULL; -} - -function magic_tabs_register_callback($callback) { - // register a callback in the cache. This is not to benefit performance, but to allow saving a temporary state - // other solutions considered where: - // 1. $_SESSION - not good due to page_cache, - // 2. variable table - entries might get stored for too long and provide security risk - $callbacks = array(); - if (($cache = cache_get('magic_tabs_callbacks')) && !empty($cache->data)) { - $callbacks = unserialize($cache->data); - } - $callbacks[$callback] = TRUE; - cache_set('magic_tabs_callbacks', 'cache', serialize($callbacks), CACHE_TEMPORARY); -} - -function magic_tabs_check_callback($callback) { - // check if the callback is in the list of allowed callbacks - if (($cache = cache_get('magic_tabs_callbacks')) && !empty($cache->data)) { - $callbacks = unserialize($cache->data); - return $callbacks[$callback]; - } -} - /** - * Themeable functions - */ -function theme_magic_tabs($callback, $items, $content) { - return theme('item_list', $items, NULL, 'ul', array('class' => 'tabs')) .'
'. $content .'
'; -} - -/** - * Example callback function - */ -function magic_tabs_example_callback($active = 0, $a1, $a2) { - $tabs[] = array( - 'title' => t('First magic tab'), - 'content' => t('%param: Content of first magic tab', array('%param' => $a1)), - ); - $tabs[] = array( - 'title' => t('Second magic tab'), - 'content' => t('%param: Content of the second magic tab', array('%param' => $a2)), - ); - $tabs[] = array( - 'title' => t('Third magic tab'), - 'content' => ($active == 2 || $active == -1) ? magic_tabs_get('magic_tabs_inline_callback') : '', - ); - /* - ** Uncomment to display a custom block with $bid==2 - */ - /* - $bid = 2; - $block = (object)module_invoke('block', 'block', 'view', $bid); - $block->module = 'block'; - $block->delta = $bid; - $tabs[] = array( - 'title' => t('Display a custom block'), - 'content' => theme('block', $block), - ); - */ - return $tabs; -} - -function magic_tabs_inline_callback() { - $tabs[] = array( - 'title' => t('First nested magic tab'), - 'content' => t('Content of first nested magic tab'), - ); - $tabs[] = array( - 'title' => t('2nd nested magic tab'), - 'content' => t('Content of the second nested magic tab'), + * Implementation of hook_theme(). + */ +function magic_tabs_theme(){ + return array( + 'magic_tabs' => array( + 'arguments' => array( + 'callback' => '', + 'items' => array(), + 'content' => '', + ), + ), ); - return $tabs; } - -/** - * return TRUE if this is an ajax call - * - * Only the first call to this function returns TRUE for ajax calls. - * This is used so inline tabs work inside an ajax called outer tab - */ -function _magic_tabs_first_time_ajax() { - static $ajax; - - if ($ajax) { - return FALSE; - } - - $ajax = ($_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'); - return $ajax; -} \ No newline at end of file Index: magic_tabs.pages.inc =================================================================== RCS file: magic_tabs.pages.inc diff -N magic_tabs.pages.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ magic_tabs.pages.inc 27 Sep 2008 19:51:00 -0000 @@ -0,0 +1,270 @@ + $user->name, '%path' => $_GET['referer'])), WATCHDOG_WARNING); + return; + } + } else { + // not ajax, register the callback before executing + magic_tabs_register_callback($callback); + } + + if (!magic_tabs_check_callback($callback)) { + // callback not registered. report and bail out + watchdog('magic_tabs', t('User %user tried to use a callback %callback without it being registered first.', array('%user' => $user->name, '%callback' => $callback)), WATCHDOG_WARNING); + return; + } + + $output = ''; + $index = 0; + if (isset($_GET[$callback .'_tab'])) { + // save user's request + if ($user->uid) { + $_SESSION['magic_tabs'][$callback .'_tab'] = $_GET[$callback .'_tab']; + } + else { + $active = $_GET[$callback .'_tab']; + } + } + if ($user->uid && isset($_SESSION['magic_tabs'][$callback .'_tab'])) { + // serve user's last request + $active = $_SESSION['magic_tabs'][$callback .'_tab']; + } + if (!is_numeric($active)) { + switch ($active) { + case 'last': + $active = -1; + break; + default: // case 'first', but cover up for garbage + $active = 0; + } + } + + // $active might have changed, update it. + $args[0] = $active; + $tabs = call_user_func_array($callback, $args); + + // go back to our original path + if ($ajax) { + unset($_menu['items']); + menu_set_active_item($q); + } + + if (empty($tabs)) { + return; + } + + // ensure $active is within limits and positive + $tabs_count = count($tabs); + $active = ($active + $tabs_count) % $tabs_count; + + // we don't need the $active parameter + array_shift($args); + $cb_args = !empty($args) ? urlencode(serialize($args)) : ''; + + // extract titles and contents + foreach ($tabs as $tab) { + $title = $tab['title'] ? $tab['title'] : t('Tab %index', array('%index' => $index)); + $class = strtolower(preg_replace('/[^a-zA-Z0-9]+/ ', '-', $tab['title'])); + $path = $ajax ? $_GET['referer'] :$_GET['q']; + $cb_path = url("magic_tabs/$callback", "${callback}_tab=$index&referer=". urlencode($path) . "&args=". $cb_args); + $items[] = l( + ''. $title .'', + $path, + array( + 'class' => ($index == $active) ? 'selected '. $class .'-active' : $class, + 'onclick' => " + $('#$callback .magic_content').addClass('hidden'); + $('#$callback .loading').removeClass('hidden'); + $('#$callback').load('$cb_path'); + return false", + ), + magic_tabs_query_string(array($callback . '_tab' => $index, 'referer' => urlencode($path), 'args' => $cb_args)), + NULL, FALSE, TRUE + ); + $index++; + } + + // find the correct theme function + $theme_func = $callback; + if (!theme_get_function($theme_func)) { + // default theme for tabs + $theme_func = 'magic_tabs'; + } + + $output = theme($theme_func, $callback, $items, $tabs[$active]['content']) .''; + if (!$ajax) { + $output = "
". $output .'
'; + } + return $output; +} + +function magic_tabs_ajax($callback) { + + global $theme; + + $args = array(); + if ($_GET['args']) { + $args = unserialize($_GET['args']); + } + array_unshift($args, $callback, 'first'); + + /** + * need to initialize the theme engine first, otherwise, $callback might not + * be in the function list + */ + if (!isset($theme)) { + init_theme(); + } + + if (function_exists($callback)) { + print call_user_func_array('magic_tabs_get', $args); + exit(); + } +} + +function magic_tabs_query_string($params = array()) { + $q = array_merge($_GET, $params); + $querystring = array(); + unset($q['q']); + foreach ($q as $key => $value) { + if ($key != 'q') { + $querystring[] = $key .'='. $value; + } + } + return !empty($querystring) ? implode('&', $querystring) : NULL; +} + +function magic_tabs_register_callback($callback) { + // register a callback in the cache. This is not to benefit performance, but to allow saving a temporary state + // other solutions considered where: + // 1. $_SESSION - not good due to page_cache, + // 2. variable table - entries might get stored for too long and provide security risk + $callbacks = array(); + if (($cache = cache_get('magic_tabs_callbacks')) && !empty($cache->data)) { + $callbacks = unserialize($cache->data); + } + $callbacks[$callback] = TRUE; + cache_set('magic_tabs_callbacks', 'cache', serialize($callbacks), CACHE_TEMPORARY); +} + +function magic_tabs_check_callback($callback) { + // check if the callback is in the list of allowed callbacks + if (($cache = cache_get('magic_tabs_callbacks')) && !empty($cache->data)) { + $callbacks = unserialize($cache->data); + return $callbacks[$callback]; + } +} + +/** + * Themeable functions + */ +function theme_magic_tabs($callback, $items, $content) { + return theme('item_list', $items, NULL, 'ul', array('class' => 'tabs')) .'
'. $content .'
'; +} + +/** + * Example callback function + */ +function magic_tabs_example_callback($active = 0, $a1, $a2) { + $tabs[] = array( + 'title' => t('First magic tab'), + 'content' => t('%param: Content of first magic tab', array('%param' => $a1)), + ); + $tabs[] = array( + 'title' => t('Second magic tab'), + 'content' => t('%param: Content of the second magic tab', array('%param' => $a2)), + ); + $tabs[] = array( + 'title' => t('Third magic tab'), + 'content' => ($active == 2 || $active == -1) ? magic_tabs_get('magic_tabs_inline_callback') : '', + ); + /* + ** Uncomment to display a custom block with $bid==2 + */ + /* + $bid = 2; + $block = (object)module_invoke('block', 'block', 'view', $bid); + $block->module = 'block'; + $block->delta = $bid; + $tabs[] = array( + 'title' => t('Display a custom block'), + 'content' => theme('block', $block), + ); + */ + return $tabs; +} + +function magic_tabs_inline_callback() { + $tabs[] = array( + 'title' => t('First nested magic tab'), + 'content' => t('Content of first nested magic tab'), + ); + $tabs[] = array( + 'title' => t('2nd nested magic tab'), + 'content' => t('Content of the second nested magic tab'), + ); + return $tabs; +} + +/** + * return TRUE if this is an ajax call + * + * Only the first call to this function returns TRUE for ajax calls. + * This is used so inline tabs work inside an ajax called outer tab + */ +function _magic_tabs_first_time_ajax() { + static $ajax; + + if ($ajax) { + return FALSE; + } + + $ajax = ($_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'); + return $ajax; +}