[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/panels/includes/ -> plugins.inc (summary)

(no description)

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

Defines 3 classes

panels_cache_object:: (20 methods):
  panels_cache_object()
  add_content()
  set_content()
  cache()
  restore()
  panels_get_pane_title()
  panels_get_layout()
  panels_get_layouts()
  panels_get_layout_builders()
  panels_get_style()
  panels_get_styles()
  panels_get_cache()
  panels_get_caches()
  panels_get_display_renderer()
  panels_get_display_renderers()
  panels_get_renderer_handler()
  panels_get_renderer()
  _panels_renderer_pipeline_sort()
  panels_get_renderer_pipelines()
  panels_plugin_get_function()

panels_required_context:: (0 methods):

panels_optional_context:: (0 methods):

Defines 0 functions

  panels_pane_access()
  panels_get_regions()
  panels_get_cached_content()
  panels_set_cached_content()
  panels_clear_cached_content()

Class: panels_cache_object  - X-Ref

An object to hold caching information while it is happening.

panels_cache_object()   X-Ref
When constructed, take a snapshot of our existing out of band data.


add_content($content)   X-Ref
Add content to the cache. This assumes a pure stream;
use set_content() if it's something else.


set_content($content)   X-Ref
No description

cache()   X-Ref
Set the object for storing. This overwrites.


restore()   X-Ref
Restore out of band data saved to cache.


panels_get_pane_title(&$pane, $context = array()   X-Ref
Get the title of a pane.

param: $pane

panels_get_layout($layout)   X-Ref
Fetch metadata on a specific layout plugin.

param: $layout
return:

panels_get_layouts()   X-Ref
Fetch metadata for all layout plugins.

return:

panels_get_layout_builders()   X-Ref
Fetch metadata for all layout plugins that provide builders.

The layout builders allow reusable layouts be stored in the database and
exported. Since there are different methods, we are not limiting this
to just one plugin.

return:

panels_get_style($style)   X-Ref
Fetch metadata on a specific style plugin.

param: $style
return:

panels_get_styles()   X-Ref
Fetch metadata for all style plugins.

return:

panels_get_cache($cache)   X-Ref
Fetch metadata on a specific caching plugin.

param: $cache
return:

panels_get_caches()   X-Ref
Fetch metadata for all context plugins.

return:

panels_get_display_renderer($renderer)   X-Ref
Fetch metadata on a specific display renderer plugin.

return:

panels_get_display_renderers()   X-Ref
Fetch metadata for all display renderer plugins.

return:

panels_get_renderer_handler($plugin, &$display)   X-Ref
Get and initialize the class to handle rendering a display.

return:

panels_get_renderer($pipeline_name, &$display)   X-Ref
Choose a renderer for a display based on a render pipeline setting.


_panels_renderer_pipeline_sort($a, $b)   X-Ref
Sort callback for sorting renderer pipelines.

Sort first by weight, then by title.

panels_get_renderer_pipelines($sort = TRUE)   X-Ref
Get a list of available renderer pipelines.

This can be used to form a select or radios widget by enabling
sorting. Descriptions are left in.

panels_plugin_get_function($plugin, $which, $function_name)   X-Ref
Get a function from a plugin, if it exists.

param: $plugin
param: $which
param: $function_name
return:

Class: panels_required_context  - X-Ref

Class: panels_optional_context  - X-Ref

Functions
Functions that are not part of a class:

panels_pane_access($pane, $display)   X-Ref
Determine if a pane is visible.

param: $pane
param: $display

panels_get_regions($layout, $display)   X-Ref
Get a list of panels available in the layout.


panels_get_cached_content($display, $args, $context, $pane = NULL)   X-Ref
Get cached content for a given display and possibly pane.

return:

panels_set_cached_content($cache, $display, $args, $context, $pane = NULL)   X-Ref
Store cached content for a given display and possibly pane.


panels_clear_cached_content($display)   X-Ref
Clear all cached content for a display.




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