abstract_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.
 
*****************************************************************/
 
class DataItemException extends Exception {}
class DataNotFoundException extends Exception {}
 
require_once realpath(dirname(__FILE__)."/transaction.inc");
require_once realpath(dirname(__FILE__)."/data_type_renderers/abstract_type_renderer.inc");
 
class ExclusionFilter
{
     var $fields = array();
     var $type = "ExclusionFilter";
     
     function ExclusionFilter()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }
     
     function isExcluded($field)
     {
          return (array_key_exists($field, $this->fields));
     }    
     
     function add()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }
          
     function remove()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               unset($this->fields[$args[$i]]);
          }
     }
     
     function includeField($field)
     {
          $this->remove($field);
     }
     
     function excludeField($field)
     {
          $this->add($field);
     }
}
 
class InclusionFilter
{
     var $fields = array();
     var $type = "InclusionFilter";
     
     function InclusionFilter()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }
     
     function isExcluded($field)
     {
          return !(array_key_exists($field, $this->fields));
     }    
 
     function add()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               $this->fields[$args[$i]] = true;
          }
     }
     
     function remove()
     {
          $args = func_get_args();
          for($i = 0; $i < count($args); ++$i)
          {
               unset($this->fields[$args[$i]]);
          }
     }
 
     function includeField($field)
     {
          $this->add($field);
     }
     
     function excludeField($field)
     {
          $this->remove($field);
     }
}
 
define("SerializeRelations", 1);
define("SerializeDirectRelations", 2);
define("ProtectHTML", 4);
 
abstract class AbstractDataItem
{
     var $filter;
     var $_options = 0;
     var $_tx = null;              
 
     var $_decorations = null;
     
     function decorate($name, $value)
     {
          if (!$this->_decorations)
          {
               $this->_decorations = array();
          }
          
          $this->_decorations[$name] = $value;
     }
     
     function getDecoration($name)
     {
          return $this->_decorations[$name];
     }
     
     abstract function cast($class);
     
     function setOption($opt)
     {
          $this->_options |= $opt;
     }
     
     function clearOptions($opt)
     {
          $this->_options |= $opt;
     }
     
     function getConnection()
     {
          $tx = $this->getTransaction();
          
          if ($tx)
          {
               return $tx->getConnection();
          }
          else
          { 
               return ConnectionManager::getConnection();
          }
     }
     
     abstract function joinTransaction($tx);
     
     abstract function getTransaction();
     
     function getIdentityConstraint()
     {
          return "";
     }
     
     abstract function populate($line);
          
     abstract function getFields();
     
     abstract function getFieldList($alias = "");
     
     abstract function getFieldArray();
     
     abstract function hasField($field);
     
     abstract function hasRelation($relation);
 
     abstract function getPrimaryKey();
     
     abstract function getPrimaryKeyList();
     
     abstract function get($field);
     
     function getPrimaryKeyValue()
     {
          return $this->get($this->getPrimaryKey());
     }
     
     abstract function set($field, $value);
     
     abstract function getType($field);
     
     abstract function getHiddenFields();
     
     abstract function getFilter();
 
     abstract function setFilter($filter);
 
     abstract function getFieldAliases();
     
     abstract function getFieldAnnotations();
     
     abstract function load($id);
          
     abstract function save();
          
     abstract function select();
     
     abstract function exists($constraint = "");
     
     abstract function update();
 
     abstract function delete($constraint = "");
     
     abstract function deleteAll();
 
     function cacheLookup($id)
     {
          return false;
     }
     
     function quoteFieldValue($field, $type = null)
     {
          if (!$type) $type = $this->getType($field);
          
          $val = $this->get($field);
          
          return $this->quoteValue($val, $type);
     }
     
     function quoteValue($val, $type)
     {
          $query = "";
          
          $db = $this->getConnection();
          
          switch($type)
          {
          case Number:
          case Currency:
          
               if ($val == "" || !is_numeric($val))
               {
                    $query .= "0";
               }
               else
               {
                    $query .= $val;
               }
               break;
     
          case Date:
          case DateTime:
               
               $query .= ($val) ? $db->quote($this->reformatToSQLDate($val)) : "NULL";
               break;
               
          case Timestamp:
               
               $this->__timestamp = date("Y-m-d H:i:s");
               $query .= $db->quote($this->__timestamp);
               break;
               
          case Boolean:
               
               $query .= ($val) ? "1" : "0";
               break;
               
          case String:
          case Text:
          case TimeZone:
               
          default:
          
               $query .= $db->quote($val);
               break;
          }         
 
          return $query;           
     }
     
     /*
      * Call data type renderer to get default format if no
      * template or template-reqested format.
      * 
      * JDG 5/28/2011
      */
     function formatFieldValue($field, $template = "")
     {
          $type = $this->getType($field);
          $data = $this->get($field);
          
          $val = "";
           
          $renderer = DataItem::$dataTypeRendererMap[$type];
          if($renderer)
          {
               $formatter = array($renderer, "format");
               $val = call_user_func($formatter, $data, $template); 
          }
          else
          {
               $val = $data;
          }
          return $val;                       
     }
     
     function formatFieldForXML($field)
     {
          $type = $this->getType($field);
          $data = $this->get($field);
          
          $v = "";
          switch($type)
          {
          case HTML:
               
               if ($this->_options & ProtectHTML)
               {
                    $v = str_replace( array("<", ">", "&"), array("[_[OPENTAG]_]", "[_[CLOSETAG]_]", "[_[AMPERSAND]_]"), $data);                 
                    break;
               }
               else
               {
                    $v = htmlentities($data, ENT_COMPAT | ENT_XML1);
                    break;
               }
               
          case Number:
          case Date:
          case Timestamp:
          case String:
          case Text:
          default:
          
               $v = htmlentities($data, ENT_COMPAT | ENT_XML1);
               break;
          }
          
          return $v;     
               
     }
     
     function reformatToSQLDate($date)
     {
          trace($date, 3);
          $fields = array();
          if (preg_match("|^(\\d+)[\-/](\\d+)[\-/](\\d{4})$|", $date, $fields))
          {
               $date = $fields[3]."-".$fields[1]."-".$fields[2];
          }
          else if (preg_match("|^(\\d+)/(\\d+)/(\\d{4})\\s+(\\d+:\\d+:\\d+)|", $date, $fields))
          {
               $date = $fields[3]."-".$fields[1]."-".$fields[2]." ".$fields[4];
          }
 
          return $date;
     }
     
     function reformatFromSQLDate($date)
     {
          $fields = array();
          if (preg_match("|^(\\d{4})-(\\d\\d)-(\\d\\d)$|", $date, $fields))
          {
               $date = $fields[2]."/".$fields[3]."/".$fields[1];
          }
          else if (preg_match("|(\\d{4})-(\\d\\d)-(\\d\\d)\\s+(\\d+:\\d+:\\d+)|", $date, $fields))
          {
               $date = $fields[2]."/".$fields[3]."/".$fields[1]." ".$fields[4];
          }
          
          if ($date == "00/00/0000") $date = "";
          
          return $date;
     }
     
     abstract function insert();
          
     abstract function distinctValues($field, $sorted = false, $constraint = "");
     
     abstract function fromGET();
     
     abstract function fromPOST();
     
     abstract function fromREQUEST();
     
     abstract function compare($to);
     
     abstract function copy($from);
               
     abstract function toXML($indent = 0, $path = null);
 
     abstract function fromXML($node);
     
     function fromJSON($json)
     {
          if (is_object($json))
          {
               $fields = $this->getFields();
               foreach($fields as $field => $type)
               {
                    $this->set($field, $json->$field);
               }    
          }
          else
          {
               $obj = json_decode($json, true);
               $fields = $this->getFields();
               foreach($fields as $field => $type)
               {
                    $this->set($field, $obj[$field]);
               }
          }
     }
     
     abstract function format($template = "", $separator = ", ");
     
     abstract function prettifyFieldName($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)
          {
               $c = pluralize($c);
          }
          
          return $c;
     }
 
     abstract function relateTo($target, $field = "");
}?>