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

Same name in this branch

1. 7.2 plugins/crumbs.og.inc \og_CrumbsMultiPlugin_groups_overview::describe()
2. 7.2 plugins/crumbs.og.2.inc \og_CrumbsMultiPlugin_groups_overview::describe()

Same name and namespace in other branches

1. 7 plugins/crumbs.og.inc \og_CrumbsMultiPlugin_groups_overview::describe()
2. 7 plugins/crumbs.og.2.inc \og_CrumbsMultiPlugin_groups_overview::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.og.2.inc, line 137

Class

og_CrumbsMultiPlugin_groups_overview

Make $groups_overview_path the parent path for group nodes. The priorities can be configured per group node type.

Code

function describe($api) {
  if (is_array($this->groupsOverviewPaths)) {
    foreach ($this->groupsOverviewPaths as $type => $parent_path) {
      $api
        ->addRule($type);
    }
  }
  else {
    $types = node_type_get_types();
    foreach ($types as $type) {
      if (og_is_group_type('node', $type->type)) {
        $api
          ->addRule($type->type);
      }
    }
  }
}