Inheritance diagram for CompositeDataItem:

Collaboration diagram for CompositeDataItem:

Public Member Functions
	CompositeDataItem ()

	add ()

	cast ($class)
	Cast this object to another class. More...

	joinTransaction ($tx)
	Join the DataItem to the specified DataTransaction. More...

	getTransaction ()
	Retrieves the current DataTransaction. More...

	populate ($line)
	Populates the object using the supplied associative array (field -> value). More...

	getFieldList ($alias="")
	Returned a comma-separated list of the fields for this object (applying the assigned filter if there is one). More...

	getFieldArray ()
	Return an array of field names for this object filtered by any active filter. More...

	getFields ()
	Retrieve the field type list for this object. More...

	hasField ($field)
	Returns true if this DataItem contains a field with the specified name and that field is not excluded by a filter. More...

	getHiddenFields ()
	Retrieves the list of hidden fields. More...

	hasRelation ($relation)
	Returns true if this DataItem contains a relation with the specified name. More...

	findSubObject ($field)
	Finds and returns the sub-object that contains the given field. More...

	getPrimaryKey ()
	Retrieves the primary key field name. More...

	getPrimaryKeyList ()
	Retrieves a list of all the primary keys used for an object as an array. More...

	get ($field)
	Retrieve the value for the specified field. More...

	set ($field, $value)
	Set the value of the specified field. More...

	getType ($field)
	Retrieves the data type of the specified field. More...

	getFilter ()
	Returns the filter set on this object. More...

	setFilter ($filter)
	Sets the filter on this object. More...

	getFieldAliases ()
	Retrieve the list of field aliases. More...

	getFieldAnnotations ()
	Retrieve the list of field annotations. More...

	load ($id)
	Load the object with the specified primary key. More...

	loadFromBase ($id)

	save ()
	Store the object in the database. More...

	select ()
	Select the object from the database, based on the value of the primary key field. More...

	exists ($constraint="")
	Check whether the object exists in the database. More...

	update ()
	Update the row in the database that corresponds to this object. More...

	insert ()
	Insert a new row in the database to store this object. More...

	delete ($constraint="")
	Delete the row in the database that corresponds to this object. More...

	deleteAll ()
	Delete all the rows in the database that correspond to this class. More...

	distinctValues ($field, $sorted=false, $constraint="")
	Retrieves the distinct values in the database for the specified field across the specified set of records. More...

	fromGET ()
	Automatically populate the object based on parameters in the $_GET collection. More...

	fromPOST ()
	Automatically populate the object based on parameters in the $_POST collection. More...

	fromREQUEST ()
	Automatically populate the object based on parameters in either the $_GET or $_POST collection, depending on the method used to access the page. More...

	compare ($to)
	Compare this object to another object. More...

	copy ($from)
	Copies values from another object, field by field. More...

	toXML ($indent=0, $path=null)
	Generates an XML representation of the object. More...

	fromXML ($node)
	Populates the object from the specified XML node. More...

	format ($template="", $separator=",")

	prettifyFieldName ($field)

	prettifyClassName ($plural=false)

	relateTo ($target, $field="")
	Link this object to the specified target by setting corresponding field to the value of the target's primary key. More...

	query ($constraints="", $page=-1, $size=-1)

	indexedQuery ($constraints="", $indexBy="")
	Performs a query against the database, returning an array of CompositeDataItem objects of the specified class, indexed by a particular field. More...

	groupedQuery ($constraints="", $indexBy="")
	Performs a query against the database, returning an array of arrays of CompositeDataItem objects of the specified class, grouped by a particular field. More...

Public Member Functions inherited from AbstractDataItem
	decorate ($name, $value)
	Adds a decoration to the DataItem. More...

	getDecoration ($name)
	Retrieve the value of a decoration on the current DataItem. More...

	setOption ($opt)
	Set a behavior option flag. More...

	clearOptions ($opt)
	Clear the specified behavior option flag. More...

	getConnection ()
	Retrieves a connection to the database. More...

	getIdentityConstraint ()
	Subclasses can override this function to provide additional identity constraints to be used when querying or updating. More...

	getPrimaryKeyValue ()
	Retrieves the primary key value. More...

	cacheLookup ($id)
	Populate the object from the local cache if the object is marked as "cacheLocal". More...

	quoteFieldValue ($field, $type=null)
	Returns the properly quoted value of the specified field. More...

	quoteValue ($val, $type)

	formatFieldValue ($field, $template="")

	formatFieldForXML ($field)
	Format field for XML output. More...

	reformatToSQLDate ($date)
	Reformats the specified date to be in a format used by the database. More...

	reformatFromSQLDate ($date)

	fromJSON ($json)
	Populate from the supplied JSON object. More...

Public Attributes
	$__objects

	$__tx = null

Public Attributes inherited from AbstractDataItem
	$filter

	$_options = 0

	$_tx = null
	Tracks the current database transaction for each DataItem. More...

	$_decorations = null

Detailed Description

Definition at line 40 of file composite_data_item.inc.

Member Function Documentation

◆ add()

CompositeDataItem::add ( )

Definition at line 50 of file composite_data_item.inc.

      {
           $args = func_get_args();
           
           foreach($args as $cl)
           {
                $obj = new $cl();
                $pk = $obj->getPrimaryKey();
                
                if (count($this->__objects))
                {
                     $found = false;
                     
                     foreach($this->__objects as $o)
                     {
                          if ($o->hasField($pk))
                          {
                               $found = true;
                               break;
                          }
                     }
                     
                     if (!$found)
                     {
                          throw new DataItemException("$cl does not have a direct foreign key relationship with another class in ".get_class($this));
                     }
                }
                
                $this->__objects[] = $obj;
                $this->$cl = $obj;
           }
      }

◆ cast()

CompositeDataItem::cast ( $class )

Cast this object to another class.

This facility is provided so that it is possible to cast from a CompositeDataItem to one of its constituents to provide support for polymorphism in those cases.

Parameters

string $class

Returns: instance of the specified class, if compatible

Exceptions

DataItemException

Reimplemented from AbstractDataItem.

Definition at line 83 of file composite_data_item.inc.

      {
           if ($this->$class) return $this->$class;
           
           throw new DataItemException("Cannot cast from ".get_class($this)." to $class");
      }

◆ compare()

CompositeDataItem::compare ( $to )

Compare this object to another object.

If all the fields match, the method returns true, otherwise false. If a filter is in place on the source object, then only the filtered fields are compared.

Parameters

object $to the object with which to compare this object

Reimplemented from AbstractDataItem.

Definition at line 601 of file composite_data_item.inc.

      {
           if (get_class($to) != get_class($this)) return false;
           $num = count($this->__objects);
           
           for($i = 0; $i < $num; ++$i)
           {
                if (!$this->__objects[$i]->compare($to->__objects[$i])) return false;
           }
           
           return true;
      }

◆ CompositeDataItem()

CompositeDataItem::CompositeDataItem ( )

Definition at line 45 of file composite_data_item.inc.

      {
           $__objects = array();    
      }

◆ copy()

CompositeDataItem::copy ( $from )

Copies values from another object, field by field.

If a filter is in place on the source object, then only the filtered fields are copied.

Parameters

object from the object from which data is to be copied

Reimplemented from AbstractDataItem.

Definition at line 620 of file composite_data_item.inc.

      {
           if (get_class($to) != get_class($this)) return false;
           
           $num = count($this->__objects);
           
           for($i = 0; $i < $num; ++$i)
           {
                $this->__objects[$i]->copy($from->__objects[$i]);
           }
      }    

◆ delete()

CompositeDataItem::delete ( $constraint = "" )

Delete the row in the database that corresponds to this object.

Reimplemented from AbstractDataItem.

Definition at line 510 of file composite_data_item.inc.

      {
           if ($constraint)
           {
                throw new DataItemException("CompositeDataItem::delete() does not currently support constraint clauses");
           }
           
           $num = count($this->__objects);
           
           for($i = 0; $i < $num; ++$i)
           {
                $this->__objects[$i]->delete();
           }
      }

◆ deleteAll()

CompositeDataItem::deleteAll ( )

Delete all the rows in the database that correspond to this class.

Reimplemented from AbstractDataItem.

Definition at line 528 of file composite_data_item.inc.

      {
           for($i = 0; $i < $num; ++$i)
           {
                $this->__objects[$i]->deleteAll();
           }
      }

◆ distinctValues()

CompositeDataItem::distinctValues	(	$field,
		$sorted = `false`,
		$constraint = `""`
	)

Retrieves the distinct values in the database for the specified field across the specified set of records.

Parameters

string	$field
boolean	$sorted
string	$constraint

Returns: array

Reimplemented from AbstractDataItem.

Definition at line 544 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field))
                {
                     return $obj->distinctValues($field, $sorted, $constraint);
                }
           }
           
           throw new DataItemException("Could not find field '$field' in any component objects");
      }

◆ exists()

CompositeDataItem::exists ( $constraint = "" )

Check whether the object exists in the database.

Reimplemented from AbstractDataItem.

Definition at line 471 of file composite_data_item.inc.

      {
           return $this->__objects[0]->exists($constraint);
      }

◆ findSubObject()

CompositeDataItem::findSubObject ( $field )

Finds and returns the sub-object that contains the given field.

Parameters

string $field the field for which to search

Definition at line 241 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) return $obj;
           }
           
           throw new FakoliException("Cannot locate field '$field' in sub-objects");
      }

◆ format()

CompositeDataItem::format	(	$template = `""`,
		$separator = `","`
	)

Reimplemented from AbstractDataItem.

Definition at line 659 of file composite_data_item.inc.

      {
           $matches = array();
           
           preg_match_all("/\\{([\\w_]+)\.([^}]+)}/", $template, $matches, PREG_SET_ORDER);
           
           foreach($matches as $match)
           {
                $class = $match[1];
                $subtemplate = $match[2];
      
                $value = $this->$class->format("{".$subtemplate."}", $separator);
                
                $template = str_replace($match[0], $value, $template);
           }
  
           return $template;
      }

◆ fromGET()

CompositeDataItem::fromGET ( )

Automatically populate the object based on parameters in the $_GET collection.

Reimplemented from AbstractDataItem.

Definition at line 560 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->fromGET();
           }
      }    

◆ fromPOST()

CompositeDataItem::fromPOST ( )

Automatically populate the object based on parameters in the $_POST collection.

If the key does not exist in $_POST and the type is Boolean, that means that the user unchecked a checkbox and we need to assign 0 to the field.

Reimplemented from AbstractDataItem.

Definition at line 574 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->fromPOST();
           }
      }    

◆ fromREQUEST()

CompositeDataItem::fromREQUEST ( )

Automatically populate the object based on parameters in either the $_GET or $_POST collection, depending on the method used to access the page.

Reimplemented from AbstractDataItem.

Definition at line 586 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->fromREQUEST();
           }
      }    

◆ fromXML()

CompositeDataItem::fromXML ( $node )

Populates the object from the specified XML node.

Parameters

DOMNode $node

Reimplemented from AbstractDataItem.

Definition at line 654 of file composite_data_item.inc.

      {
           //TODO: Implement this
      }

◆ get()

CompositeDataItem::get ( $field )

Retrieve the value for the specified field.

Parameters

string $field the field to retrieve

Returns: mixed the value of that field

Reimplemented from AbstractDataItem.

Definition at line 282 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) return $obj->get($field);
           }
      
           return null;
      }

◆ getFieldAliases()

CompositeDataItem::getFieldAliases ( )

Retrieve the list of field aliases.

Returns: array the alias list for this object

Reimplemented from AbstractDataItem.

Definition at line 344 of file composite_data_item.inc.

      {
           $aliases = array();
           
           // Create a composite field list from the inside out.
           $num = count($this->__objects);
           for($i = $num - 1; $i >= 0; --$i)
           {
                $of = $this->__objects[$i]->getFieldAliases();
                if ($of)
                {
                     $aliases = array_merge($aliases, $of);
                }              
           }
           
           return $aliases;
      }

◆ getFieldAnnotations()

CompositeDataItem::getFieldAnnotations ( )

Retrieve the list of field annotations.

Returns: array the annotation list for this object

Reimplemented from AbstractDataItem.

Definition at line 366 of file composite_data_item.inc.

      {
           $aliases = array();
           
           // Create a composite field list from the inside out.
           $num = count($this->__objects);
           for($i = $num - 1; $i >= 0; --$i)
           {
                $of = $this->__objects[$i]->getFieldAnnotations();
                if ($of)
                {
                     $aliases = array_merge($aliases, $of);
                }
           }
           
           return $aliases;
      }

◆ getFieldArray()

CompositeDataItem::getFieldArray ( )

Return an array of field names for this object filtered by any active filter.

Returns: array

Reimplemented from AbstractDataItem.

Definition at line 158 of file composite_data_item.inc.

      {
           $fields[] = array();
           
           // Create a composite field list from the inside out.
           $num = count($this->__objects);
           for($i = $num - 1; $i >= 0; --$i)
           {
                $of = $this->__objects[$i]->getFields();
                $fields = array_merge($fields, $of);              
           }
           
           return array_keys($fields);
      }

◆ getFieldList()

CompositeDataItem::getFieldList ( $alias = "" )

Returned a comma-separated list of the fields for this object (applying the assigned filter if there is one).

Reimplemented from AbstractDataItem.

Definition at line 139 of file composite_data_item.inc.

      {
           $fields[] = array();
           
           // Create a composite field list from the inside out.
           $num = count($this->__objects);
           for($i = $num - 1; $i >= 0; ++$i)
           {
                $of = $this->__objects[$i]->getFields();
                $fields = array_merge($fields, $of);              
           }
           
           return implode(", ", array_keys($fields));
      }

◆ getFields()

CompositeDataItem::getFields ( )

Retrieve the field type list for this object.

Reimplemented from AbstractDataItem.

Definition at line 176 of file composite_data_item.inc.

      {
           $fields = array();
           // Create a composite field list from the inside out.
           $num = count($this->__objects);
           for($i = $num - 1; $i >= 0; --$i)
           {
                $of = $this->__objects[$i]->getFields();
                $fields = array_merge($fields, $of);              
           }
           
           return $fields;
      }

◆ getFilter()

CompositeDataItem::getFilter ( )

Returns the filter set on this object.

Reimplemented from AbstractDataItem.

Definition at line 323 of file composite_data_item.inc.

      {
           return $this->__objects[0]->getFilter();
      }

◆ getHiddenFields()

CompositeDataItem::getHiddenFields ( )

Retrieves the list of hidden fields.

These will be automatically hidden in any AutoForm.

Returns: array of names of hidden fields.

Reimplemented from AbstractDataItem.

Definition at line 207 of file composite_data_item.inc.

      {
           $hiddenFields = array();
           
           foreach($this->__objects as $obj)
           {
                $hidden = $obj->getHiddenFields();
                if ($hidden) array_merge($hiddenFields, $hidden);
           }
           
           return $hiddenFields;
      }

◆ getPrimaryKey()

CompositeDataItem::getPrimaryKey ( )

Retrieves the primary key field name.

Reimplemented from AbstractDataItem.

Definition at line 254 of file composite_data_item.inc.

      {
           // Primary key field for the composite object is the primary key field of the outermost object.
           
           return $this->__objects[0]->getPrimaryKey();
      }

◆ getPrimaryKeyList()

CompositeDataItem::getPrimaryKeyList ( )

Retrieves a list of all the primary keys used for an object as an array.

Returns: array all the primary keys for this object's constituent parts

Reimplemented from AbstractDataItem.

Definition at line 265 of file composite_data_item.inc.

      {
           $pk = array();
           
           foreach($this->__objects as $obj)
           {
                $pk = array_merge($pk, $obj->getPrimaryKeyList());
           }
           
           return $pk;
      }    

◆ getTransaction()

CompositeDataItem::getTransaction ( )

Retrieves the current DataTransaction.

Reimplemented from AbstractDataItem.

Definition at line 107 of file composite_data_item.inc.

      {
           return $this->__tx;
      }

◆ getType()

CompositeDataItem::getType ( $field )

Retrieves the data type of the specified field.

Parameters

$field the field in question

Returns: string the data type of the specified field

Reimplemented from AbstractDataItem.

Definition at line 310 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) return $obj->getType($field);
           }
           
           return null;
      }    

◆ groupedQuery()

CompositeDataItem::groupedQuery	(	$constraints = `""`,
		$indexBy = `""`
	)

Performs a query against the database, returning an array of arrays of CompositeDataItem objects of the specified class, grouped by a particular field.

If the indexing field has unique values, indexedQuery() might be more appropriate.

Parameters

string	$constraints	optional constraint clause to apply to the query in the form "WHERE ... [ORDER BY ...]"
string	$field	optional the name of the field by which to group the results

Definition at line 837 of file composite_data_item.inc.

      {
           $field = "";
           $idxClass = "";
           
           if ($indexBy != "")
           {
                list($idxClass, $field) = explode(".", $indexBy); 
           }
           else
           {
                $idxClass = $this->class[0];
                $obj = new $class;
                $field = $obj->primary_key;
           }
           
           trace("InnerJoin::groupedQuery(): Group by $idxClass $field", 3);
                
           $query = $this->generateQuery($constraints);      
                
           try
           {
                $db = ConnectionManager::getConnection();
                $result = $db->prepare($query);
                $result->execute();
                               
                $items = array();
                
                while($line = $result->fetch())
                {
                     $item = new JoinResult($this->tag);
                     
                     for($i = 0; $i < count($this->classes); ++$i)
                     {
                          $class = $this->classes[$i];
                          $item->$class = new $class;   //Hack to work around PHP's stupid implementation of get_class()
                          $item->$class->populate($line);
                     }
      
                     $idx = $item->$idxClass->$field;
                     $items[$idx][] = $item;
                }
                
                unset($result);     
           
                return $items;
           }
           catch(PDOException $e)
           {
                die("InnerJoin::groupedQuery() failed - ".$e->getMessage());
           }
      }

◆ hasField()

CompositeDataItem::hasField ( $field )

Returns true if this DataItem contains a field with the specified name and that field is not excluded by a filter.

Parameters

string $field

Returns: true if this field is present and not filtered, false otherwise.

Reimplemented from AbstractDataItem.

Definition at line 197 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) return true;
           }
           
           return false;
      }    

◆ hasRelation()

CompositeDataItem::hasRelation ( $relation )

Returns true if this DataItem contains a relation with the specified name.

Parameters

string $relation

Returns: true if this relation is present and not filtered, false otherwise.

Reimplemented from AbstractDataItem.

Definition at line 226 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasRelation($relation)) return true;
           }
           
           return false;
      }

◆ indexedQuery()

CompositeDataItem::indexedQuery	(	$constraints = `""`,
		$indexBy = `""`
	)

Performs a query against the database, returning an array of CompositeDataItem objects of the specified class, indexed by a particular field.

If more than one item is found that matches the same value of the indexing field, the results entry is promoted to an array automatically. However, in cases where this is common, using groupedQuery() might simplify your calling code.

Parameters

string	$constraints	optional constraint clause to apply to the query in the form "WHERE ... [ORDER BY ...]"
string	$field	optional the name of the field by which to index the results (See InclusionFilter and ExclusionFilter)

Definition at line 768 of file composite_data_item.inc.

      {
           $field = "";
           $idxClass = "";
           
           if ($indexBy != "")
           {
                list($idxClass, $field) = explode(".", $indexBy); 
           }
           else
           {
                $idxClass = $this->class[0];
                $obj = new $class;
                $field = $obj->primary_key;
           }
                
           $query = $this->generateQuery($constraints);      
           
           try
           {
                $db = ConnectionManager::getConnection();
                $result = $db->prepare($query);
                $result->execute();
                
                $items = array();
                
                while($line = $result->fetch())
                {
                     $item = new JoinResult($this->tag);
                     
                     for($i = 0; $i < count($this->classes); ++$i)
                     {
                          $class = $this->classes[$i];
                          $item->$class = new $class;   //Hack to work around PHP's stupid implementation of get_class()
                          $item->$class->populate($line);
                     }
      
                     $idx = $item->$idxClass->$field;
                     if (array_key_exists($idx, $items))
                     {
                          // Implicitly promote to array if there is a collision
                          if (!is_array($items[$idx]))
                          {
                               $items[$idx] = array($items[$idx]);
                          }
                          $items[$idx][] = $item;
                     }
                     else
                     {
                          $items[$idx] = $item;
                     }              
                }
                
                unset($result);     
                
                return $items;
           }
           catch(PDOException $e)
           {
                die("InnerJoin::indexedQuery() failed - ".$e->getMessage());     
           }
      }

◆ insert()

CompositeDataItem::insert ( )

Insert a new row in the database to store this object.

Reimplemented from AbstractDataItem.

Definition at line 490 of file composite_data_item.inc.

      {
           // Insert and chain primary/foreign keys, from the inside out
      
           $num = count($this->__objects);
           
           for($i = $num - 1; $i >= 0; --$i)
           {
                $this->__objects[$i]->insert();
                if ($i > 0)
                {
                     $pk = $this->__objects[$i]->getPrimaryKey();
                     $this->__objects[$i - 1]->set($pk, $this->__objects[$i]->get($pk));
                }
           }
      }

◆ joinTransaction()

CompositeDataItem::joinTransaction ( $tx )

Join the DataItem to the specified DataTransaction.

Parameters

DataTransaction $tx the transaction to join

Reimplemented from AbstractDataItem.

Definition at line 94 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->joinTransaction($tx);
           }
           
           $this->__tx = $tx;
      }

◆ load()

CompositeDataItem::load ( $id )

Load the object with the specified primary key.

Parameters

int	id the primary key value to instantiate from

Reimplemented from AbstractDataItem.

Definition at line 389 of file composite_data_item.inc.

      {
           // Load from the outside in, chaining on the
           // primary key/foreign key relationship at each level
           
           $num = count($this->__objects);
           
           for($i = 0; $i < $num; ++$i)
           {
                $this->__objects[$i]->load($id);
                
                if ($i == $num - 1) continue;
  
                $id = $this->__objects[$i]->get($this->__objects[$i+1]->getPrimaryKey());
           }
      }

◆ loadFromBase()

CompositeDataItem::loadFromBase ( $id )

Definition at line 406 of file composite_data_item.inc.

      {
           $num = count($this->__objects);
           
           $this->__objects[$num - 1]->load($id);
           
           for($i = $num - 2; $i >= 0; --$i)
           {
                trace("BOOGER!", 3);
                $pk = $this->__objects[$i+1]->getPrimaryKey();
                $cl = get_class($this->__objects[$i]);
                $obj = querySingle($cl, "WHERE $pk=".$this->__objects[$i+1]->get($pk));
                $this->__objects[$i] = $obj;
                $this->$cl = $obj;
           } 
      }

◆ populate()

CompositeDataItem::populate ( $line )

Populates the object using the supplied associative array (field -> value).

Only values that match the definition of the sub-classed object will be copied. Fields that have been excluded by the use of an InclusionFilter or ExclusionFilter will also not be populated.

Parameters

array $line the array of values to populate the object with.

Reimplemented from AbstractDataItem.

Definition at line 120 of file composite_data_item.inc.

      {
           // Load all component objects from the outside in.
           
           $this->__objects[0]->populate($line);
           $num = count($this->__objects);
           
           for($i = 1; $i < num; ++$i)
           {
                $pk = $this->__objects[$i];
                $key = $obj->get($pk);
                $obj->load($key);
           }
      }

◆ prettifyClassName()

CompositeDataItem::prettifyClassName ( $plural = false )

Reimplemented from AbstractDataItem.

Definition at line 690 of file composite_data_item.inc.

      {
           $c = ($this->pretty_class_name) ? $this->pretty_class_name : get_class($this);
           $c = preg_replace(array("/([a-z])([A-Z0-9])/",
                                         "/_/"),
                                 array("$1 $2",
                                         " "),
                                 $c);
           $c = ucwords($c);
           
           if ($plural)
           {
                pluralize($c);
           }
           
           return $c;
      }

◆ prettifyFieldName()

CompositeDataItem::prettifyFieldName ( $field )

Reimplemented from AbstractDataItem.

Definition at line 679 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) return $obj->prettifyFieldName($field);
           }
           
           return $field;
      }

◆ query()

CompositeDataItem::query	(	$constraints = `""`,
		$page = `-1`,
		$size = `-1`
	)

Definition at line 731 of file composite_data_item.inc.

      {
           $join = new InnerJoin();
           foreach($this->__objects as $obj)
           {
                $join->add(get_class($obj));
           }
           
           $joinResults = $join->query($constraints, $page, $size);
           
           $results = array();
           
           foreach($joinResults as $result)
           {
                $obj = clone($this);
                foreach($obj->__objects as $target)
                {
                     $cl = get_class($target);
                     $target->copy($result->$cl);
                }
                
                $results[] = $obj;
           }
           
           return $results;
      }

◆ relateTo()

CompositeDataItem::relateTo	(	$target,
		$field = `""`
	)

Link this object to the specified target by setting corresponding field to the value of the target's primary key.

Parameters

DataItem	$target	the DataItem to which the relationship will be created
string	$field	the field to set for the relationship. If not specified, the primary key of the target object is used for the foreign key field name.

Reimplemented from AbstractDataItem.

Definition at line 716 of file composite_data_item.inc.

      {
           if ($field == "") $field = $target->getPrimaryKey();
           
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field))
                {
                     $obj->relateTo($target, $field);
                     return;
                }
           }
      }

◆ save()

CompositeDataItem::save ( )

Store the object in the database.

Reimplemented from AbstractDataItem.

Definition at line 426 of file composite_data_item.inc.

      {
           // Save from the inside out, chaining on the
           // primary key/foreign key relationship at each level
           $num = count($this->__objects);
           
           for($i = $num - 1; $i >= 0; --$i)
           {
                if ($this->__objects[$i]->hasField("composite_class"))
                {
                     $this->__objects[$i]->set("composite_class", get_class($this));
                }
                
                $this->__objects[$i]->save();
                if ($i != 0)
                {
                     $pk = $this->__objects[$i]->getPrimaryKey();
                     $this->__objects[$i - 1]->set($pk, $this->__objects[$i]->get($pk));
                }
           }
      }

◆ select()

CompositeDataItem::select ( )

Select the object from the database, based on the value of the primary key field.

Reimplemented from AbstractDataItem.

Definition at line 451 of file composite_data_item.inc.

      {
           // Select from the outside in, chaining on the
           // primary key/foreign key relationship at each level
           
           $this->__objects[0]->select();
           
           $num = count($this->__objects);
           
           for($i = 1; $i < $num; $i)
           {
                $pk = $this->__objects[$i]->getPrimaryKey();
                $this->__objects[$i]->set($pk, $this->__objects[$i - 1]->get($pk));
                $this->__objects[$i]->select();
           }
      }

◆ set()

CompositeDataItem::set	(	$field,
		$value
	)

Set the value of the specified field.

Parameters

$field	the field to set
$value	the value to which the field is to be set

Reimplemented from AbstractDataItem.

Definition at line 297 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                if ($obj->hasField($field)) $obj->set($field, $value);
           }
      }

◆ setFilter()

CompositeDataItem::setFilter ( $filter )

Sets the filter on this object.

Parameters

$filter the filter

Reimplemented from AbstractDataItem.

Definition at line 332 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->setFilter($filter);
           }
      }

◆ toXML()

CompositeDataItem::toXML	(	$indent = `0`,
		$path = `null`
	)

Generates an XML representation of the object.

Filters are honored when determining which fields are included in the XML. Empty fields are not output (note that a string field with value "" is not considered empty).

Reimplemented from AbstractDataItem.

Definition at line 637 of file composite_data_item.inc.

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

◆ update()

CompositeDataItem::update ( )

Update the row in the database that corresponds to this object.

Reimplemented from AbstractDataItem.

Definition at line 479 of file composite_data_item.inc.

      {
           foreach($this->__objects as $obj)
           {
                $obj->update();
           }
      }

Member Data Documentation

◆ $__objects

CompositeDataItem::$__objects

Definition at line 42 of file composite_data_item.inc.

◆ $__tx

CompositeDataItem::$__tx = null

Definition at line 43 of file composite_data_item.inc.

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

C:/code/cms.sonjara.com/framework/composite_data_item.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ cast()

◆ compare()

◆ CompositeDataItem()

◆ copy()

◆ delete()

◆ deleteAll()

◆ distinctValues()

◆ exists()

◆ findSubObject()

◆ format()

◆ fromGET()

◆ fromPOST()

◆ fromREQUEST()

◆ fromXML()

◆ get()

◆ getFieldAliases()

◆ getFieldAnnotations()

◆ getFieldArray()

◆ getFieldList()

◆ getFields()

◆ getFilter()

◆ getHiddenFields()

◆ getPrimaryKey()

◆ getPrimaryKeyList()

◆ getTransaction()

◆ getType()

◆ groupedQuery()

◆ hasField()

◆ hasRelation()

◆ indexedQuery()

◆ insert()

◆ joinTransaction()

◆ load()

◆ loadFromBase()

◆ populate()

◆ prettifyClassName()

◆ prettifyFieldName()

◆ query()

◆ relateTo()

◆ save()

◆ select()

◆ set()

◆ setFilter()

◆ toXML()

◆ update()

Member Data Documentation

◆ $__objects

◆ $__tx