og_blueprints_help Class Reference

List of all members.


Detailed Description

Keeps the main module sleek and clean!

Definition at line 529 of file og_blueprints.module.


Public Member Functions

 __construct ($section)
 help ($function, $location, $bundle=FALSE)
 Handles calls to various help text functions using __call() magic method.

Public Attributes

 $section = ''

Member Function Documentation

og_blueprints_help::__construct ( section  ) 

Parameters:
string $section Indicates the primary helptext section area to be looking in

Definition at line 536 of file og_blueprints.module.

00536                                  {
00537     include_once drupal_get_path('module', 'og_blueprints') . '/helptext.inc';
00538     $this->section = $section;
00539   }

og_blueprints_help::help ( function,
location,
bundle = FALSE 
)

Parameters:
string $function The actual function request entered into the object. Constitutes the last bit of the function that is eventually called.
array $args A variable array of additional arguments passed in by the caller.
Returns:
string A helptext string, already run through t() and ready to be displayed

Definition at line 553 of file og_blueprints.module.

00553                                                               {
00554     if (function_exists($function = "ogbp_help_" . $this->section . "_" . $function)) {
00555       $op = og_blueprints_mode() - ($bundle instanceof og_bundle_typed ? 0 : 1);
00556       $args = func_get_args();
00557       $t_args = array();
00558       $help_text = $function($t_args, $location, $bundle, array_splice($args, 3));
00559       return t($help_text[$op], $t_args[$op]);
00560     }
00561     else return FALSE;
00562   }


Member Data Documentation

og_blueprints_help::$section = ''

Definition at line 530 of file og_blueprints.module.


The documentation for this class was generated from the following file:

Generated on Sun May 18 20:36:51 2008 for Organic Groups Blueprints by  doxygen 1.5.5