diff options
Diffstat (limited to 'framework/Data/ActiveRecord/TActiveRecordGateway.php')
| -rw-r--r-- | framework/Data/ActiveRecord/TActiveRecordGateway.php | 305 |
1 files changed, 305 insertions, 0 deletions
diff --git a/framework/Data/ActiveRecord/TActiveRecordGateway.php b/framework/Data/ActiveRecord/TActiveRecordGateway.php new file mode 100644 index 00000000..829230fc --- /dev/null +++ b/framework/Data/ActiveRecord/TActiveRecordGateway.php @@ -0,0 +1,305 @@ +<?php +/**
+ * TActiveRecordGateway, TActiveRecordStatementType, TActiveRecordGatewayEventParameter classes file.
+ *
+ * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
+ * @version $Id$
+ * @package System.Data.ActiveRecord
+ */
+
+/**
+ * TActiveRecordGateway excutes the SQL command queries and returns the data
+ * record as arrays (for most finder methods).
+ *
+ * @author Wei Zhuo <weizho[at]gmail[dot]com>
+ * @version $Id$
+ * @package System.Data.ActiveRecord
+ * @since 3.1
+ */
+class TActiveRecordGateway extends TComponent
+{
+ private $_manager;
+ private $_tables=array();
+
+ /**
+ * Property name for optional table name in TActiveRecord.
+ */
+ const PROPERTY_TABLE_NAME='_tablename';
+
+ /**
+ * Record gateway constructor.
+ * @param TActiveRecordManager $manager
+ */
+ public function __construct(TActiveRecordManager $manager)
+ {
+ $this->_manager=$manager;
+ }
+
+ /**
+ * @return TActiveRecordManager record manager.
+ */
+ protected function getManager()
+ {
+ return $this->_manager;
+ }
+
+ /**
+ * Gets the table name from the $_tablename property of the active record
+ * class if defined, otherwise use the class name as table name.
+ * @param TActiveRecord active record instance
+ * @return string table name for the given record class.
+ */
+ public function getTableName(TActiveRecord $record)
+ {
+ $class = new ReflectionClass($record);
+ if($class->hasProperty(self::PROPERTY_TABLE_NAME))
+ {
+ $value = $class->getProperty(self::PROPERTY_TABLE_NAME)->getValue();
+ if($value===null)
+ throw new TActiveRecordException('ar_invalid_tablename_property',
+ get_class($record),self::PROPERTY_TABLE_NAME);
+ return $value;
+ }
+ else
+ return strtolower(get_class($record));
+ }
+
+ /**
+ * Gets the meta data for given database and table.
+ */
+ public function getMetaData(TActiveRecord $record)
+ {
+ $type=get_class($record);
+ if(!isset($this->_tables[$type]))
+ {
+ $conn = $record->getDbConnection();
+ $inspector = $this->getManager()->getTableInspector($conn);
+ $table = $this->getTableName($record);
+ $this->_tables[$type] = $inspector->getTableMetaData($table);
+ }
+ return $this->_tables[$type];
+ }
+
+ /**
+ * @param array table meta data.
+ */
+ public function setAllMetaData($data)
+ {
+ $this->_tables=$data;
+ }
+
+ /**
+ * @return array all table meta data.
+ */
+ public function getAllMetaData()
+ {
+ return $this->_tables;
+ }
+
+ /**
+ * Returns record data matching the given primary key(s). If the table uses
+ * composite key, specify the name value pairs as an array.
+ * @param TActiveRecord active record instance.
+ * @param array primary name value pairs
+ * @return array record data
+ */
+ public function findRecordByPK(TActiveRecord $record,$keys)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getFindByPkCommand($record->getDbConnection(),$keys);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Select,$command,$record,$keys);
+ return $meta->postQueryRow($command->queryRow());
+ }
+
+ /**
+ * Returns record data matching the given critera. If $iterator is true, it will
+ * return multiple rows as TDbDataReader otherwise it returns the <b>first</b> row data.
+ * @param TActiveRecord active record finder instance.
+ * @param TActiveRecordCriteria search criteria.
+ * @param boolean true to return multiple rows as iterator, false returns first row.
+ * @return mixed matching data.
+ */
+ public function findRecordsByCriteria(TActiveRecord $record, $criteria, $iterator=false)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getFindByCriteriaCommand($record->getDbConnection(),$criteria);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Select,$command,$record,$criteria);
+ return $iterator ? $meta->postQuery($command->query()) : $meta->postQueryRow($command->queryRow());
+ }
+
+ /**
+ * Return record data from sql query.
+ * @param TActiveRecord active record finder instance.
+ * @param string SQL string
+ * @param array query parameters.
+ * @return TDbDataReader result iterator.
+ */
+ public function findRecordsBySql(TActiveRecord $record, $sql,$parameters=array())
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getFindBySqlCommand($record->getDbConnection(),$sql,$parameters);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Select,$command,$record,$parameters);
+ return $meta->postQuery($command->query());
+ }
+
+ /**
+ * Returns the number of records that match the given criteria.
+ * @param TActiveRecord active record finder instance.
+ * @param TActiveRecordCriteria search criteria
+ * @return int number of records.
+ */
+ public function countRecords(TActiveRecord $record, $criteria)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getCountRecordsCommand($record->getDbConnection(),$criteria);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Select,$command,$record,$criteria);
+ return intval($command->queryScalar());
+ }
+
+ /**
+ * Insert a new record.
+ * @param TActiveRecord new record.
+ * @return int number of rows affected.
+ */
+ public function insert(TActiveRecord $record)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getInsertCommand($record->getDbConnection(),$record);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Insert,$command,$record);
+ $rowsAffected = $command->execute();
+ if($rowsAffected===1)
+ $meta->updatePostInsert($record->getDbConnection(),$record);
+ return $rowsAffected;
+ }
+
+ /**
+ * Update the record.
+ * @param TActiveRecord dirty record.
+ * @return int number of rows affected.
+ */
+ public function update(TActiveRecord $record)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getUpdateCommand($record->getDbConnection(),$record);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Update,$command,$record);
+ return $command->execute();
+ }
+
+ /**
+ * Delete the record.
+ * @param TActiveRecord record to be deleted.
+ * @return int number of rows affected.
+ */
+ public function delete(TActiveRecord $record)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getDeleteCommand($record->getDbConnection(),$record);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Delete,$command,$record);
+ return $command->execute();
+ }
+
+ /**
+ * Delete multiple records using primary keys.
+ * @param TActiveRecord finder instance.
+ * @return int number of rows deleted.
+ */
+ public function deleteRecordsByPk(TActiveRecord $record, $keys)
+ {
+ $meta = $this->getMetaData($record);
+ $command = $meta->getDeleteByPkCommand($record->getDBConnection(),$keys);
+ $this->raiseCommandEvent(TActiveRecordStatementType::Delete,$command,$record,$keys);
+ return $command->execute();
+ }
+
+ /**
+ * Raise the corresponding command event, insert, update, delete or select.
+ * @param string command type
+ * @param TDbCommand sql command to be executed.
+ * @param TActiveRecord active record
+ * @param mixed data for the command.
+ */
+ protected function raiseCommandEvent($type,$command,$record=null,$data=null)
+ {
+ $param = new TActiveRecordGatewayEventParameter($type,$command,$record,$data);
+ $manager = $record->getRecordManager();
+ $event = 'on'.$type;
+ $manager->{$event}($param);
+ }
+}
+
+/**
+ * Command statement types.
+ *
+ * @author Wei Zhuo <weizho[at]gmail[dot]com>
+ * @version $Id$
+ * @package System.Data.ActiveRecord
+ * @since 3.1
+ */
+class TActiveRecordStatementType
+{
+ const Insert='Insert';
+ const Update='Update';
+ const Delete='Delete';
+ const Select='Select';
+}
+
+/**
+ * Active Record command event parameter.
+ *
+ * @author Wei Zhuo <weizho[at]gmail[dot]com>
+ * @version $Id$
+ * @package System.Data.ActiveRecord
+ * @since 3.1
+ */
+class TActiveRecordGatewayEventParameter extends TActiveRecordEventParameter
+{
+ private $_type;
+ private $_command;
+ private $_record;
+ private $_data;
+
+ /**
+ * New gateway command event parameter.
+ */
+ public function __construct($type,$command,$record=null,$data=null)
+ {
+ $this->_type=$type;
+ $this->_command=$command;
+ $this->_data=$data;
+ $this->_record=$record;
+ }
+
+ /**
+ * @return string TActiveRecordStateType
+ */
+ public function getType()
+ {
+ return $this->_type;
+ }
+
+ /**
+ * @return TDbCommand command to be executed.
+ */
+ public function getCommand()
+ {
+ return $this->_command;
+ }
+
+ /**
+ * @return TActiveRecord active record.
+ */
+ public function getRecord()
+ {
+ return $this->_record;
+ }
+
+ /**
+ * @return mixed command data.
+ */
+ public function getData()
+ {
+ return $this->_data;
+ }
+}
+ +?>
\ No newline at end of file |