MergeCodeHelp Class Reference

Inherits DataItem.

Public Member Functions
	MergeCodeHelp ()

Static Public Member Functions
static	getHelp ()

Public Attributes
	$fields

Detailed Description

Definition at line 90 of file merge_code.inc.

Member Function Documentation

getHelp()

static MergeCodeHelp::getHelp ( )

static

Definition at line 105 of file merge_code.inc.

     {
          $helps = array();
          $help = new MergeCodeHelp();
          $help->usage = "To get a <b>field</b> in the sending class object, a merge code record is not needed; use '[field_name]' as the merge code";
          $help->example = "N/A";
          $helps[0] = $help;
     
          $help = new MergeCodeHelp();
          $help->usage = "To get a <b>field</b> in a <b>related</b> class object, enter the related class name as defined in the DataModel. Use the dot separator to link to the field name. The map does not allow links to relations of relations.";
          $help->example = "MyRelation.my_field";
          $helps[1] = $help;
 
          $help = new MergeCodeHelp();
          $help->usage = "To get a value from a <b>function</b> in the DataModel of the sending class, enter the function name.";
          $help->example = "myFunction";
          $helps[2] = $help;
 
          $help = new MergeCodeHelp();
          $help->usage = "To get a value from a <b>function</b> in a <b>related</b> class, enter the related class name as defined in the DataModel with a dot separator and function name. The map does not allow links to relations of relations.";
          $help->example = "MyRelation.myFunction";
          $helps[3] = $help;
 
          $help = new MergeCodeHelp();
          $help->usage = "To get a value from a <b>callback</b> function, the map must state the name of the function. The function must be available from the calling script. The callback function will receive the sending object as a parameter.";
          $help->example = "myCallbackFunction";
          $helps[4] = $help;
          
          $help = new MergeCodeHelp();
          $help->usage = "To get a value from a static <b>function</b> of a <b>non-DataItem</b> class, enter the class name, dot separator, and static function name. The class definition must be included in the calling script. The static function will receive the sending object as a parameter.";
          $help->example = "myClassName.myStaticFunction";
          $helps[5] = $help;
          
          return $helps;
     }

MergeCodeHelp()

MergeCodeHelp::MergeCodeHelp

(

)

Definition at line 98 of file merge_code.inc.

     {
          $this->table = "merge_code";
          $this->primary_key = "help_id";    
 
     }

Member Data Documentation

$fields

MergeCodeHelp::$fields

Initial value:

= array(
               "help_id" =>   Number,
               "usage"        =>   String,
               "example" =>   String
     )

Definition at line 92 of file merge_code.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/email/datamodel/merge_code.inc