[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/ctools/page_manager/ -> page_manager.module (summary)

(no description)

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

Defines 53 functions

  page_manager_perm()
  page_manager_ctools_plugin_directory()
  page_manager_menu()
  page_manager_menu_alter()
  page_manager_theme()
  page_manager_get_page_cache()
  page_manager_set_page_cache()
  page_manager_clear_page_cache()
  page_manager_save_page_cache()
  page_manager_cache_load()
  page_manager_handler_get_name()
  page_manager_handler_add_to_page()
  page_manager_load_task_handler()
  page_manager_load_task_handlers()
  page_manager_get_default_task_handlers()
  page_manager_compare_task_handlers()
  page_manager_load_sorted_handlers()
  page_manager_sort_task_handlers()
  page_manager_save_task_handler()
  page_manager_delete_task_handler()
  page_manager_export_task_handler()
  page_manager_new_task_handler()
  page_manager_update_task_handler_weight()
  page_manager_get_tasks()
  page_manager_get_task()
  page_manager_get_tasks_by_type()
  page_manager_get_task_subtasks()
  page_manager_get_task_subtask()
  page_manager_get_task_handlers()
  page_manager_get_task_handler()
  page_manager_get_task_handler_plugins()
  page_manager_get_handler_title()
  page_manager_get_handler_summary()
  page_manager_get_page_summary()
  page_manager_get_task_id()
  page_manager_make_task_name()
  page_manager_get_renderer()
  pm_arg_load()
  pm_arg_tail_load()
  pm_uid_arg_load()
  pm_uid_arg_to_arg()
  page_manager_page_ctools_access_get()
  page_manager_page_ctools_access_set()
  page_manager_task_handler_ctools_access_get()
  page_manager_context_cache_get()
  page_manager_context_cache_set()
  page_manager_task_handler_ctools_access_set()
  page_manager_edit_url()
  page_manager_menu_link_alter()
  page_manager_page_manager_handlers_list()
  page_manager_page_manager_pages_to_hook_code()
  page_manager_get_current_page()
  page_manager_panels_dashboard_blocks()

Functions
Functions that are not part of a class:

page_manager_perm()   X-Ref
Implementation of hook_perm().


page_manager_ctools_plugin_directory($owner, $plugin_type)   X-Ref
Implementation of hook_ctools_plugin_directory() to let the system know
where our task and task_handler plugins are.


page_manager_menu()   X-Ref
Delegated implementation of hook_menu().


page_manager_menu_alter(&$items)   X-Ref
Implementation of hook_menu_alter.

Get a list of all tasks and delegate to them.

page_manager_theme()   X-Ref
No description

page_manager_get_page_cache($task_name)   X-Ref
Get the cached changes to a given task handler.


page_manager_set_page_cache($page)   X-Ref
Store changes to a task handler in the object cache.


page_manager_clear_page_cache($name)   X-Ref
Remove an item from the object cache.


page_manager_save_page_cache($cache)   X-Ref
Write all changes from the page cache and clear it out.


page_manager_cache_load($task_name)   X-Ref
Menu callback to load a page manager cache object for menu callbacks.


page_manager_handler_get_name($task_name, $handlers, $handler)   X-Ref
Generate a unique name for a task handler.

Task handlers need to be named but they aren't allowed to set their own
names. Instead, they are named based upon their parent task and type.

page_manager_handler_add_to_page(&$page, &$handler, $title = NULL)   X-Ref
Import a handler into a page.

This is used by both import and clone, since clone just exports the
handler and immediately imports it.

page_manager_load_task_handler($task, $subtask_id, $name)   X-Ref
Load a single task handler by name.

Handlers can come from multiple sources; either the database or by normal
export method, which is handled by the ctools library, but handlers can
also be bundled with task/subtask. We have to check there and perform
overrides as appropriate.

Handlers bundled with the task are of a higher priority than default
handlers provided by normal code, and are of a lower priority than
the database, so we have to check the source of handlers when we have
multiple to choose from.

page_manager_load_task_handlers($task, $subtask_id = NULL, $default_handlers = NULL)   X-Ref
Load all task handlers for a given task/subtask.


page_manager_get_default_task_handlers($task, $subtask_id)   X-Ref
Get the default task handlers from a task, if they exist.

Tasks can contain 'default' task handlers which are provided by the
default task. Because these can come from either the task or the
subtask, the logic is abstracted to reduce code duplication.

page_manager_compare_task_handlers($result, $handlers, $name)   X-Ref
Compare a single task handler from two lists and provide the correct one.

Task handlers can be gotten from multiple sources. As exportable objects,
they can be provided by default hooks and the database. But also, because
they are tightly bound to tasks, they can also be provided by default
tasks. This function reconciles where to pick up a task handler between
the exportables list and the defaults provided by the task itself.

param: $result
param: $handlers
param: $name
return:

page_manager_load_sorted_handlers($task, $subtask_id = NULL, $enabled = FALSE)   X-Ref
Load all task handlers for a given task and subtask and sort them.


page_manager_sort_task_handlers($a, $b)   X-Ref
Callback for uasort to sort task handlers.

Task handlers are sorted by weight then by name.

page_manager_save_task_handler(&$handler)   X-Ref
Write a task handler to the database.


page_manager_delete_task_handler($handler)   X-Ref
Remove a task handler.


page_manager_export_task_handler($handler, $indent = '')   X-Ref
Export a task handler into code suitable for import or use as a default
task handler.


page_manager_new_task_handler($plugin)   X-Ref
Create a new task handler object.

param: $plugin

page_manager_update_task_handler_weight($handler, $weight)   X-Ref
Set an overidden weight for a task handler.

We do this so that in-code task handlers don't need to get written
to the database just because they have their weight changed.

page_manager_get_tasks()   X-Ref
Shortcut function to get task plugins.


page_manager_get_task($id)   X-Ref
Shortcut function to get a task plugin.


page_manager_get_tasks_by_type($type)   X-Ref
Get all tasks for a given type.


page_manager_get_task_subtasks($task)   X-Ref
Fetch all subtasks for a page managertask.

param: $task

page_manager_get_task_subtask($task, $subtask_id)   X-Ref
Fetch all subtasks for a page managertask.

param: $task
param: $subtask_id

page_manager_get_task_handlers()   X-Ref
Shortcut function to get task handler plugins.


page_manager_get_task_handler($id)   X-Ref
Shortcut function to get a task handler plugin.


page_manager_get_task_handler_plugins($task, $all = FALSE)   X-Ref
Retrieve a list of all applicable task handlers for a given task.

This looks at the $task['handler type'] and compares that to $task_handler['handler type'].
If the task has no type, the id of the task is used instead.

page_manager_get_handler_title($plugin, $handler, $task, $subtask_id)   X-Ref
Get the title for a given handler.

If the plugin has no 'admin title' function, the generic title of the
plugin is used instead.

page_manager_get_handler_summary($plugin, $handler, $page, $title = TRUE)   X-Ref
Get the admin summary (additional info) for a given handler.


page_manager_get_page_summary($task, $subtask)   X-Ref
Get the admin summary (additional info) for a given page.


page_manager_get_task_id($task_name)   X-Ref
Split a task name into a task id and subtask id, if applicable.


page_manager_make_task_name($task_id, $subtask_id)   X-Ref
Turn a task id + subtask_id into a task name.


page_manager_get_renderer($handler)   X-Ref
Get the render function for a handler.


pm_arg_load($value, $subtask, $argument)   X-Ref
Page manager arg load function because menu system will not load extra
files for these; they must be in a .module.


pm_arg_tail_load($value, $subtask, $argument, $map)   X-Ref
Special arg_load function to use %menu_tail like functionality to
get everything after the arg together as a single value.


pm_uid_arg_load($value, $subtask, $argument)   X-Ref
Special menu _load() function for the user:uid argument.

This is just the normal page manager argument. It only exists so that
the to_arg can exist.

pm_uid_arg_to_arg($arg)   X-Ref
to_arg function for the user:uid argument to provide the arg for the
current global user.


page_manager_page_ctools_access_get($argument)   X-Ref
Callback for access control ajax form on behalf of page.inc task.

Returns the cached access config and contexts used.

page_manager_page_ctools_access_set($argument, $access)   X-Ref
Callback for access control ajax form on behalf of page.inc task.

Writes the changed access to the cache.

page_manager_task_handler_ctools_access_get($argument)   X-Ref
Callback for access control ajax form on behalf of context task handler.

Returns the cached access config and contexts used.

page_manager_context_cache_get($task_name, $key)   X-Ref
No description

page_manager_context_cache_set($task_name, $key, $object)   X-Ref
No description

page_manager_task_handler_ctools_access_set($argument, $access)   X-Ref
Callback for access control ajax form on behalf of context task handler.

Writes the changed access to the cache.

page_manager_edit_url($task_name, $trail = array()   X-Ref
Form a URL to edit a given page given the trail.


page_manager_menu_link_alter(&$item, $menu)   X-Ref
Watch menu links during the menu rebuild, and re-parent things if we need to.


page_manager_page_manager_handlers_list()   X-Ref
Callback to list handlers available for export.


page_manager_page_manager_pages_to_hook_code($names = array()   X-Ref
Callback to bulk export page manager pages.


page_manager_get_current_page($page = NULL)   X-Ref
Get the current page information.

return: $page

page_manager_panels_dashboard_blocks(&$vars)   X-Ref
Implementation of hook_panels_dashboard_blocks().

Adds page information to the Panels dashboard.



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7