MergeCodeManager Class Reference

Public Member Functions
	MergeCodeManager ($item, $inText, $class_name="")
	getMergeCodeValues ($usedMergeCodes)
	getReplaceText ($mergeCodeMap)
	searchAndReplace ($text)

Static Public Member Functions
static	buildMergeCodeTable ($class_name)
static	getDefaultCodes ($obj, $mergeCodes)

Public Attributes
	$item
	$patterns
	$replacements
	$class_name

Detailed Description

Definition at line 58 of file merge_code_manager.inc.

Member Function Documentation

buildMergeCodeTable()

static MergeCodeManager::buildMergeCodeTable (   $class_name )

static

Definition at line 252 of file merge_code_manager.inc.

     {
          $classes = array();
          $classes = ComponentManager::fireEvent("EnumerateDataItemClasses", $classes);
 
          $mergeCodes = Query::create(MergeCode, "WHERE class_name=:cn")
               ->bind(":cn", $class_name)
               ->execute();
 
          if(array_search($class_name, $classes))
          {
               $obj = new $class_name();     
               $mergeCodes = MergeCodeManager::getDefaultCodes($obj, $mergeCodes);
          }
 
          $table = new DataListView($mergeCodes, "mergeCodes");
          $table->column("Code Name", "{name}", false)
                    ->column("Description", "{description}", false)
          ;         
          $table->emptyMessage = "There are no merge codes defined.";
          $table->sortable = false;
          $table->cssStyle = "width: 100%";
          
          return $table;
     }    

getDefaultCodes()

static MergeCodeManager::getDefaultCodes (   $obj,   $mergeCodes  )

static

Definition at line 285 of file merge_code_manager.inc.

     {
          $fields = $obj->getFields();
          if(count($fields) > 0)
          {
               foreach($fields as $name => $type)
               {
                    if(preg_match("/_id/", $name) || preg_match("/composite/", $name) 
                         || preg_match("/password/", $name) || $type == Boolean)
                         continue;
               
                    $mCode = new MergeCode();
                    $mCode->name = $name;
                    $mCode->map = "N/A";
                    $mCode->description = $type ." field in ". get_class($obj);
                    $mergeCodes[] = $mCode;
               }    
          }
          return $mergeCodes;
     }

getMergeCodeValues()

MergeCodeManager::getMergeCodeValues

(

$usedMergeCodes

)

Definition at line 99 of file merge_code_manager.inc.

     {    
          if(count($usedMergeCodes) > 0)
          {
               $used = strip_tags("'". implode("','", array_values($usedMergeCodes)) . "'");
          
               $mergeCodes = Query::create(MergeCode, "WHERE class_name = :cn and name in ($used)")
                    ->bind(":cn", $this->class_name)
                    ->execute();
          }
          
          if(count($mergeCodes) > 0)
               $indexed = reindexList($mergeCodes, "name");
          else
               $indexed = array();
     
          if(count($usedMergeCodes) == 0)
          {
               trace("MergeCodeManager:: no merge codes used.", 3);
               return;
          }
          
          $patterns = array();
          $replacements = array();
                    
          foreach($usedMergeCodes as $idx => $name)
          {
               $clean_name = strip_tags($name);
               if(array_key_exists($clean_name, $indexed))
                    $mergeCode = $indexed[$clean_name];
               else
               {
                    $mergeCode = new MergeCode();
                    $mergeCode->map = $clean_name;
               } 
               
               $map = ($mergeCode) ? $mergeCode->map : $clean_name;
               
               trace("MergeCodeManager:: map is $map", 3);
                    
               if($map)
                    $replaceText = $this->getReplaceText($map);
          
               array_push($patterns, "[$name]");
               array_push($replacements, $replaceText);
          }
          
          $this->patterns = $patterns;
          $this->replacements = $replacements;
     }

getReplaceText()

MergeCodeManager::getReplaceText

(

$mergeCodeMap

)

Definition at line 166 of file merge_code_manager.inc.

     {    
          $valid = true;
                         
          list($part1, $part2) = explode(".", $mergeCodeMap);
 
          trace("MergeCodeManager::part1 is $part1 and part2 is $part2", 3);
               
          if(get_class($this->item) == $part1)
          {
               trace("MergeCodeManager::part1 equals item class", 3);
               $part1 = $part2;
               $part2 = "";
          }              
                    
          if($part2)
          {
               if($this->item->hasRelation($part1))
               {
                    $replaceObj = $this->item->$part1();
                    if(is_object($replaceObj) && $replaceObj->hasField($part2))
                    {
                         trace("MergeCodeManager:: part1 is relation and part2 is a field in that related class.", 3);
                         $replaceText = $replaceObj->format("{".$part2 ."}");
                    }
                    elseif(is_callable(array($replaceObj, $part2)))
                    {
                         trace("MergeCodeManager:: part1 is relation of sending class and part2 is a function in that relation.", 3);
                         $replaceText = $replaceObj->$part2();
                    }    
                    else
                    {
                         $valid = false;
                    }
               }
               elseif(is_callable(array($part1, $part2)))
               {
                    trace("MergeCodeManager:: part1 is class and part2 is static function of a class.", 3);
                    $replaceText = call_user_func(array($part1, $part2), $this->item);
               }
               else
               {
                    $valid = false;
               }
          }
          elseif($part1) // Map has just one part
          {
               if($this->item->hasField($part1))
               {
                    trace("MergeCodeManager:: part1 is field of sending class.", 3);
                    $replaceText = $this->item->format("{".$part1 ."}");
               }
               elseif(is_callable($part1))
               {
                    trace("MergeCodeManager:: part1 is callback function.", 3);
                    $replaceText = call_user_func($part1, $this->item);
               }
               elseif(is_callable(array($this->item, $part1)))
               {
                    trace("MergeCodeManager:: part1 is function from sending class.", 3);
                    $replaceText = $this->item->$part1();
               }
               else
               {
                    $valid = false;
               }
          }
          
          if($valid)
               trace("MergeCodeManager:: replaceText is $replaceText", 3);
          else
               trace("MergeCodeManager:: Warning: merge code map not valid.", 3);
     
          return $replaceText;          
     }

MergeCodeManager()

MergeCodeManager::MergeCodeManager	(		$item,
			$inText,
			$class_name = ""
	)

Definition at line 65 of file merge_code_manager.inc.

     {
          $this->item = clone($item);
          $this->item->filter = null;
          $this->class_name = ($class_name) ? $class_name : get_class($item);
          
          $usedMergeCodes = array(); 
          preg_match_all("/\[(.*?)\]/", $inText, $usedMergeCodes, PREG_PATTERN_ORDER);
     
          $usedMergeCodes = $usedMergeCodes[1];        
          $this->getMergeCodeValues($usedMergeCodes);
     
     }

searchAndReplace()

MergeCodeManager::searchAndReplace

(

$text

)

Definition at line 242 of file merge_code_manager.inc.

     {
          $text = $this->item->format($text);
          
          if(count($this->patterns) == 0)
               return $text;
          else 
               return str_replace($this->patterns, $this->replacements, $text);
     }

Member Data Documentation

$class_name

MergeCodeManager::$class_name

Definition at line 63 of file merge_code_manager.inc.

$item

MergeCodeManager::$item

Definition at line 60 of file merge_code_manager.inc.

$patterns

MergeCodeManager::$patterns

Definition at line 61 of file merge_code_manager.inc.

$replacements

MergeCodeManager::$replacements

Definition at line 62 of file merge_code_manager.inc.

---

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

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