function crumbs_PluginOperation_describe::addDescription in Crumbs, the Breadcrumbs suite 7.2

Add a description at an arbitrary wildcard key. To be called from crumbs_InjectedAPI_describeMultiPlugin::addDescription()

Parameters

string $description:

string $key_suffix:

File

lib/PluginOperation/describe.php, line 98

Class

crumbs_PluginOperation_describe

This class uses the PluginOperation pattern, but it does not implement any of the PluginOperation interfaces. This is because it is not supposed to be used with the PluginEngine, but rather from a custom function (see above).

Code

function addDescription($description, $key_suffix) {
  if (isset($key_suffix)) {
    $key = $this->pluginKey . '.' . $key_suffix;
  }
  else {
    $key = $this->pluginKey;
  }
  $this
    ->_addDescription($key, $description);
}