JoinResult Class Reference

JoinResult is an empty placeholder class. More...

Public Member Functions
	JoinResult ($tag="join")
	toXML ($indent=0)
	Serializes the JoinResult to XML. More...
	format ($template)
	Formats the contents of the JoinResult using the supplied template. More...

Public Attributes
	$_xmlTagName = "join"
	$_classes

Detailed Description

JoinResult is an empty placeholder class.

Instances of JoinResult are used to aggregate the results of the joined query. Each table that was joined is added as a sub-object of the JoinResult.

Definition at line 45 of file join.inc.

Member Function Documentation

format()

JoinResult::format

(

$template

)

Formats the contents of the JoinResult using the supplied template.

The DataItems contained in the JoinResult can be accessed via the usual relation traversal syntax {ClassName.field}. This method allows JoinResult objects to be used in DataListViews and other display controls.

Parameters

$template

the template for the formatted output

Definition at line 85 of file join.inc.

     {
          $matches = array();
          
          if (count($this->_classes) == 1 && preg_match("/^[\\w_]+/"))
          {
               $cl = $this->_classes[0];
               return $this->$cl->$format;
          }
          
          preg_match_all("/\\{([\\w_]+)\.([^}]+)}/", $template, $matches, PREG_SET_ORDER);
          
          foreach($matches as $match)
          {
               $class = $match[1];
               $subtemplate = $match[2];
     
               $value = is_object($this->$class) ? $this->$class->format("{".$subtemplate."}") : "";
               
               $template = str_replace($match[0], $value, $template);
          }
 
          $matches = array();
          
          preg_match_all("/\\{([\\w\\d_]+)::([^}]*)}/", $template, $matches, PREG_SET_ORDER);
 
          foreach($matches as $match)
          {
               $sub = call_user_func(array($match[1], $match[2]), $this);
               $template = str_replace($match[0], $sub, $template);
          }
          
          return $template;
     }

JoinResult()

JoinResult::JoinResult

(

$tag = "join"

)

Definition at line 50 of file join.inc.

     {
          $this->_xmlTagName = $tag;
          $this->_classes = array();
     }

toXML()

JoinResult::toXML

(

$indent = 0

)

Serializes the JoinResult to XML.

Parameters

integer

$indent

the initial indentation level for the output.

Definition at line 61 of file join.inc.

     {
          $xml = str_repeat(" ", $indent) . "<" . $this->_xmlTagName . ">\n";
          foreach ($this as $field => $val)
          {
               if (is_object($val))
               {
                    $xml .= $val->toXML($indent + 1);
               }
          }
          
          $xml .=  str_repeat(" ", $indent) . "</" . $this->_xmlTagName . ">\n";
          
          return $xml;
     }

Member Data Documentation

$_classes

JoinResult::$_classes

Definition at line 48 of file join.inc.

$_xmlTagName

JoinResult::$_xmlTagName = "join"

Definition at line 47 of file join.inc.

---

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

• C:/code/cms.sonjara.com/framework/join.inc