ContextHelpManager Class Reference

Public Member Functions
	ContextHelpManager ()
	getHelp ($form, $field)
	getCriteria ($form, $field)
	getTitle ($form, $field)
	getContextHelpRecords ($obj)
	formatLinks ($form, $field)

Static Public Member Functions
static	getInstance ()
static	setDefaults ()
static	upgradeComponent ($version)
static	onInitialize ()
static	registerSerializationHandler ()

Public Attributes
	$classes
	$nonmatches

Static Public Attributes
static	$_instance

Detailed Description

Definition at line 56 of file context_help.inc.

Member Function Documentation

ContextHelpManager()

ContextHelpManager::ContextHelpManager

(

)

Definition at line 80 of file context_help.inc.

     {
          $this->classes = array();
          $this->nonmatches = array();  
          $this->contextHelpLabel = Settings::getValue("context_help", "context_help_label");
          $this->criteriaHelpLabel = Settings::getValue("context_help", "criterial_help_label");
          $this->showTitle = Settings::getValue("context_help", "show_title");
     }

formatLinks()

ContextHelpManager::formatLinks	(		$form,
			$field
	)

Definition at line 160 of file context_help.inc.

     {
          $help = $this->getHelp($form, $field);
          $criteria = $this->getCriteria($form, $field);
          $title = $this->getTitle($form, $field);
          
          $links = "";
          $text = "";
                    
          if ($help)
          {
               $links .= "<a class=\"context_link\" href=\"javascript:toggleContextHelp('help-{$field}');\" onmouseover=\"showContextHelp('help-{$field}');\" onmouseout=\"hideContextHelp('help-{$field}');\">{$this->contextHelpLabel}</a>&nbsp;";
               $text  .= "<div id=\"help-$field\" class=\"contexthelp\">\n";
               if ($this->showTitle) 
               {
                    $text  .= "<p id=\"heading-$field\">$title Help</p>\n";
               }
               $text  .= $help;
               $text  .= "</div>\n";
          }
          
          if ($criteria)
          {
               $links .= "<a class=\"context_link\" href=\"javascript:toggleContextHelp('criteria-{$field}');\" onmouseover=\"showContextHelp('criteria-{$field}');\" onmouseout=\"hideContextHelp('criteria-{$field}');\">{$this->criteriaHelpLabel}</a>";
               $text  .= "<div id=\"criteria-$field\" class=\"contexthelp\">\n";
               if ($this->showTitle)
               {
                    $text  .= "<h2 id=\"heading-$field\">$title Criteria</h2>\n";
               }
               $text  .= $criteria;
               $text  .= "</div>\n";
          }
          
          return "{$links}\n{$text}";
     }

getContextHelpRecords()

ContextHelpManager::getContextHelpRecords

(

$obj

)

Definition at line 137 of file context_help.inc.

     {
          $cl = $obj->contextHelpProxy ? $obj->contextHelpProxy : get_class($obj);
          
          if ($this->nonmatches[$cl]) return null;
          
          if ($this->classes[$cl])
          {
               return $this->classes[$cl];
          }
          
          $records = indexedQuery(ContextHelp, "WHERE class_name='$cl'", "field");
          if ($records)
          {
               $this->classes[$cl] = $records;
          }
          else
          {
               $this->nonmatches[$cl] = true;
          }
          return $records;
     }

getCriteria()

ContextHelpManager::getCriteria	(		$form,
			$field
	)

Definition at line 103 of file context_help.inc.

     {
          $obj = $form->data;
          $records = $this->getContextHelpRecords($obj);
          if (!$records) return null;
          
          if (array_key_exists($field, $records))
          {
               return $records[$field]->criteria;
          }
          
          return null;        
     }

getHelp()

ContextHelpManager::getHelp	(		$form,
			$field
	)

Definition at line 89 of file context_help.inc.

     {
          $obj = $form->data;
          $records = $this->getContextHelpRecords($obj);
          if (!$records) return null;
          
          if (array_key_exists($field, $records))
          {
               return $records[$field]->help;
          }
          
          return null;
     }

getInstance()

static ContextHelpManager::getInstance ( )

static

Definition at line 63 of file context_help.inc.

     {
          if (!ContextHelpManager::$_instance)
          {
               ContextHelpManager::$_instance = new ContextHelpManager();
          }
 
          return ContextHelpManager::$_instance;
     }

getTitle()

ContextHelpManager::getTitle	(		$form,
			$field
	)

Definition at line 117 of file context_help.inc.

     {
          $title = null;
          $obj = $form->data;
          $records = $this->getContextHelpRecords($obj);
          if (!$records) return null;
          
          if (array_key_exists($field, $records))
          {
               $title = $records[$field]->title;
          }
          
          if (!$title)
          {
               $title = $form->prettifyFieldName($field);
          }
          
          return $title;      
     }

onInitialize()

static ContextHelpManager::onInitialize ( )

static

Definition at line 202 of file context_help.inc.

     {
          global $auto_form_defaults;
          
          $auto_form_defaults["onFormatLabel"] = "addContextHelp";
     }

registerSerializationHandler()

static ContextHelpManager::registerSerializationHandler ( )

static

Definition at line 209 of file context_help.inc.

     {
          SerializationManager::registerHandler("context_help", "Context Help", new ContextHelpSerializationHandler());
          return true;
     }    

setDefaults()

static ContextHelpManager::setDefaults ( )

static

Definition at line 73 of file context_help.inc.

     {
          Settings::setDefaultValue("context_help", "context_help_label", "(?)", String, "Text to display for context help links (HTML is ok)");
          Settings::setDefaultValue("context_help", "criteria_help_label", "(criteria)", String, "Text to display for criteria help links (HTML is ok)");
          Settings::setDefaultValue("context_help", "show_title", true, Boolean, "Show the title heading in context help popups");
     }

upgradeComponent()

static ContextHelpManager::upgradeComponent (   $version )

static

Definition at line 196 of file context_help.inc.

     {
          $mgr = new ContextHelpUpgradeManager();
          $mgr->upgrade($version);
     }         

Member Data Documentation

$_instance

ContextHelpManager::$_instance

static

Definition at line 58 of file context_help.inc.

$classes

ContextHelpManager::$classes

Definition at line 60 of file context_help.inc.

$nonmatches

ContextHelpManager::$nonmatches

Definition at line 61 of file context_help.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/context_help/context_help.inc