interface crumbs_MultiPlugin_example in Crumbs, the Breadcrumbs suite 7

Pseudo-interface for plugin objects registered with hook_crumbs_plugins(). The methods defined here are all optional. We only use this interface for documentation, no class actually implements it.

Hierarchy

• interface \crumbs_MultiPlugin
  • interface \crumbs_MultiPlugin_example

File

./crumbs.api.php, line 84

interface crumbs_MultiPlugin_example extends crumbs_MultiPlugin {

  /**
   * Specify if some of the rules from describe() are disabled by default,
   * instead of inheriting from the next matching wildcard rule.
   *
   * @return :array
   *   Regular array, where the values identify crumbs rules or wildcards.
   *   Rule keys are relative to the plugin key.
   */
  function disabledByDefault();

  /**
   * @param $path
   *   System path that we want to find a parent for.
   * @param $item
   *   Router item, as returned by menu_get_item(), but with a few convenience
   *   additions added in crumbs_get_router_item().
   *
   * @return
   *   A key-value array, where the keys identify crumbs rules, and the values
   *   are candidates for the parent path.
   *   Rule keys are relative to the plugin key.
   */
  function findParent($path, $item);

  /**
   * Same signature as findParent()
   * Only called for router path node/%
   */
  function findParent__node_x($path, $item);

  /**
   * @param $path
   *   System path of the breadcrumb item that we want to find a link text for.
   * @param $item
   *   Router item, as returned by menu_get_item(), but with a few convenience
   *   additions added in crumbs_get_router_item().
   *
   * @return
   *   A key-value array, where the keys identify crumbs rules, and the values
   *   are candidates for the link title.
   *   Rule keys are relative to the plugin key.
   */
  function findTitle($path, $item);

  /**
   * Same signature as findParent()
   * Only called for router path node/%
   */
  function findTitle__node_x($path, $item);

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_MultiPlugin::describe		function		13
crumbs_MultiPlugin_example::disabledByDefault		function	Specify if some of the rules from describe() are disabled by default, instead of inheriting from the next matching wildcard rule.
crumbs_MultiPlugin_example::findParent		function
crumbs_MultiPlugin_example::findParent__node_x		function	Same signature as findParent() Only called for router path node/%
crumbs_MultiPlugin_example::findTitle		function
crumbs_MultiPlugin_example::findTitle__node_x		function	Same signature as findParent() Only called for router path node/%