[ Index ]

PHP Cross Reference of Drupal 6 (yi-drupal)

title

Body

[close]

/sites/all/modules/ctools/includes/ -> menu.inc (summary)

(no description)

File Size: 499 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions

  ctools_menu_add_tab()
  ctools_get_menu_trail()
  ctools_menu_tree_page_data()
  ctools_menu_set_trail_parent()
  ctools_theme_menu_local_tasks()
  ctools_menu_primary_local_tasks()
  ctools_menu_secondary_local_tasks()
  ctools_menu_local_tasks()
  ctools_menu_sort()
  ctools_menu_help()
  ctools_menu_get_active_help()
  ctools_menu_tab_root_path()
  ctools_garland_menu_local_tasks()
  _ctools_menu_add_dynamic_items()

Functions
Functions that are not part of a class:

ctools_menu_add_tab($link = NULL)   X-Ref
Dynamically add a tab to the current path.

This function allows you to dynamically add tabs to the current path.
There are several important considerations to this:

- First, Drupal doesn't really allow this. CTools lets this happen by
overriding the theme function that displays the tabs. That means that
custom themes which do not use CTools functions will not get the new
tabs. You can provide instructions to your users about how to deal with
this, but you should be prepared for some users not getting the new tabs
and not knowing why.
- Second, if there is only 1 tab, Drupal will not show it. Therefore, if
you are only adding one tab, you should find a way to make sure there is
already tab, or instead add 2.
- Third, the caller is responsible for providing access control to these
links.

param: $link

ctools_get_menu_trail($path = NULL)   X-Ref
CTools replacement for menu_get_menu_trail that allows us to take apart
the menu trail if necessary.


ctools_menu_tree_page_data($item, $menu_name = 'navigation')   X-Ref
Get the data structure representing a named menu tree, based on the current page.

The tree order is maintained by storing each parent in an individual
field, see http://drupal.org/node/141866 for more.

param: $menu_name
return:

ctools_menu_set_trail_parent($path)   X-Ref
No description

ctools_theme_menu_local_tasks()   X-Ref
An alternative to theme_menu_local_tasks to add flexibility to tabs.

The code in theme_menu_local_tasks has no entry points to put hooks.
Therefore, what CTools does is, if that theme function is not overridden,
it uses hook_theme_registry_alter() to use its own version. This version
then allows modules to use ctools_menu_add_local_task() to add a dynamic
local task to the list.

If a theme *does* override theme_menu_local_tasks, it can still get this
functionality by using ctools versions of menu_primary_local_tasks() and
menu_secondary_local_tasks().

ctools_menu_primary_local_tasks()   X-Ref
CTools variant of menu_primary_local_tasks().

This can be called by themes which implement their own theme_menu_local_tasks
in order to get local tasks that include CTools' additions.

ctools_menu_secondary_local_tasks()   X-Ref
CTools variant of menu_secondary_local_tasks().

This can be called by themes which implement their own theme_menu_local_tasks
in order to get local tasks that include CTools' additions.

ctools_menu_local_tasks($level = 0, $return_root = FALSE)   X-Ref
CTools' variant of menu_local_tasks.

This function is a new version of menu_local_tasks that is meant to be more
flexible and allow for modules to dynamically add items to the local tasks
using a simple function.

One downside to using this is that the code to build the tabs could be run
twice on a page if something

ctools_menu_sort($a, $b)   X-Ref
Re-sort menu items after we have modified them.


ctools_menu_help()   X-Ref
Theme override to use CTools to call help instead of the basic call.

This is used only to try and improve performance; this calls through to
the same functions that tabs do and executes a complex build. By overriding
this to use the CTools version, we can prevent this query from being run
twice on the same page.

ctools_menu_get_active_help()   X-Ref
CTools' replacement for ctools_menu_get_active_help()


ctools_menu_tab_root_path()   X-Ref
CTools' replacement for menu_tab_root_path()


ctools_garland_menu_local_tasks()   X-Ref
Returns the rendered local tasks. The default implementation renders
them as tabs. Overridden to split the secondary tasks.


_ctools_menu_add_dynamic_items(&$links)   X-Ref
No description



Generated: Mon Jul 9 18:01:44 2012 Cross-referenced by PHPXref 0.7