[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/features/ -> features.api.php (summary)

(no description)

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

Defines 17 functions

  hook_features_api()
  hook_features_export()
  hook_features_export_options()
  hook_features_export_render()
  hook_features_export_revert()
  hook_features_export_rebuild()
  hook_features_export_alter()
  hook_features_pipe_component_alter()
  hook_content_default_fields_alter()
  hook_fieldgroup_default_groups_alter()
  hook_filter_default_formats_alter()
  hook_menu_default_menu_custom_alter()
  hook_menu_default_menu_links_alter()
  hook_menu_default_items_alter()
  hook_taxonomy_default_vocabularies_alter()
  hook_user_default_permissions_alter()
  hook_user_default_roles_alter()

Functions
Functions that are not part of a class:

hook_features_api()   X-Ref
Main info hook that features uses to determine what components are provided
by the implementing module.

return: array

hook_features_export($data, &$export, $module_name)   X-Ref
Component hook. The hook should be implemented using the name ot the
component, not the module, eg. [component]_features_export() rather than
[module]_features_export().

Process the export array for a given component. Implementations of this hook
have three key tasks:

1. Determine module dependencies for any of the components passed to it
e.g. the views implementation iterates over each views' handlers and
plugins to determine which modules need to be added as dependencies.

2. Correctly add components to the export array. In general this is usually
adding all of the items in $data to $export['features']['my_key'], but
can become more complicated if components are shared between features
or modules.

3. Delegating further detection and export tasks to related or derivative
components.

Each export processor can kickoff further export processors by returning a
keyed array (aka the "pipe") where the key is the next export processor hook
to call and the value is an array to be passed to that processor's $data
argument. This allows an export process to start simply at a few objects:

[context]

And then branch out, delegating each component to its appropriate hook:

[context]--------+------------+
|            |            |
[node]      [block]      [views]
|
[CCK]
|
[imagecache]

param: array $data
param: array &$export
param: string $module_name
return: array

hook_features_export_options()   X-Ref
Component hook. The hook should be implemented using the name ot the
component, not the module, eg. [component]_features_export() rather than
[module]_features_export().

List all objects for a component that may be exported.

return: array

hook_features_export_render($module_name, $data, $export = NULL)   X-Ref
Component hook. The hook should be implemented using the name ot the
component, not the module, eg. [component]_features_export() rather than
[module]_features_export().

Render one or more component objects to code.

param: string $module_name
param: array $data
param: array $export
return: array

hook_features_export_revert($module_name)   X-Ref
Component hook. The hook should be implemented using the name ot the
component, not the module, eg. [component]_features_export() rather than
[module]_features_export().

Revert all component objects for a given feature module.

param: string $module_name
return: boolean

hook_features_export_rebuild($module_name)   X-Ref
Component hook. The hook should be implemented using the name ot the
component, not the module, eg. [component]_features_export() rather than
[module]_features_export().

Rebuild all component objects for a given feature module. Should only be
implemented for 'faux-exportable' components.

This hook is called at points where Features determines that it is safe
(ie. the feature is in state `FEATURES_REBUILDABLE`) for your module to
replace objects in the database with defaults that you collect from your
own defaults hook. See API.txt for how Features determines whether a
rebuild of components is possible.

param: string $module_name

hook_features_export_alter(&$export, $module_name)   X-Ref
Alter the final export array just prior to the rendering of defaults. Allows
modules a final say in altering what component objects are exported.

param: array &$export
param: array $module_name

hook_features_pipe_component_alter(&$pipe, $data, $export, $module_name)   X-Ref
Alter the pipe array for a given component. This hook should be implemented
with the name of the component type in place of `component` in the function
name, e.g. `features_pipe_views_alter()` will alter the pipe for the Views
component.

param: array &$pipe
param: array $data
param: array &$export
param: string $module_name

hook_content_default_fields_alter(&$fields)   X-Ref
Alter the default cck fields right before they are cached into the database.

param: &$fields

hook_fieldgroup_default_groups_alter(&$groups)   X-Ref
Alter the default fieldgroup groups right before they are cached into the
database.

param: &$groups

hook_filter_default_formats_alter(&$formats)   X-Ref
Alter the default filter formats right before they are cached into the
database.

param: &$formats

hook_menu_default_menu_custom_alter(&$menus)   X-Ref
Alter the default menus right before they are cached into the database.

param: &$menus

hook_menu_default_menu_links_alter(&$links)   X-Ref
Alter the default menu links right before they are cached into the database.

param: &$links

hook_menu_default_items_alter(&$items)   X-Ref
Alter the default menu items right before they are cached into the database.

param: &$items

hook_taxonomy_default_vocabularies_alter(&$vocabularies)   X-Ref
Alter the default vocabularies right before they are cached into the
database.

param: &$vocabularies

hook_user_default_permissions_alter(&$permissions)   X-Ref
Alter the default permissions right before they are cached into the
database.

param: &$permissions

hook_user_default_roles_alter(&$roles)   X-Ref
Alter the default roles right before they are cached into the database.

param: &$roles



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