[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

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

(no description)

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

Defines 17 functions

  ctools_plugin_api_info()
  ctools_plugin_api_include()
  ctools_get_plugins()
  ctools_plugin_load_includes()
  ctools_plugin_get_directories()
  _ctools_list_themes()
  ctools_find_base_themes()
  ctools_plugin_load_hooks()
  ctools_plugin_process()
  _ctools_process_data()
  ctools_plugin_process_info()
  ctools_plugin_get_info()
  ctools_plugin_get_function()
  ctools_plugin_load_function()
  ctools_plugin_get_class()
  ctools_plugin_load_class()
  ctools_plugin_sort()

Functions
Functions that are not part of a class:

ctools_plugin_api_info($owner, $api, $minimum_version, $current_version)   X-Ref
Get an array of information about modules that support an API.

This will ask each module if they support the given API, and if they do
it will return an array of information about the modules that do.

This function invokes hook_ctools_api. This invocation is statically
cached, so feel free to call it as often per page run as you like, it
will cost very little.

This function can be used as an alternative to module_implements and can
thus be used to find a precise list of modules that not only support
a given hook (aka 'api') but also restrict to only modules that use
the given version. This will allow multiple modules moving at different
paces to still be able to work together and, in the event of a mismatch,
either fall back to older behaviors or simply cease loading, which is
still better than a crash.

param: $owner
param: $api
param: $minimum_version
param: $current_version
return:

ctools_plugin_api_include($owner, $api, $minimum_version, $current_version)   X-Ref
Load a group of API files.

This will ask each module if they support the given API, and if they do
it will load the specified file name. The API and the file name
coincide by design.

param: $owner
param: $api
param: $minimum_version
param: $current_version
return:

ctools_get_plugins($module, $type, $id = NULL)   X-Ref
Fetch a group of plugins by name.

param: $module
param: $type
param: $id
return:

ctools_plugin_load_includes($info, $filename = NULL)   X-Ref
Load plugins from a directory.

param: $info
param: $file
return:

ctools_plugin_get_directories($info)   X-Ref
Get a list of directories to search for plugins of the given type.

This utilizes hook_ctools_plugin_directory() to determine a complete list of
directories. Only modules that implement this hook and return a string
value will have their directories included.

param: $info
return: array $directories

_ctools_list_themes()   X-Ref
Helper function to build a ctools-friendly list of themes capable of
providing plugins.

return: array $themes

ctools_find_base_themes($themes, $key, $used_keys = array()   X-Ref
Find all the base themes for the specified theme.

Themes can inherit templates and function implementations from earlier themes.

NOTE: this is a verbatim copy of system_find_base_themes(), which was not
implemented until 6.14. It is included here only as a fallback for outdated
versions of drupal core.

param: $themes
param: $key
param: $used_keys
return:

ctools_plugin_load_hooks($info)   X-Ref
Load plugin info for the provided hook; this is handled separately from
plugins from files.

param: $info
return:

ctools_plugin_process($info, $module, $identifier, $path, $file = NULL, $base = NULL)   X-Ref
Process a single hook implementation of a ctools plugin.

param: $info
param: $module
param: $identifier
param: $path
param: $file
param: $base

_ctools_process_data($result, $info, $module, $path, $file)   X-Ref
Fill in default values and run hooks for data loaded for one or
more plugins.


ctools_plugin_process_info($info, $module, $file)   X-Ref
Process an info file for plugin information, rather than a hook.


ctools_plugin_get_info($module, $type)   X-Ref
Ask a module for info about a particular plugin type.


ctools_plugin_get_function($plugin_definition, $function_name)   X-Ref
Get a function from a plugin, if it exists. If the plugin is not already
loaded, try ctools_plugin_load_function() instead.

param: $plugin_definition
param: $function_name
return:

ctools_plugin_load_function($module, $type, $id, $function_name)   X-Ref
Load a plugin and get a function name from it, returning success only
if the function exists.

param: $module
param: $type
param: $id
param: $function_name
return:

ctools_plugin_get_class($plugin_definition, $class_name, $abstract = FALSE)   X-Ref
Get a class from a plugin, if it exists. If the plugin is not already
loaded, try ctools_plugin_load_class() instead.

param: $plugin_definition
param: $class_name
param: $abstract
return:

ctools_plugin_load_class($module, $type, $id, $class_name, $abstract = FALSE)   X-Ref
Load a plugin and get a class name from it, returning success only if the
class exists.

param: $module
param: $type
param: $id
param: $class_name
param: $abstract
return:

ctools_plugin_sort($a, $b)   X-Ref
Sort callback for sorting plugins naturally.

Sort first by weight, then by title.



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