interface crumbs_MultiPlugin in Crumbs, the Breadcrumbs suite 7

Interface for plugin objects registered with hook_crumbs_plugins().

Hierarchy

• interface \crumbs_MultiPlugin

File

./crumbs.module, line 634

Provides an API for building breadcrumbs.

interface crumbs_MultiPlugin {

  /**
   * @param $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
   *   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.
   */
  function describe($api);

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_MultiPlugin::describe		function		13