composite_data_item.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__))."/data_item.inc";
require_once realpath(dirname(__FILE__))."/join.inc";
 
class CompositeDataItem extends AbstractDataItem
{
     var $__objects;
     var $__tx = null;
     
     function CompositeDataItem()
     {
          $__objects = array();    
     }
     
     function add()
     {
          $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;
          }
     }
 
     function cast($class)
     {
          if ($this->$class) return $this->$class;
          
          throw new DataItemException("Cannot cast from ".get_class($this)." to $class");
     }
 
     function joinTransaction($tx)
     {
          foreach($this->__objects as $obj)
          {
               $obj->joinTransaction($tx);
          }
          
          $this->__tx = $tx;
     }
     
     function getTransaction()
     {
          return $this->__tx;
     }
     
     function populate($line)
     {
          // 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);
          }
     }
          
     function getFieldList($alias = "")
     {
          $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));
     }
     
     function getFieldArray()
     {
          $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);
     }
     
     function getFields()
     {
          $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;
     }
 
     function hasField($field)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) return true;
          }
          
          return false;
     }    
     
     function getHiddenFields()
     {
          $hiddenFields = array();
          
          foreach($this->__objects as $obj)
          {
               $hidden = $obj->getHiddenFields();
               if ($hidden) array_merge($hiddenFields, $hidden);
          }
          
          return $hiddenFields;
     }
               
     function hasRelation($relation)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasRelation($relation)) return true;
          }
          
          return false;
     }
 
     function findSubObject($field)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) return $obj;
          }
          
          throw new FakoliException("Cannot locate field '$field' in sub-objects");
     }
     
     function getPrimaryKey()
     {
          // Primary key field for the composite object is the primary key field of the outermost object.
          
          return $this->__objects[0]->getPrimaryKey();
     }
     
     function getPrimaryKeyList()
     {
          $pk = array();
          
          foreach($this->__objects as $obj)
          {
               $pk = array_merge($pk, $obj->getPrimaryKeyList());
          }
          
          return $pk;
     }    
     
     function get($field)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) return $obj->get($field);
          }
     
          return null;
     }
     
     function set($field, $value)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) $obj->set($field, $value);
          }
     }
     
     function getType($field)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) return $obj->getType($field);
          }
          
          return null;
     }    
     
     function getFilter()
     {
          return $this->__objects[0]->getFilter();
     }
 
     function setFilter($filter)
     {
          foreach($this->__objects as $obj)
          {
               $obj->setFilter($filter);
          }
     }
          
     function getFieldAliases()
     {
          $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;
     }
     
     function getFieldAnnotations()
     {
          $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;
     }
     
     function load($id)
     {
          // 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());
          }
     }
          
     function loadFromBase($id)
     {
          $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;
          } 
     }
     
     function save()
     {
          // 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));
               }
          }
     }
     
     function select()
     {
          // 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();
          }
     }
     
     function exists($constraint = "")
     {
          return $this->__objects[0]->exists($constraint);
     }
     
     function update()
     {
          foreach($this->__objects as $obj)
          {
               $obj->update();
          }
     }
     
     function insert()
     {
          // 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));
               }
          }
     }
          
     function delete($constraint = "")
     {
          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();
          }
     }
          
     function deleteAll()
     {
          for($i = 0; $i < $num; ++$i)
          {
               $this->__objects[$i]->deleteAll();
          }
     }
     
     function distinctValues($field, $sorted = false, $constraint = "")
     {
          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");
     }
     
     function fromGET()
     {
          foreach($this->__objects as $obj)
          {
               $obj->fromGET();
          }
     }    
     
     function fromPOST()
     {
          foreach($this->__objects as $obj)
          {
               $obj->fromPOST();
          }
     }    
          
     function fromREQUEST()
     {
          foreach($this->__objects as $obj)
          {
               $obj->fromREQUEST();
          }
     }    
     
     function compare($to)
     {
          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;
     }
          
     function copy($from)
     {
          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]);
          }
     }    
               
     function toXML($indent = 0, $path = null)
     {
          $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;
     }
 
     
     function fromXML($node)
     {
          //TODO: Implement this
     }
     
     function format($template = "", $separator = ",")
     {
          $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;
     }
          
     
     function prettifyFieldName($field)
     {
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field)) return $obj->prettifyFieldName($field);
          }
          
          return $field;
     }
     
          
     function prettifyClassName($plural = false)
     {
          $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;
     }
 
     function relateTo($target, $field = "")
     {
          if ($field == "") $field = $target->getPrimaryKey();
          
          foreach($this->__objects as $obj)
          {
               if ($obj->hasField($field))
               {
                    $obj->relateTo($target, $field);
                    return;
               }
          }
     }
     
          
     function query($constraints = "", $page = -1, $size = -1)
     {
          $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;
     }
     
          
     function indexedQuery($constraints = "", $indexBy = "")
     {
          $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());     
          }
     }
     
     function groupedQuery($constraints = "", $indexBy = "")
     {
          $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());
          }
     }
     
}
?>