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

Same name and namespace in other branches

1. 7 crumbs.module \crumbs_MultiPlugin::describe()

Parameters

crumbs_InjectedAPI_describeMultiPlugin $api: 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.

11 methods override crumbs_MultiPlugin::describe()

crumbs_example_CrumbsMultiPlugin_ListOfNews::describe in example/lib/CrumbsMultiPlugin/ListOfNews.php

crumbs_MultiPlugin_EntityFindSomething::describe in lib/MultiPlugin/EntityFindSomething.php

crumbs_MultiPlugin_LegacyWrapper::describe in lib/MultiPlugin/LegacyWrapper.php

menu_CrumbsMultiPlugin_hierarchy::describe in plugins/crumbs.menu.inc

menu_CrumbsMultiPlugin_link_title::describe in plugins/crumbs.menu.inc

... See full list

File

lib/MultiPlugin.php, line 21

Class

crumbs_MultiPlugin

Interface for plugin objects registered with hook_crumbs_plugins().

Code

function describe($api);