You are here

function crumbs_MultiPlugin::describe in Crumbs, the Breadcrumbs suite 7

Same name and namespace in other branches
  1. 7.2 lib/MultiPlugin.php \crumbs_MultiPlugin::describe()

Parameters

$api :crumbs_InjectedAPI_describeMultiPlugin: Injected API object, with methods that allow the plugin to further describe itself. The plugin is supposed to tell Crumbs about all possible rule keys, and can give a label and a description for each.

Return value

As an alternative to the API object's methods, the plugin can simply return a key-value array, where the keys are the available rules, and the values are their respective labels.

13 methods override crumbs_MultiPlugin::describe()
crumbs_CrumbsMultiPlugin_nodeParent::describe in plugins/crumbs.crumbs.inc
crumbs_example_CrumbsMultiPlugin_ListOfNews::describe in example/lib/CrumbsMultiPlugin/ListOfNews.php
entityreference_prepopulate_CrumbsMultiPlugin_node::describe in plugins/crumbs.entityreference_prepopulate.inc
menu_CrumbsMultiPlugin_hierarchy::describe in plugins/crumbs.menu.inc
menu_CrumbsMultiPlugin_link_title::describe in plugins/crumbs.menu.inc

... See full list

File

./crumbs.module, line 648
Provides an API for building breadcrumbs.

Class

crumbs_MultiPlugin
Interface for plugin objects registered with hook_crumbs_plugins().

Code

function describe($api);