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

Same name and namespace in other branches

1. 7 plugins/crumbs.taxonomy.inc \taxonomy_CrumbsMultiPlugin_termParent::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.

Overrides crumbs_MultiPlugin::describe

File

plugins/crumbs.taxonomy.inc, line 28

Class

taxonomy_CrumbsMultiPlugin_termParent

Code

function describe($api) {
  foreach (taxonomy_get_vocabularies() as $voc) {
    $api
      ->ruleWithLabel($voc->machine_name, $voc->name, t('Vocabulary'));
  }

  // Now set a generic title for the entire plugin.
  $api
    ->descWithLabel(t('The parent term'), t('Parent'));
}