File Source for AlphaDAO.inc

<?php
require_once $config->get('sysRoot').'alpha/util/AlphaErrorHandlers.inc';
require_once $config->get('sysRoot').'alpha/util/Logger.inc';
require_once $config->get('sysRoot').'alpha/util/InputFilter.inc';
require_once $config->get('sysRoot').'alpha/util/cache/AlphaCacheProviderFactory.inc';
require_once $config->get('sysRoot').'alpha/exceptions/BONotFoundException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/FailedSaveException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/FailedDeleteException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/LockingException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/ValidationException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/IllegalArguementException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/MailNotSentException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/BadBOTableNameException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/FailedIndexCreateException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/FailedLookupCreateException.inc';
require_once $config->get('sysRoot').'alpha/exceptions/CustomQueryException.inc';
require_once $config->get('sysRoot').'alpha/model/types/Date.inc';
require_once $config->get('sysRoot').'alpha/model/types/Timestamp.inc';
require_once $config->get('sysRoot').'alpha/model/types/Double.inc';
require_once $config->get('sysRoot').'alpha/model/types/Integer.inc';
require_once $config->get('sysRoot').'alpha/model/types/String.inc';
require_once $config->get('sysRoot').'alpha/model/types/Text.inc';
require_once $config->get('sysRoot').'alpha/model/types/Enum.inc';
require_once $config->get('sysRoot').'alpha/model/types/DEnum.inc';
require_once $config->get('sysRoot').'alpha/model/types/DEnumItem.inc';
require_once $config->get('sysRoot').'alpha/model/types/Boolean.inc';
require_once $config->get('sysRoot').'alpha/model/types/Relation.inc';
require_once $config->get('sysRoot').'alpha/model/types/Sequence.inc';
require_once $config->get('sysRoot').'alpha/model/AlphaDAOProviderFactory.inc';
/**
* Base business object class definition providing DAO storage via the configured provider.
*
* @package alpha::model
* @since 1.0
* @author John Collins <dev@alphaframework.org>
* @version $Id: AlphaDAO.inc 1464 2011-12-08 21:18:22Z johnc $
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*
*/
abstract class AlphaDAO {
/**
* The object ID
*
* @var integer
* @since 1.0
*/
protected $OID;
/**
* The last database query run by this object. Useful for tracing an error.
*
* @var string
* @since 1.0
*/
protected $lastQuery;
/**
* The version number of the object, used for locking mechanism
*
* @var Integer
* @since 1.0
*/
protected $version_num;
/**
* The timestamp of creation
*
* @var Timestamp
* @since 1.0
*/
protected $created_ts;
/**
* The OID of the person who created this BO
*
* @var Integer
* @since 1.0
*/
protected $created_by;
/**
* The timestamp of the last update
*
* @var Timestamp
* @since 1.0
*/
protected $updated_ts;
/**
* The OID of the person who last updated this BO
*
* @var Integer
* @since 1.0
*/
protected $updated_by;
/**
* An array of the names of all of the default attributes of a persistent BO defined in this class
*
* @var array
* @since 1.0
*/
protected $defaultAttributes = array("OID", "lastQuery", "version_num", "dataLabels", "created_ts", "created_by", "updated_ts", "updated_by", "defaultAttributes", "transientAttributes", "uniqueAttributes", "TABLE_NAME", "logger");
/**
* An array of the names of all of the transient attributes of a persistent BO which are not saved to the DB
*
* @var array
* @since 1.0
*/
protected $transientAttributes = array("lastQuery", "dataLabels", "defaultAttributes", "transientAttributes", "uniqueAttributes", "TABLE_NAME", "logger");
/**
* An array of the uniquely-constained attributes of this persistent BO
*
* @var array
* @since 1.0
*/
protected $uniqueAttributes = array();
/**
* An array of the data labels used for displaying class attributes
*
* @var array
* @since 1.0
*/
protected $dataLabels = array();
/**
* Trace logger
*
* @var Logger
* @since 1.0
*/
private static $logger = null;
/**
* The constructor which sets up some housekeeping attributes
*
* @since 1.0
*/
public function __construct() {
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>__construct()');
$this->version_num = new Integer(0);
$this->created_ts = new Timestamp(date("Y-m-d H:i:s"));
$person_ID = (isset($_SESSION['currentUser'])? $_SESSION['currentUser']->getOID(): 0);
$this->created_by = new Integer($person_ID);
$this->updated_ts = new Timestamp(date("Y-m-d H:i:s"));
$this->updated_by = new Integer($person_ID);
self::$logger->debug('<<__construct');
}
/**
* Gets the current connection singleton, or creates a new one if none exists
*
* @return mysqli
* @since 1.0
* @throws AlphaException
* @deprecated
*/
public static function getConnection() {
throw new AlphaException('The static getConnection() method is not longer supported! Please update your code to instantiate a AlphaDAOProviderInterface '.
'instance, then invoke the query() method on that instance to run a custom query.');
}
/**
* Disconnects the current database connection if one exists
*
* @since 1.0
*/
public static function disconnect() {
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), new PersonObject());
$provider->disconnect();
}
/**
* Returns a 2d array, where each element in the array is another array representing a database row.
*
* @param string $sqlQuery
* @return array
* @since 1.1
* @throws CustomQueryException
*/
public function query($sqlQuery) {
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
return $provider->query($sqlQuery);
}
/**
* Populates the child object with the properties retrived from the database for the object $OID.
*
* @param integer $OID The object ID of the business object to load.
* @since 1.0
* @throws BONotFoundException
*/
public function load($OID) {
self::$logger->debug('>>load(OID=['.$OID.'])');
if(method_exists($this, 'before_load_callback'))
$this->before_load_callback();
global $config;
$this->OID = $OID;
if($config->get('sysCacheProviderName') != '' && $this->loadFromCache()) {
// BO was found in cache
}else{
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->load($OID);
if($config->get('sysCacheProviderName') != '')
$this->addToCache();
}
$this->setEnumOptions();
if(method_exists($this, 'after_load_callback'))
$this->after_load_callback();
self::$logger->debug('<<load');
}
/**
* Populates the child object from the database table by the given attribute value.
*
* @param string $atribute The name of the attribute to load the object by.
* @param string $value The value of the attribute to load the object by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @param array $loadAttributes The attributes to load from the database to this object (leave blank to load all attributes)
* @since 1.0
* @throws BONotFoundException
*/
public function loadByAttribute($attribute, $value, $ignoreClassType=false, $loadAttributes=array()) {
self::$logger->debug('>>loadByAttribute(attribute=['.$attribute.'], value=['.$value.'], ignoreClassType=['.$ignoreClassType.'],
loadAttributes=['.var_export($loadAttributes, true).'])');
if(method_exists($this, 'before_loadByAttribute_callback'))
$this->before_loadByAttribute_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->loadByAttribute($attribute, $value, $ignoreClassType, $loadAttributes);
$this->setEnumOptions();
if($config->get('sysCacheProviderName') != '' && count($loadAttributes) == 0) // we will only cache fully-populated BOs
$this->addToCache();
if(method_exists($this, 'after_loadByAttribute_callback'))
$this->after_loadByAttribute_callback();
self::$logger->debug('<<loadByAttribute');
}
/**
* Loads all of the objects of this class into an array which is returned.
*
* @param integer $start The start of the SQL LIMIT clause, useful for pagination.
* @param integer $limit The amount (limit) of objects to load, useful for pagination.
* @param string $orderBy The name of the field to sort the objects by.
* @param string $order The order to sort the objects by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @return array An array containing objects of this type of business object.
* @since 1.0
* @throws BONotFoundException
*/
public function loadAll($start=0, $limit=0, $orderBy='OID', $order='ASC', $ignoreClassType=false) {
self::$logger->debug('>>loadAll(start=['.$start.'], limit=['.$limit.'], orderBy=['.$orderBy.'], order=['.$order.'], ignoreClassType=['.$ignoreClassType.']');
if(method_exists($this, 'before_loadAll_callback'))
$this->before_loadAll_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$objects = $provider->loadAll($start, $limit, $orderBy, $order, $ignoreClassType);
if(method_exists($this, 'after_loadAll_callback'))
$this->after_loadAll_callback();
self::$logger->debug('<<loadAll ['.count($objects).']');
return $objects;
}
/**
* Loads all of the objects of this class by the specified attribute into an array which is returned.
*
* @param string $atribute The attribute to load the objects by.
* @param string $value The value of the attribute to load the objects by.
* @param integer $start The start of the SQL LIMIT clause, useful for pagination.
* @param integer $limit The amount (limit) of objects to load, useful for pagination.
* @param string $orderBy The name of the field to sort the objects by.
* @param string $order The order to sort the objects by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type.
* @param array $constructorArgs An optional array of contructor arguements to pass to the BOs that will be generated and returned. Supports a maximum of 5 arguements.
* @return array An array containing objects of this type of business object.
* @since 1.0
* @throws BONotFoundException
* @throws IllegalArguementException
*/
public function loadAllByAttribute($attribute, $value, $start=0, $limit=0, $orderBy="OID", $order="ASC", $ignoreClassType=false, $constructorArgs=array()) {
self::$logger->debug('>>loadAllByAttribute(attribute=['.$attribute.'], value=['.$value.'], start=['.$start.'], limit=['.$limit.'], orderBy=['.$orderBy.'], order=['.$order.'], ignoreClassType=['.$ignoreClassType.'], constructorArgs=['.print_r($constructorArgs, true).']');
if(method_exists($this, 'before_loadAllByAttribute_callback'))
$this->before_loadAllByAttribute_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$objects = $provider->loadAllByAttribute($attribute, $value, $start, $limit, $orderBy, $order, $ignoreClassType);
if(method_exists($this, 'after_loadAllByAttribute_callback'))
$this->after_loadAllByAttribute_callback();
self::$logger->debug('<<loadAllByAttribute ['.count($objects).']');
return $objects;
}
/**
* Loads all of the objects of this class by the specified attributes into an array which is returned.
*
* @param array $atributes The attributes to load the objects by.
* @param array $values The values of the attributes to load the objects by.
* @param integer $start The start of the SQL LIMIT clause, useful for pagination.
* @param integer $limit The amount (limit) of objects to load, useful for pagination.
* @param string $orderBy The name of the field to sort the objects by.
* @param string $order The order to sort the objects by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @return array An array containing objects of this type of business object.
* @since 1.0
* @throws BONotFoundException
* @throws IllegalArguementException
*/
public function loadAllByAttributes($attributes=array(), $values=array(), $start=0, $limit=0, $orderBy='OID', $order='ASC', $ignoreClassType=false) {
self::$logger->debug('>>loadAllByAttributes(attributes=['.var_export($attributes, true).'], values=['.var_export($values, true).'], start=['.
$start.'], limit=['.$limit.'], orderBy=['.$orderBy.'], order=['.$order.'], ignoreClassType=['.$ignoreClassType.']');
if(method_exists($this, 'before_loadAllByAttributes_callback'))
$this->before_loadAllByAttributes_callback();
global $config;
if(!is_array($attributes) || !is_array($values)) {
throw new IllegalArguementException('Illegal arrays attributes=['.var_export($attributes, true).'] and values=['.var_export($values, true).
'] provided to loadAllByAttributes');
}
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$objects = $provider->loadAllByAttributes($attributes, $values, $start, $limit, $orderBy, $order, $ignoreClassType);
if(method_exists($this, 'after_loadAllByAttributes_callback'))
$this->after_loadAllByAttributes_callback();
self::$logger->debug('<<loadAllByAttributes ['.count($objects).']');
return $objects;
}
/**
* Loads all of the objects of this class that where updated (updated_ts value) on the date indicated.
*
* @param string $date The date for which to load the objects updated on, in the format 'YYYY-MM-DD'.
* @param integer $start The start of the SQL LIMIT clause, useful for pagination.
* @param integer $limit The amount (limit) of objects to load, useful for pagination.
* @param string $orderBy The name of the field to sort the objects by.
* @param string $order The order to sort the objects by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @return array An array containing objects of this type of business object.
* @since 1.0
* @throws BONotFoundException
*/
public function loadAllByDayUpdated($date, $start=0, $limit=0, $orderBy="OID", $order="ASC", $ignoreClassType=false) {
self::$logger->debug('>>loadAllByDayUpdated(date=['.$date.'], start=['.$start.'], limit=['.$limit.'], orderBy=['.$orderBy.'], order=['.$order.'], ignoreClassType=['.$ignoreClassType.']');
if(method_exists($this, 'before_loadAllByDayUpdated_callback'))
$this->before_loadAllByDayUpdated_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$objects = $provider->loadAllByDayUpdated($date, $start, $limit, $orderBy, $order, $ignoreClassType);
if(method_exists($this, 'after_loadAllByDayUpdated_callback'))
$this->after_loadAllByDayUpdated_callback();
self::$logger->debug('<<loadAllByDayUpdated ['.count($objects).']');
return $objects;
}
/**
* Loads all of the specified attribute values of this class by the specified attribute into an
* array which is returned.
*
* @param string $attribute The attribute name to load the field values by.
* @param string $value The value of the attribute to load the field values by.
* @param string $returnAttribute The name of the attribute to return.
* @param string $order The order to sort the BOs by.
* @param boolean $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type.
* @return array An array of field values.
* @since 1.0
* @throws BONotFoundException
*/
public function loadAllFieldValuesByAttribute($attribute, $value, $returnAttribute, $order='ASC', $ignoreClassType=false) {
self::$logger->debug('>>loadAllFieldValuesByAttribute(attribute=['.$attribute.'], value=['.$value.'], returnAttribute=['.$returnAttribute.'], order=['.$order.'], ignoreClassType=['.$ignoreClassType.']');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$values = $provider->loadAllFieldValuesByAttribute($attribute, $value, $returnAttribute, $order, $ignoreClassType);
self::$logger->debug('<<loadAllFieldValuesByAttribute ['.count($values).']');
return $values;
}
/**
* Saves the object. If $this->OID is empty or null it will INSERT, otherwise UPDATE.
*
* @since 1.0
* @throws FailedSaveException
* @throws LockingException
* @throws ValidationException
*/
public function save() {
self::$logger->debug('>>save()');
if(method_exists($this, 'before_save_callback'))
$this->before_save_callback();
global $config;
// firstly we will validate the object before we try to save it
if(!$this->validate()) {
throw new FailedSaveException('Could not save due to a validation error.');
return;
}else{
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->save();
if($config->get('sysCacheProviderName') != '')
$this->removeFromCache();
if(method_exists($this, 'after_save_callback'))
$this->after_save_callback();
}
}
/**
* Saves the field specified with the value supplied. Only works for persistent BOs. Note that no Alpha type
* validation is performed with this method!
*
* @param string $attribute The name of the attribute to save.
* @param mixed $value The value of the attribute to save.
* @since 1.0
* @throws IllegalArguementException
* @throws FailedSaveException
*/
public function saveAttribute($attribute, $value) {
self::$logger->debug('>>saveAttribute(attribute=['.$attribute.'], value=['.$value.'])');
if(method_exists($this, 'before_saveAttribute_callback'))
$this->before_saveAttribute_callback();
global $config;
if(!isset($this->$attribute))
throw new IllegalArguementException('Could not perform save, as the attribute ['.$attribute.'] is not present on the class['.get_class($this).']');
if($this->isTransient())
throw new FailedSaveException('Cannot perform saveAttribute method on transient BO!');
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->saveAttribute($attribute, $value);
$this->set($attribute, $value);
if($config->get('sysCacheProviderName') != '')
$this->removeFromCache();
if(method_exists($this, 'after_saveAttribute_callback'))
$this->after_saveAttribute_callback();
self::$logger->debug('<<saveAttribute');
}
/**
* Validates the object to be saved.
*
* @return boolean
* @since 1.0
* @throws ValidationException
*/
protected function validate() {
self::$logger->debug('>>validate()');
if(method_exists($this, 'before_validate_callback'))
$this->before_validate_callback();
$valid = true;
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
foreach($properties as $propObj) {
$propName = $propObj->name;
if(!in_array($propName, $this->defaultAttributes) && !in_array($propName, $this->transientAttributes)) {
$propClass = get_class($this->getPropObject($propName));
if (strtoupper($propClass) != "ENUM" &&
strtoupper($propClass) != "DENUM" &&
strtoupper($propClass) != "DENUMITEM" &&
strtoupper($propClass) != "BOOLEAN") {
if ($this->getPropObject($propName) != false && !preg_match($this->getPropObject($propName)->getRule(), $this->getPropObject($propName)->getValue())) {
throw new ValidationException('Failed to save, validation error is: '.$this->getPropObject($propName)->getHelper());
$valid = false;
}
}
}
}
if(method_exists($this, 'after_validate_callback'))
$this->after_validate_callback();
self::$logger->debug('<<validate ['.$valid.']');
return $valid;
}
/**
* Deletes the current object from the database.
*
* @since 1.0
* @throws FailedDeleteException
*/
public function delete() {
self::$logger->debug('>>delete()');
if(method_exists($this, 'before_delete_callback'))
$this->before_delete_callback();
global $config;
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
// check for any relations on this object, then remove them to prevent orphaned data
foreach($properties as $propObj) {
$propName = $propObj->name;
if(!$propObj->isPrivate() && isset($this->$propName) && $this->$propName instanceof Relation) {
$prop = $this->getPropObject($propName);
// Handle MANY-TO-MANY rels
if($prop->getRelationType() == 'MANY-TO-MANY') {
self::$logger->debug('Deleting MANY-TO-MANY lookup objects...');
try{
// check to see if the rel is on this class
$side = $prop->getSide(get_class($this));
}catch (IllegalArguementException $iae) {
$side = $prop->getSide(ucfirst($this->getTableName()).'Object');
}
self::$logger->debug('Side is ['.$side.']'.$this->getOID());
$lookUp = $prop->getLookup();
self::$logger->debug('Lookup object['.var_export($lookUp, true).']');
// delete all of the old RelationLookup objects for this rel
if($side == 'left')
$lookUp->deleteAllByAttribute('leftID', $this->getOID());
else
$lookUp->deleteAllByAttribute('rightID', $this->getOID());
self::$logger->debug('...done deleting!');
}
// should set related field values to null (MySQL is doing this for us as-is)
if($prop->getRelationType() == 'ONE-TO-MANY' && !$prop->getRelatedClass() == 'TagObject') {
$relatedObjects = $prop->getRelatedObjects();
foreach($relatedObjects as $object) {
$object->set($prop->getRelatedClassField(), null);
$object->save();
}
}
// in the case of tags, we will always remove the related tags once the BO is deleted
if($prop->getRelationType() == 'ONE-TO-MANY' && $prop->getRelatedClass() == 'TagObject') {
// just making sure that the Relation is set to current OID as its transient
$prop->setValue($this->getOID());
$relatedObjects = $prop->getRelatedObjects();
foreach($relatedObjects as $object) {
$object->delete();
}
}
}
}
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->delete();
if($config->get('sysCacheProviderName') != '')
$this->removeFromCache();
if(method_exists($this, 'after_delete_callback'))
$this->after_delete_callback();
$this->clear();
self::$logger->debug('<<delete');
}
/**
* Delete all object instances from the database by the specified attribute matching the value provided.
*
* @param string $attribute The name of the field to delete the objects by.
* @param mixed $value The value of the field to delete the objects by.
* @return integer The number of rows deleted.
* @since 1.0
* @throws FailedDeleteException
*/
public function deleteAllByAttribute($attribute, $value) {
self::$logger->debug('>>deleteAllByAttribute(attribute=['.$attribute.'], value=['.$value.'])');
if(method_exists($this, 'before_deleteAllByAttribute_callback'))
$this->before_deleteAllByAttribute_callback();
try {
$doomedObjects = $this->loadAllByAttribute($attribute, $value);
$deletedRowCount = 0;
foreach ($doomedObjects as $object) {
$object->delete();
$deletedRowCount++;
}
}catch (BONotFoundException $bonf) {
// nothing found to delete
self::$logger->warn($bonf->getMessage());
return 0;
}catch (AlphaException $e) {
throw new FailedDeleteException('Failed to delete objects, error is ['.$e->getMessage().']');
self::$logger->debug('<<deleteAllByAttribute [0]');
return 0;
}
if(method_exists($this, 'after_deleteAllByAttribute_callback'))
$this->after_deleteAllByAttribute_callback();
self::$logger->debug('<<deleteAllByAttribute ['.$deletedRowCount.']');
return $deletedRowCount;
}
/**
* Gets the version_num of the object from the database (returns 0 if the BO is not saved yet).
*
* @return integer
* @since 1.0
* @throws BONotFoundException
*/
public function getVersion() {
self::$logger->debug('>>getVersion()');
if(method_exists($this, 'before_getVersion_callback'))
$this->before_getVersion_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$ver = $provider->getVersion();
if(method_exists($this, 'after_getVersion_callback'))
$this->after_getVersion_callback();
self::$logger->debug('<<getVersion ['.$ver.']');
return $ver;
}
/**
* Builds a new database table for the BO class.
*
* @since 1.0
* @throws AlphaException
*/
public function makeTable() {
self::$logger->debug('>>makeTable()');
if(method_exists($this, 'before_makeTable_callback'))
$this->before_makeTable_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->makeTable();
if(method_exists($this, 'after_makeTable_callback'))
$this->after_makeTable_callback();
self::$logger->info('Successfully created the table ['.$this->getTableName().'] for the class ['.get_class($this).']');
self::$logger->debug('<<makeTable');
}
/**
* Re-builds the table if the model requirements have changed. All data is lost!
*
* @since 1.0
* @throws AlphaException
*/
public function rebuildTable() {
self::$logger->debug('>>rebuildTable()');
if(method_exists($this, 'before_rebuildTable_callback'))
$this->before_rebuildTable_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->rebuildTable();
if(method_exists($this, 'after_rebuildTable_callback'))
$this->after_rebuildTable_callback();
self::$logger->debug('<<rebuildTable');
}
/**
* Drops the table if the model requirements have changed. All data is lost!
*
* @since 1.0
* @param string $tableName Optional table name, leave blank for the defined table for this class to be dropped
* @throws AlphaException
*/
public function dropTable($tableName=null) {
self::$logger->debug('>>dropTable()');
if(method_exists($this, 'before_dropTable_callback'))
$this->before_dropTable_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->dropTable($tableName);
if(method_exists($this, 'after_dropTable_callback'))
$this->after_dropTable_callback();
self::$logger->debug('<<dropTable');
}
/**
* Adds in a new class property without loosing existing data (does an ALTER TABLE query on the
* database).
*
* @param string $propName The name of the new field to add to the database table.
* @since 1.0
* @throws AlphaException
*/
public function addProperty($propName) {
self::$logger->debug('>>addProperty(propName=['.$propName.'])');
global $config;
if(method_exists($this, 'before_addProperty_callback'))
$this->before_addProperty_callback();
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->addProperty($propName);
if(method_exists($this, 'after_addProperty_callback'))
$this->after_addProperty_callback();
self::$logger->debug('<<addProperty');
}
/**
* Populates the current business object from global POST data.
*
* @param boolean $filterAll Defaults to false, set to true if you want to strictly filter all POSTed user input using InputFilter::encode.
* @since 1.0
*/
public function populateFromPost($filterAll=false) {
self::$logger->debug('>>populateFromPost(filterAll=['.$filterAll.'])');
if(method_exists($this, 'before_populateFromPost_callback'))
$this->before_populateFromPost_callback();
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
foreach($properties as $propObj) {
$propName = $propObj->name;
if(!in_array($propName, $this->defaultAttributes) && !in_array($propName, $this->transientAttributes)) {
$propClass = get_class($this->getPropObject($propName));
if(isset($_POST[$propName])) {
if (strtoupper($propClass) != 'DATE' && strtoupper($propClass) != 'TIMESTAMP') {
if($filterAll) {
$this->getPropObject($propName)->setValue(InputFilter::encode($_POST[$propName], false));
}else{
if(strtoupper($propClass) == 'TEXT' && !$this->getPropObject($propName)->getAllowHTML())
$this->getPropObject($propName)->setValue(InputFilter::encode($_POST[$propName], false));
else
$this->getPropObject($propName)->setValue(InputFilter::encode($_POST[$propName], true));
}
}else{
if($filterAll)
$this->getPropObject($propName)->populateFromString(InputFilter::encode($_POST[$propName], false));
else
$this->getPropObject($propName)->populateFromString(InputFilter::encode($_POST[$propName], true));
}
}
}
if ($propName == 'version_num' && isset($_POST['version_num']))
$this->version_num->setValue($_POST['version_num']);
}
if(method_exists($this, 'after_populateFromPost_callback'))
$this->after_populateFromPost_callback();
self::$logger->debug('<<populateFromPost');
}
/**
* Gets the maximum OID value from the database for this class type.
*
* @return integer The maximum OID value in the class table.
* @since 1.0
* @throws AlphaException
*/
public function getMAX() {
self::$logger->debug('>>getMAX()');
if(method_exists($this, 'before_getMAX_callback'))
$this->before_getMAX_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$max = $provider->getMAX();
if(method_exists($this, 'after_getMAX_callback'))
$this->after_getMAX_callback();
self::$logger->debug('<<getMAX ['.$max.']');
return $max;
}
/**
* Gets the count from the database for the amount of objects of this class.
*
* @param array $atributes The attributes to count the objects by (optional).
* @param array $values The values of the attributes to count the objects by (optional).
* @return integer
* @since 1.0
* @throws AlphaException
*/
public function getCount($attributes=array(), $values=array()) {
self::$logger->debug('>>getCount(attributes=['.var_export($attributes, true).'], values=['.var_export($values, true).'])');
if(method_exists($this, 'before_getCount_callback'))
$this->before_getCount_callback();
global $config;
if(!is_array($attributes) || !is_array($values)) {
throw new IllegalArguementException('Illegal arrays attributes=['.var_export($attributes, true).'] and values=['.var_export($values, true).'] provided to loadAllByAttributes');
}
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$count = $provider->getCount($attributes, $values);
if(method_exists($this, 'after_getCount_callback'))
$this->after_getCount_callback();
self::$logger->debug('<<getCount ['.$count.']');
return $count;
}
/**
* Gets the OID for the object in zero-padded format (same as getOID()). This version is designed
* to be overridden in case you want to do something different with the ID of your objects outside
* of the standard 11 digit OID sequence used internally in Alpha.
*
* @return integer 11 digit zero-padded OID value.
* @since 1.0
*/
public function getID() {
self::$logger->debug('>>getID()');
$oid = str_pad($this->OID, 11, '0', STR_PAD_LEFT);
self::$logger->debug('<<getID ['.$oid.']');
return $oid;
}
/**
* Gets the OID for the object in zero-padded format (same as getID()). This version is final so cannot
* be overridden.
*
* @return integer 11 digit zero-padded OID value.
* @since 1.0
*/
public final function getOID() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>getOID()');
$oid = str_pad($this->OID, 11, '0', STR_PAD_LEFT);
self::$logger->debug('<<getOID ['.$oid.']');
return $oid;
}
/**
* Method for getting version number of the object.
*
* @return Integer The object version number.
* @since 1.0
*/
public function getVersionNumber() {
self::$logger->debug('>>getVersionNumber()');
self::$logger->debug('<<getVersionNumber ['.$this->version_num.']');
return $this->version_num;
}
/**
* Populate all of the enum options for this object from the database.
*
* @since 1.0
* @throws AlphaException
*/
protected function setEnumOptions() {
self::$logger->debug('>>setEnumOptions()');
if(method_exists($this, 'before_setEnumOptions_callback'))
$this->before_setEnumOptions_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->setEnumOptions();
self::$logger->debug('<<setEnumOptions');
}
/**
* Generic getter method for accessing class properties. Will use the method get.ucfirst($prop) instead if that
* method exists at a child level (by default). Set $noChildMethods to true if you don't want to use any
* get.ucfirst($prop) method even if it exists, false otherwise (default).
*
* @param string $prop The name of the object property to get.
* @param boolean $noChildMethods Set to true if you do not want to use getters in the child object, defaults
* to false.
* @return mixed The property value.
* @since 1.0
* @throws IllegalArguementException
* @throws AlphaException
*/
public function get($prop, $noChildMethods = false) {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>get(prop=['.$prop.'], noChildMethods=['.$noChildMethods.'])');
if(method_exists($this, 'before_get_callback'))
$this->before_get_callback();
if(empty($prop))
throw new IllegalArguementException('Cannot call get with empty $prop arguement!');
// handle attributes with a get.ucfirst($prop) method
if(!$noChildMethods && method_exists($this, 'get'.ucfirst($prop))) {
if(method_exists($this, 'after_get_callback'))
$this->after_get_callback();
self::$logger->debug('<<get ['.eval('return $this->get'.ucfirst($prop).'();').'])');
return eval('return $this->get'.ucfirst($prop).'();');
}else{
// handle attributes with no dedicated child get.ucfirst($prop) method
if(isset($this->$prop) && method_exists($this->$prop, 'getValue')) {
if(method_exists($this, 'after_get_callback'))
$this->after_get_callback();
// complex types will have a getValue() method, return the value of that
self::$logger->debug('<<get ['.$this->$prop->getValue().'])');
return $this->$prop->getValue();
}elseif(isset($this->$prop)) {
if(method_exists($this, 'after_get_callback'))
$this->after_get_callback();
// simple types returned as-is
self::$logger->debug('<<get ['.$this->$prop.'])');
return $this->$prop;
}else{
throw new AlphaException('Could not access the property ['.$prop.'] on the object of class ['.get_class($this).']');
self::$logger->debug('<<get [false])');
return false;
}
}
}
/**
* Generic setter method for setting class properties. Will use the method set.ucfirst($prop) instead if that
* method exists at a child level (by default). Set $noChildMethods to true if you don't want to use
* any get.ucfirst($prop) method even if it exists, false otherwise (default).
*
* @param string $prop The name of the property to set.
* @param mixed $value The value of the property to set.
* @param boolean $noChildMethods Set to true if you do not want to use setters in the child object, defaults
* to false.
* @since 1.0
* @throws AlphaException
*/
public function set($prop, $value, $noChildMethods = false) {
self::$logger->debug('>>set(prop=['.$prop.'], $value=['.$value.'], noChildMethods=['.$noChildMethods.'])');
if(method_exists($this, 'before_set_callback'))
$this->before_set_callback();
// handle attributes with a set.ucfirst($prop) method
if(!$noChildMethods && method_exists($this, 'set'.ucfirst($prop))) {
if(method_exists($this, 'after_set_callback'))
$this->after_set_callback();
eval('$this->set'.ucfirst($prop)."('$value');");
}else{
// handle attributes with no dedicated child set.ucfirst($prop) method
if(isset($this->$prop)) {
if(method_exists($this, 'after_set_callback'))
$this->after_set_callback();
// complex types will have a setValue() method to call
if (is_object($this->$prop) && get_class($this->$prop) != false) {
if (strtoupper(get_class($this->$prop)) != 'DATE' && strtoupper(get_class($this->$prop)) != 'TIMESTAMP') {
$this->$prop->setValue($value);
}else{
// Date and Timestamp objects have a special setter accepting a string
$this->$prop->populateFromString($value);
}
}else{
// simple types set directly
$this->$prop = $value;
}
}else{
throw new AlphaException('Could not set the property ['.$prop.'] on the object of the class ['.get_class($this).']. Property may not exist, or else does not have a setValue() method and is private or protected.');
}
}
self::$logger->debug('<<set');
}
/**
* Gets the property object rather than the value for complex attributes. Returns false if
* the property exists but is private.
*
* @param string $prop The name of the property we are getting.
* @return AlphaType The complex type object found.
* @since 1.0
* @throws IllegalArguementException
*/
public function getPropObject($prop) {
self::$logger->debug('>>getPropObject(prop=['.$prop.'])');
if(method_exists($this, 'before_getPropObject_callback'))
$this->before_getPropObject_callback();
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
// firstly, check for private
$attribute = new ReflectionProperty(get_class($this), $prop);
if($attribute->isPrivate()) {
if(method_exists($this, 'after_getPropObject_callback'))
$this->after_getPropObject_callback();
self::$logger->debug('<<getPropObject [false]');
return false;
}
foreach($properties as $propObj) {
$propName = $propObj->name;
if($prop == $propName) {
if(method_exists($this, 'after_getPropObject_callback'))
$this->after_getPropObject_callback();
self::$logger->debug('<<getPropObject ['.var_export($this->$prop, true).']');
return $this->$prop;
}
}
throw new IllegalArguementException('Could not access the property object ['.$prop.'] on the object of class ['.get_class($this).']');
self::$logger->debug('<<getPropObject [false]');
return false;
}
/**
* Checks to see if the table exists in the database for the current business class.
*
* @return boolean
* @since 1.0
* @throws AlphaException
*/
public function checkTableExists() {
self::$logger->debug('>>checkTableExists()');
if(method_exists($this, 'before_checkTableExists_callback'))
$this->before_checkTableExists_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$tableExists = $provider->checkTableExists();
if(method_exists($this, 'after_checkTableExists_callback'))
$this->after_checkTableExists_callback();
self::$logger->debug('<<checkTableExists ['.$tableExists.']');
return $tableExists;
}
/**
* Static method to check the database and see if the table for the indicated BO class name
* exists (assumes table name will be $BOClassName less "Object").
*
* @param string $BOClassName The name of the business object class we are checking.
* @return boolean
* @since 1.0
* @throws AlphaException
*/
public static function checkBOTableExists($BOClassName) {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>checkBOTableExists(BOClassName=['.$BOClassName.'])');
global $config;
require_once $config->get('sysRoot').'alpha/model/'.$config->get('sysDBProviderName').'.inc';
eval('$tableExists = '.$config->get('sysDBProviderName').'::checkBOTableExists($BOClassName);');
self::$logger->debug('<<checkBOTableExists ['.($tableExists ? 'true' : 'false').']');
return $tableExists;
}
/**
* Checks to see if the table in the database matches (for fields) the business class definition, i.e. if the
* database table is in sync with the class definition.
*
* @return boolean
* @since 1.0
* @throws AlphaException
*/
public function checkTableNeedsUpdate() {
self::$logger->debug('>>checkTableNeedsUpdate()');
global $config;
if(method_exists($this, 'before_checkTableNeedsUpdate_callback'))
$this->before_checkTableNeedsUpdate_callback();
$tableExists = $this->checkTableExists();
if (!$tableExists) {
self::$logger->debug('<<checkTableNeedsUpdate [true]');
return true;
}else{
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$updateRequired = $provider->checkTableNeedsUpdate();
if(method_exists($this, 'after_checkTableNeedsUpdate_callback'))
$this->after_checkTableNeedsUpdate_callback();
self::$logger->debug('<<checkTableNeedsUpdate ['.$updateRequired.']');
return $updateRequired;
}
}
/**
* Returns an array containing any properties on the class which have not been created on the database
* table yet.
*
* @return array An array of missing fields in the database table.
* @since 1.0
* @throws AlphaException
*/
public function findMissingFields() {
self::$logger->debug('>>findMissingFields()');
global $config;
if(method_exists($this, 'before_findMissingFields_callback'))
$this->before_findMissingFields_callback();
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$missingFields = $provider->findMissingFields();
if(method_exists($this, 'after_findMissingFields_callback'))
$this->after_findMissingFields_callback();
self::$logger->debug('<<findMissingFields ['.var_export($missingFields, true).']');
return $missingFields;
}
/**
* Getter for the TABLE_NAME, which should be set by a child of this class.
*
* @return string The table name in the database.
* @since 1.0
* @throws AlphaException
*/
public function getTableName() {
self::$logger->debug('>>getTableName()');
eval('$TABLE_NAME = '.get_class($this).'::TABLE_NAME;');
if(!empty($TABLE_NAME)) {
self::$logger->debug('<<getTableName ['.$TABLE_NAME.']');
return $TABLE_NAME;
}else{
throw new AlphaException('Error: no TABLE_NAME constant set for the class '.get_class($this));
self::$logger->debug('<<getTableName []');
return '';
}
}
/**
* Method for getting the OID of the person who created this BO.
*
* @return Integer The OID of the creator.
* @since 1.0
*/
public function getCreatorId() {
self::$logger->debug('>>getCreatorId()');
self::$logger->debug('<<getCreatorId ['.$this->created_by.']');
return $this->created_by;
}
/**
* Method for getting the OID of the person who updated this BO.
*
* @return Integer The OID of the updator.
* @since 1.0
*/
public function getUpdatorId() {
self::$logger->debug('>>getUpdatorId()');
self::$logger->debug('<<getUpdatorId ['.$this->updated_by.']');
return $this->updated_by;
}
/**
* Method for getting the date/time of when the BO was created.
*
* @return Timestamp
* @since 1.0
*/
public function getCreateTS() {
self::$logger->debug('>>getCreateTS()');
self::$logger->debug('<<getCreateTS ['.$this->created_ts.']');
return $this->created_ts;
}
/**
* Method for getting the date/time of when the BO was last updated.
*
* @return Timestamp
* @since 1.0
*/
public function getUpdateTS() {
self::$logger->debug('>>getUpdateTS()');
self::$logger->debug('<<getUpdateTS ['.$this->updated_ts.']');
return $this->updated_ts;
}
/**
* Adds the name of the attribute provided to the list of transient (non-saved) attributes for this BO.
*
* @param string $attributeName The name of the attribute to not save.
* @since 1.0
*/
public function markTransient($attributeName) {
self::$logger->debug('>>markTransient(attributeName=['.$attributeName.'])');
self::$logger->debug('<<markTransient');
array_push($this->transientAttributes, $attributeName);
}
/**
* Removes the name of the attribute provided from the list of transient (non-saved) attributes for this BO,
* ensuring that it will be saved on the next attempt.
*
* @param string $attributeName The name of the attribute to save.
* @since 1.0
*/
public function markPersistent($attributeName) {
self::$logger->debug('>>markPersistent(attributeName=['.$attributeName.'])');
self::$logger->debug('<<markPersistent');
$this->transientAttributes = array_diff($this->transientAttributes, array($attributeName));
}
/**
* Adds the name of the attribute(s) provided to the list of unique (constrained) attributes for this BO.
*
* @param string $attribute1Name The first attribute to mark unique in the database.
* @param string $attribute2Name The second attribute to mark unique in the databse (optional, use only for composite keys).
* @param string $attribute3Name The third attribute to mark unique in the databse (optional, use only for composite keys).
* @since 1.0
*/
protected function markUnique($attribute1Name, $attribute2Name='', $attribute3Name='') {
self::$logger->debug('>>markUnique(attribute1Name=['.$attribute1Name.'], attribute2Name=['.$attribute2Name.'], attribute3Name=['.$attribute3Name.'])');
if(empty($attribute2Name)) {
array_push($this->uniqueAttributes, $attribute1Name);
}else{
// Process composite unique keys: add them seperated by a + sign
if($attribute3Name == '')
$attributes = $attribute1Name.'+'.$attribute2Name;
else
$attributes = $attribute1Name.'+'.$attribute2Name.'+'.$attribute3Name;
array_push($this->uniqueAttributes, $attributes);
}
self::$logger->debug('<<markUnique');
}
/**
* Returns the array of names of unique attributes on this BO
*
* @return array
* @since 1.1
*/
public function getUniqueAttributes() {
self::$logger->debug('>>getUniqueAttributes()');
self::$logger->debug('<<getUniqueAttributes: ['.print_r($this->uniqueAttributes, true).']');
return $this->uniqueAttributes;
}
/**
* Gets an array of all of the names of the active database indexes for this class.
*
* @return array An array of database indexes on this table.
* @since 1.0
* @throws AlphaException
*/
public function getIndexes() {
self::$logger->debug('>>getIndexes()');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$indexNames = $provider->getIndexes();
self::$logger->debug('<<getIndexes ['.print_r($indexNames, true).']');
return $indexNames;
}
/**
* Creates a foreign key constraint (index) in the database on the given attribute.
*
* @param string $attributeName The name of the attribute to apply the index on.
* @param string $relatedClass The name of the related class in the format "NameObject".
* @param string $relatedClassAttribute The name of the field to relate to on the related class.
* @param bool $allowNullValues For foreign key indexes that don't allow null values, set this to false (default is true).
* @since 1.0
* @throws FailedIndexCreateException
*/
public function createForeignIndex($attributeName, $relatedClass, $relatedClassAttribute) {
self::$logger->debug('>>createForeignIndex(attributeName=['.$attributeName.'], relatedClass=['.$relatedClass.'], relatedClassAttribute=['.$relatedClassAttribute.']');
global $config;
if(method_exists($this, 'before_createForeignIndex_callback'))
$this->before_createForeignIndex_callback();
AlphaDAO::loadClassDef($relatedClass);
$relatedBO = new $relatedClass;
$tableName = $relatedBO->getTableName();
// if the relation is on itself (table-wise), exist without attempting to create the foreign keys
if($this->getTableName() == $tableName) {
self::$logger->debug('<<createForeignIndex');
return;
}
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->createForeignIndex($attributeName, $relatedClass, $relatedClassAttribute);
if(method_exists($this, 'after_createForeignIndex_callback'))
$this->after_createForeignIndex_callback();
self::$logger->debug('<<createForeignIndex');
}
/**
* Creates a unique index in the database on the given attribute(s).
*
* @param string $attribute1Name The first attribute to mark unique in the database.
* @param string $attribute2Name The second attribute to mark unique in the databse (optional, use only for composite keys).
* @param string $attribute3Name The third attribute to mark unique in the databse (optional, use only for composite keys).
* @since 1.0
* @throws FailedIndexCreateException
*/
public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '') {
self::$logger->debug('>>createUniqueIndex(attribute1Name=['.$attribute1Name.'], attribute2Name=['.$attribute2Name.'], attribute3Name=['.$attribute3Name.'])');
if(method_exists($this, 'before_createUniqueIndex_callback'))
$this->before_createUniqueIndex_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$provider->createUniqueIndex($attribute1Name, $attribute2Name, $attribute3Name);
if(method_exists($this, 'after_createUniqueIndex_callback'))
$this->before_createUniqueIndex_callback();
self::$logger->debug('<<createUniqueIndex');
}
/**
* Gets the data labels array.
*
* @return array An array of attribute labels.
* @since 1.0
*/
public function getDataLabels() {
self::$logger->debug('>>getDataLabels()');
self::$logger->debug('<<getDataLabels() ['.var_export($this->dataLabels, true).'])');
return $this->dataLabels;
}
/**
* Gets the data label for the given attribute name.
*
* @param $att The attribute name to get the label for.
* @return string
* @since 1.0
* @throws IllegalArguementException
*/
public function getDataLabel($att) {
self::$logger->debug('>>getDataLabel(att=['.$att.'])');
if(in_array($att, array_keys($this->dataLabels))) {
self::$logger->debug('<<getDataLabel ['.$this->dataLabels[$att].'])');
return $this->dataLabels[$att];
}else{
throw new IllegalArguementException('No data label found on the class ['.get_class($this).'] for the attribute ['.$att.']');
self::$logger->debug('<<getDataLabel [])');
return '';
}
}
/**
* Loops over the core and custom BO directories and builds an array of all of the BO class names in the system.
*
* @return array An array of business object class names.
* @since 1.0
*/
public static function getBOClassNames() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>getBOClassNames()');
global $config;
$classNameArray = array();
if(file_exists($config->get('sysRoot').'model')) { // it is possible it has not been created yet...
// first get any custom BOs
$handle = opendir($config->get('sysRoot').'model');
// loop over the business object directory
while (false !== ($file = readdir($handle))) {
if (preg_match("/Object.inc/", $file)) {
$classname = substr($file, 0, -4);
array_push($classNameArray, $classname);
}
}
}
// now loop over the core BOs provided with Alpha
$handle = opendir($config->get('sysRoot').'alpha/model');
// loop over the business object directory
while (false !== ($file = readdir($handle))) {
if (preg_match("/Object.inc/", $file)) {
$classname = substr($file, 0, -4);
array_push($classNameArray, $classname);
}
}
asort($classNameArray);
self::$logger->debug('<<getBOClassNames ['.var_export($classNameArray, true).']');
return $classNameArray;
}
/**
* Get the array of default attribute names.
*
* @return array An array of attribute names.
* @since 1.0
*/
public function getDefaultAttributes() {
self::$logger->debug('>>getDefaultAttributes()');
self::$logger->debug('<<getDefaultAttributes ['.var_export($this->defaultAttributes, true).']');
return $this->defaultAttributes;
}
/**
* Get the array of transient attribute names.
*
* @return array An array of attribute names.
* @since 1.0
*/
public function getTransientAttributes() {
self::$logger->debug('>>getTransientAttributes()');
self::$logger->debug('<<getTransientAttributes ['.var_export($this->transientAttributes, true).']');
return $this->transientAttributes;
}
/**
* Get the array of persistent attribute names, i.e. those that are saved in the database.
*
* @return array An array of attribute names.
* @since 1.0
*/
public function getPersistentAttributes() {
self::$logger->debug('>>getPersistentAttributes()');
$attributes = array();
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
foreach($properties as $propObj) {
$propName = $propObj->name;
// filter transient attributes
if(!in_array($propName, $this->transientAttributes)) {
array_push($attributes, $propName);
}
}
self::$logger->debug('<<getPersistentAttributes ['.var_export($attributes, true).']');
return $attributes;
}
/**
* Setter for the Object ID (OID)
*
* @param integer $OID The Object ID.
* @since 1.0
*/
public function setOID($OID) {
self::$logger->debug('>>setOID(OID=['.$OID.'])');
self::$logger->debug('<<setOID');
$this->OID = $OID;
}
/**
* Inspector to see if the business object is transient (not presently stored in the database).
*
* @return boolean
* @since 1.0
*/
public function isTransient() {
self::$logger->debug('>>isTransient()');
if(empty($this->OID) || !isset($this->OID) || $this->OID == '00000000000') {
self::$logger->debug('<<isTransient [true]');
return true;
}else{
self::$logger->debug('<<isTransient [false]');
return false;
}
}
/**
* Get the last database query run on this object.
*
* @return string An SQL query string.
* @since 1.0
*/
public function getLastQuery() {
self::$logger->debug('>>getLastQuery()');
self::$logger->debug('<<getLastQuery ['.$this->lastQuery.']');
return $this->lastQuery;
}
/**
* Unsets all of the attributes of this object to null.
*
* @since 1.0
*/
private function clear() {
self::$logger->debug('>>clear()');
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
foreach($properties as $propObj) {
$propName = $propObj->name;
if(!$propObj->isPrivate())
unset($this->$propName);
}
self::$logger->debug('<<clear');
}
/**
* Reloads the object from the database, overwritting any attribute values in memory.
*
* @since 1.0
* @throws AlphaException
*/
public function reload() {
self::$logger->debug('>>reload()');
if(!$this->isTransient()) {
$this->load($this->getOID());
}else{
throw new AlphaException('Cannot reload transient object from database!');
}
self::$logger->debug('<<reload');
}
/**
* Loads the definition from the file system for the BO class name provided.
*
* @param string $classname The name of the business object class name.
* @since 1.0
* @throws IllegalArguementException
*/
public static function loadClassDef($classname) {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>loadClassDef(classname=['.$classname.'])');
global $config;
if(file_exists($config->get('sysRoot').'model/'.$classname.'.inc'))
require_once $config->get('sysRoot').'model/'.$classname.'.inc';
elseif(file_exists($config->get('sysRoot').'alpha/model/'.$classname.'.inc'))
require_once $config->get('sysRoot').'alpha/model/'.$classname.'.inc';
elseif(file_exists($config->get('sysRoot').'alpha/model/types/'.$classname.'.inc'))
require_once $config->get('sysRoot').'alpha/model/types/'.$classname.'.inc';
else
throw new IllegalArguementException('The class ['.$classname.'] is not defined anywhere!');
self::$logger->debug('<<loadClassDef');
}
/**
* Checks if the definition for the BO class name provided exists on the file system.
*
* @param string $classname The name of the business object class name.
* @return boolean
* @since 1.0
*/
public static function checkClassDefExists($classname) {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>checkClassDefExists(classname=['.$classname.'])');
global $config;
$exists = false;
if(file_exists($config->get('sysRoot').'model/'.$classname.'.inc'))
$exists = true;
if(file_exists($config->get('sysRoot').'alpha/model/'.$classname.'.inc'))
$exists = true;
if(file_exists($config->get('sysRoot').'alpha/model/types/'.$classname.'.inc'))
$exists = true;
self::$logger->debug('<<checkClassDefExists ['.$exists.']');
return $exists;
}
/**
* Checks that a record exists for the BO in the database.
*
* @param int $OID The Object ID of the object we want to see whether it exists or not.
* @return boolean
* @since 1.0
* @throws AlphaException
*/
public function checkRecordExists($OID) {
self::$logger->debug('>>checkRecordExists(OID=['.$OID.'])');
if(method_exists($this, 'before_checkRecordExists_callback'))
$this->before_checkRecordExists_callback();
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$recordExists = $provider->checkRecordExists($OID);
if(method_exists($this, 'after_checkRecordExists_callback'))
$this->after_checkRecordExists_callback();
self::$logger->debug('<<checkRecordExists ['.$recordExists.']');
return $recordExists;
}
/**
* Checks to see if the table name matches the classname, and if not if the table
* name matches the classname name of another BO, i.e. the table is used to store
* multiple types of BOs.
*
* @return bool
* @since 1.0
* @throws BadBOTableNameException
*/
public function isTableOverloaded() {
self::$logger->debug('>>isTableOverloaded()');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), $this);
$isOverloaded = $provider->isTableOverloaded();
self::$logger->debug('<<isTableOverloaded ['.$isOverloaded.']');
return $isOverloaded;
}
/**
* Starts a new database transaction.
*
* @since 1.0
* @throws AlphaException
*/
public static function begin() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>begin()');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), new PersonObject());
try{
$provider->commit();
}catch (Exception $e) {
throw new AlphaException('Error beginning a new transaction, error is ['.$e->getMessage().']');
}
self::$logger->debug('<<begin');
}
/**
* Commits the current database transaction.
*
* @since 1.0
* @throws FailedSaveException
*/
public static function commit() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>commit()');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), new PersonObject());
try{
$provider->commit();
}catch (Exception $e) {
throw new FailedSaveException('Error commiting a transaction, error is ['.$e->getMessage().']');
}
self::$logger->debug('<<commit');
}
/**
* Aborts the current database transaction.
*
* @since 1.0
* @throws AlphaException
*/
public static function rollback() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>rollback()');
global $config;
$provider = AlphaDAOProviderFactory::getInstance($config->get('sysDBProviderName'), new PersonObject());
try{
$provider->rollback();
}catch (Exception $e) {
throw new FailedSaveException('Error aborting a transaction, error is ['.$e->getMessage().']');
}
self::$logger->debug('<<rollback');
}
/**
* Static method that tries to determine if the system database has been installed or not.
*
* @return boolean
* @since 1.0
*/
public static function isInstalled() {
if(self::$logger == null)
self::$logger = new Logger('AlphaDAO');
self::$logger->debug('>>isInstalled()');
global $config;
/*
* Install conditions are:
*
* 1. person table exists
* 2. rights table exists
*/
if(AlphaDAO::checkBOTableExists('PersonObject') && AlphaDAO::checkBOTableExists('RightsObject')) {
self::$logger->debug('<<isInstalled [true]');
return true;
}else{
self::$logger->debug('<<isInstalled [false]');
return false;
}
}
/**
* Returns true if the BO has a Relation property called tags, false otherwise.
*
* @return boolean
* @since 1.0
*/
public function isTagged() {
if(isset($this->taggedAttributes) && isset($this->tags) && $this->tags instanceof Relation)
return true;
else
return false;
}
/**
* Setter for the BO version number.
*
* @param integer $versionNumber The version number.
* @since 1.0
*/
private function setVersion($versionNumber) {
$this->version_num->setValue($versionNumber);
}
/**
* Cast a BO to another type of BO. A new BO will be returned with the same OID and
* version_num as the old BO, so this is NOT a true cast but is a copy. All attribute
* values will be copied accross.
*
* @param string $targetClassName The name of the target BO class.
* @param AlphaDAO $originalBO The original business object.
* @return AlphaDAO The new business object resulting from the cast.
* @since 1.0
*/
public function cast($targetClassName, $originalBO) {
AlphaDAO::loadClassDef($targetClassName);
$BO = new $targetClassName;
$BO->setOID($originalBO->getOID());
$BO->setVersion($originalBO->getVersion());
// get the class attributes
$originalBOreflection = new ReflectionClass(get_class($originalBO));
$originalBOproperties = $originalBOreflection->getProperties();
$newBOreflection = new ReflectionClass($targetClassName);
$newBOproperties = $newBOreflection->getProperties();
// copy the property values from the old BO to the new BO
if(count($originalBOproperties) < count($newBOproperties)) {
// the original BO is smaller, so loop over its properties
foreach($originalBOproperties as $propObj) {
$propName = $propObj->name;
if(!in_array($propName, $this->transientAttributes))
$BO->set($propName, $originalBO->get($propName));
}
}else{
// the new BO is smaller, so loop over its properties
foreach($newBOproperties as $propObj) {
$propName = $propObj->name;
if(!in_array($propName, $this->transientAttributes))
$BO->set($propName, $originalBO->get($propName));
}
}
return $BO;
}
/**
* Converts "BusinessObject" to "Business" and returns.
*
* @return string
* @since 1.0
*/
public function getFriendlyClassName() {
$name = substr(get_class($this), 0, -6);
return $name;
}
/**
* Check to see if an attribute exists on the BO.
*
* @param $attribute The attribute name.
* @return boolean
* @since 1.0
*/
public function hasAttribute($attribute) {
try{
$exists = $this->$attribute;
return true;
}catch(Exception $e) {
return false;
}
}
/**
* Stores the business object to the configured cache instance
*
* @since 1.1
*/
public function addToCache() {
self::$logger->debug('>>addToCache()');
global $config;
try {
$cache = AlphaCacheProviderFactory::getInstance($config->get('sysCacheProviderName'));
$cache->set(get_class($this).'-'.$this->getOID(), $this, 3600);
}catch(Exception $e) {
self::$logger->error('Error while attempting to store a business object to the ['.$config->get('sysCacheProviderName').']
instance: ['.$e->getMessage().']');
}
self::$logger->debug('<<addToCache');
}
/**
* Removes the business object from the configured cache instance
*
* @since 1.1
*/
public function removeFromCache() {
self::$logger->debug('>>removeFromCache()');
global $config;
try {
$cache = AlphaCacheProviderFactory::getInstance($config->get('sysCacheProviderName'));
$cache->delete(get_class($this).'-'.$this->getOID());
}catch(Exception $e) {
self::$logger->error('Error while attempting to remove a business object from ['.$config->get('sysCacheProviderName').']
instance: ['.$e->getMessage().']');
}
self::$logger->debug('<<removeFromCache');
}
/**
* Attempts to load the business object from the configured cache instance
*
* @since 1.1
* @return boolean
*/
public function loadFromCache() {
self::$logger->debug('>>loadFromCache()');
global $config;
try {
$cache = AlphaCacheProviderFactory::getInstance($config->get('sysCacheProviderName'));
$BO = $cache->get(get_class($this).'-'.$this->getOID());
if(!$BO) {
self::$logger->debug('Cache miss on key ['.get_class($this).'-'.$this->getOID().']');
self::$logger->debug('<<loadFromCache: [false]');
return false;
}else{
// get the class attributes
$reflection = new ReflectionClass(get_class($this));
$properties = $reflection->getProperties();
foreach($properties as $propObj) {
$propName = $propObj->name;
// filter transient attributes
if(!in_array($propName, $this->transientAttributes)) {
$this->set($propName, $BO->get($propName));
}elseif(!$propObj->isPrivate() && isset($this->$propName) && $this->$propName instanceof Relation) {
$prop = $this->getPropObject($propName);
// handle the setting of ONE-TO-MANY relation values
if($prop->getRelationType() == 'ONE-TO-MANY') {
$this->set($propObj->name, $this->getOID());
}
}
}
self::$logger->debug('<<loadFromCache: [true]');
return true;
}
}catch(Exception $e) {
self::$logger->error('Error while attempting to load a business object from ['.$config->get('sysCacheProviderName').']
instance: ['.$e->getMessage().']');
self::$logger->debug('<<loadFromCache: [false]');
return false;
}
}
/**
* Sets the last query executed on this business object
*
* @param string $query
* @since 1.1
*/
public function setLastQuery($query) {
self::$logger->sql($query);
$this->lastQuery = $query;
}
}
?>

	alpha--model

[ class tree: alpha--model ] [ index: alpha--model ] [ all elements ]

Source for file AlphaDAO.inc