pivot.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
Copyright (c) 2013 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.
 
*****************************************************************/
 
abstract class AbstractPivotQuery extends AbstractQuery
{
     var $baseClass;
     var $baseConstraint;
     var $baseItem;
     
     var $rangeClass;
     var $rangeConstraint;
     
     var $pivotClass;
     var $pivotConstraint;
     
     var $pivotItem;
     
     var $fields;
     var $fieldAliases;
     
     var $additionalFields = array();
     var $groupByFields = array();
     
     var $orderBy;
     var $totalField = null;
     
     function __construct($base, $baseConstraint = "")
     {
          $this->baseClass = $base;
          $this->baseConstraint = $baseConstraint;
     
          $this->baseItem = new $this->baseClass;
     
          foreach($this->baseItem->getFields() as $field => $type)
          {
               $this->baseConstraint = preg_replace("/\\b".$field."\\b/i", "b.$field", $this->baseConstraint);
          }
     
          $matches = array();
          
          if (preg_match("/ORDER BY.*/i", $this->baseConstraint, $matches))
          {
               $this->orderBy = $matches[0];
               $this->baseConstraint = str_replace($this->orderBy, "", $this->baseConstraint);
          }
          
          $this->pivotItem = null;
     
          $this->page = -1;
          $this->size = -1;
     
          $basePK = $this->baseItem->getPrimaryKey();
          $this->fields[$basePK] = $this->baseItem->getType($basePK);
     
          $this->additionalFields[] = "b.{$basePK} as {$basePK}";
          $this->groupByFields[] = "b.{$basePK}";
     }
 
     function pivot($pivotClass, $pivotConstraint, $pivotFunction = "SUM")
     {
          $this->pivotClass = $pivotClass;
          $this->pivotConstraint = $pivotConstraint;
     
          $this->pivotItem = new $this->pivotClass;
     
          foreach($this->pivotItem->getFields() as $field => $type)
          {
               $this->pivotConstraint = preg_replace("/\\b".$field."\\b/i", "p.$field", $this->pivotConstraint);
          }
     
          return $this;
     }
     
     function range($rangeClass, $rangeConstraint)
     {
          $this->rangeClass = $rangeClass;
          $this->rangeConstraint = $rangeConstraint;
          return $this;
     }
     
     function field($field, $alias = "", $type = String)
     {
          $field = preg_replace("/\\b".$this->baseClass."\\b/i", "b", $field);
          $field = preg_replace("/\\b".$this->pivotClass."\\b/i", "p", $field);
     
          $bareField = preg_replace("/^.*?\\./", "", $field);
     
          $this->fields[$bareField] = String;
          $this->additionalFields[] = "$field as $bareField";
          $this->groupByFields[] = $field;
     
          return $this;
     }
     
     function pivotField($format, $value, $alias = null, $expression = "SUM", $type = Number)
     {
          if (!$alias) $alias = $format;
     
          $this->fieldNameFormats[$format] = array("expression" => $expression, "alias" => $alias, "value" => $value, "type" => $type);
          return $this;
     }
     
     protected function generateFieldExpressions()
     {
          if (!$this->rangeClass)
          {
               if (!$this->pivotClass)
               {
                    throw new FakoliExpression("No Range or Pivot class provided");
               }
                    
               $this->rangeClass = $this->pivotClass;
               $this->rangeConstaint = $this->pivotConstraint;
          }
     
          $obj = new $this->rangeClass;
          $pivot = $obj->getPrimaryKey();
     
          $rangeItems = Query::create($this->rangeClass, $this->rangeConstraint)->execute();
     
          $expressionMap = array();
     
          foreach($rangeItems as $item)
          {
               foreach($this->fieldNameFormats as $fieldName => $defn)
               {
                    $fieldName = $item->format($fieldName);
                    $value = $defn["value"];
                    $expression = $defn["expression"];
                    $alias = $defn["alias"];
     
                    $empty = ($defn["type"] == String) ? "''" : 0;
                    
                    $expressionMap[$fieldName] = "$expression(IF (p.{$pivot}=".$item->quoteFieldValue($pivot).", IFNULL(p.{$value}, {$empty}), {$empty}))";
                    $this->fields[$fieldName] = $defn["type"];
                    $this->fieldAliases[$fieldName] = $item->format($alias);
               }
          }
     
          return $expressionMap;
     }
     
     protected function generateQuery()
     {
          // First generate fields
     
          $expressionMap = $this->generateFieldExpressions();
     
          $additionalFields = implode(", ", $this->additionalFields);
          $groupByFields = implode(", ", $this->groupByFields);
     
          $base = $this->baseItem;
          $pivot = $this->pivotItem;
     
          $basePK  = $base->getPrimaryKey();
          $pivotPK = $pivot->getPrimaryKey();
     
          $query = "SELECT $additionalFields";
          foreach($expressionMap as $field => $expression)
          {
               $query .= ", ";
               $query .= "\n\t{$expression} as $field";
               $first = false;
          }
     
          $query .= "\nFROM {$base->table} b left outer join {$pivot->table} p \n";
     
          $query .= "ON (p.{$basePK}=b.{$basePK} ";
     
          $constraint = preg_replace("/^\\s*WHERE /i", "AND ", $this->pivotConstraint);
          $query .= " ".$constraint;
     
          $constraint = $this->baseConstraint ? $this->baseConstraint : "";
          $query .= ") $constraint GROUP BY $groupByFields";
          $query .= " ".$this->orderBy;
          
          $this->query = $query;
          return $query;
     }
     
     function createPivotItem()
     {
          return new PivotItem($this->fields, $this->baseClass, $this->baseItem->getPrimaryKey(), $this->fieldAliases);
     }
     
     function additionalFields()
     {
          for($i = 0; $i < func_num_args(); ++$i)
          {
               $field = func_get_arg($i);
               $type = $this->baseItem->getType($field);
               if ($type)
               {
                    $this->fields[$field] = $type;
                    $this->additionalFields[] = "b.{$field} as {$field}";
               }
          }
          return $this;
     }
}
 
class PivotQuery extends AbstractPivotQuery
{
     var $page;
     var $size;
 
     function __construct($base, $baseConstraint = "")
     {
          parent::__construct($base, $baseConstraint);
     }
     
     function page($page, $size)
     {
          $this->page = $page;
          $this->size = $size;
          return $this;
     }
     
     static function create($base, $baseConstraint = "")
     {
          return new PivotQuery($base, $baseConstraint);
     }
     
     function execute()
     {
          $query = $this->generateQuery();
          
          trace("$query", 3);
          trace("Page: $this->page Size: $this->size", 3);
          $items = array();
          
          $size = $this->size;
          
          try
          {
               $db = ConnectionManager::getConnection();
                    
               $result = $db->prepare($query);
               $result->execute($this->params);
                    
               if ($this->page > 0)
               {
                    $count = ($this->page - 1) * $this->size;
                    while($count--)
                    {
                         $result->fetch();
                    }
               }
                         
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $items[] = $item;
          
                    --$size;
                    if ($size == 0) break;
               }
                              
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "query() failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
          
          trace(count($items)." items found", 3);
          return $items;      
     }
}
 
 
class IndexedPivotQuery extends AbstractPivotQuery
{
     var $indexBy;
 
     function __construct($base, $baseConstraint = "", $indexBy = "")
     {
          parent::__construct($base, $baseConstraint);
          $this->indexBy = $indexBy;
     }
 
     function indexBy($indexBy)
     {
          $this->indexBy = $indexBy;
          return $this;
     }
 
     function execute()
     {
          $query = $this->generateQuery();
          
          trace("$query", 3);
          $items = array();
          $field = $this->indexBy;
 
          try
          {
               $db = ConnectionManager::getConnection();
 
               $result = $db->prepare($query);
               $result->execute($this->params);
                    
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $val = $item->get($field);
 
                    if (array_key_exists($val, $items))
                    {
                         // Implicitly promote to array if there is a collision
                         if (!is_array($items[$val]))
                         {
                              $items[$val] = array($items[$val]);
                         }
                         $items[$val][] = $item;
                    }
                    else
                    {
                         $items[$val] = $item;
                    }
               }
                    
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "IndexedPivotQuery failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
 
          return $items;
     }
 
     static function create($base, $baseConstraint = "", $indexBy = "")
     {
          return new IndexedPivotQuery($base, $baseConstraint, $indexBy);
     }
}
 
 
class GroupedPivotQuery extends AbstractPivotQuery
{
     var $groupBy;
 
     public function __construct($base, $baseConstraint = "", $groupBy = "")
     {
          parent::__construct($base, $baseConstraint);
          $this->groupBy = $groupBy;
     }
 
     function groupBy($groupBy)
     {
          $this->groupBy = $groupBy;
          return $this;
     }
 
     function execute()
     {
          $query = $this->generateQuery();
          
          trace($query, 3);
 
          $items = array();
 
          $field = $this->groupBy;
 
          try
          {
               $db = ConnectionManager::getConnection();
                    
               $result = $db->prepare($query);
               $result->execute($this->params);
 
               while($line = $result->fetch())
               {
                    $item = $this->createPivotItem();
                    $item->populate($line);
                    $items[$item->$field][] = $item;
               }
 
               unset($result);
          }
          catch(PDOException $e)
          {
               $err = "GroupedPivotQuery failed - " . $e->getMessage();
               trace($err, 2);
               throw new DataItemException($err);
          }
 
          return $items;
     }
 
     static function create($class, $constraints = "", $groupBy = "")
     {
          return new GroupedPivotQuery($class, $constraints, $groupBy);
     }
}
 
 
class PivotItem extends DataItem
{
     var $fields = array();
     var $fieldAliases = array();
     var $relations = array();
     
     var $baseClass;
     
     function __construct($fields, $baseClass, $primaryKey, $fieldAliases = array())
     {
          $this->fields = $fields;
          $this->primary_key = $primaryKey;
          $this->baseClass = $baseClass;
          $this->fieldAliases = $fieldAliases;
          
          $this->relations = array($baseClass => $baseClass);
          parent::__construct();
     }
 
     function __call($method, $args)
    {
     // Provide a relation traversal pseudo-method that 
     // allows traversal back to the base object for the
     // pivot
     
        if ($this->baseClass == $method)
        {
          return $this->getRelated($this->baseClass);
        }        
     }
     
     function getTotal()
     {
          $total = 0.0;
          
          foreach($this->fields as $field => $type)
          {
               if ($field != $this->primary_key)
               {
                    $total += $this->get($field);
               }
          }
 
          return $total;
     }
}
 
class PivotTableHelper
{
     var $pivot;
     var $table;
 
     var $columnSpecs = array();
     
     function __construct($pivot, $table)
     {
          $this->pivot = $pivot;
          $this->table = $table;
     }
     
     function column($pattern, $format, $sortable = true, $style = "", $typeHint = null, $onExport = null, $sortFormat = null, $footerTotal = false)
     {
          $this->columnSpecs[$pattern] = array("format" => $format, "sortable" => $sortable, "style" => $style, 
                                                        "typeHint" => $typeHint, "onExport" => $onExport, "sortFormat" => $sortFormat, 
                                                        "footerTotal" => $footerTotal);
          return $this;
     }
     
     function create()
     {
          $item = $this->pivot->createPivotItem();
          
          $fields = $item->getFields();
          
          foreach($fields as $field => $type)
          {
               foreach($this->columnSpecs as $spec => $details)
               {
                    $matches = array();
                    if (preg_match("/{$spec}/", $field, $matches))
                    {
                         $format = str_replace("%FIELD%", $field, $details["format"]);
                         
                         if ($matches[1]) $format = str_replace("%KEY%", $matches[1], $format);
                         
                         $this->table->column($item->prettifyFieldName($field), $format, $details["sortable"], $details["style"], 
                                                   $details["typeHint"], $details["onExport"], $details["sortFormat"]);
                         if ($details["footerTotal"])
                         {
                              $this->table->footerTotal($format);
                         }
                         break;
                    }
               }
          }
     }
}
?>