File Source for AbstractMapper.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch_Model
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* This model class represents a single file with its metadata.
*
* Its required that each MApper class follows a specific naming schema:
* Model class name for which it mapps plus the suffix 'Mapper'.
*
* Example:
* model class -> MediaSearch_Model_Foo
* mapper class -> MediaSearch_Model_FooMapper
*
* @see Zend_Application_Bootstrap_Bootstrap
*
* @category MediaSearch
* @package MediaSearch_Model
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
abstract class MediaSearch_Model_AbstractMapper {
private $dbTable;
/**
* Sets the database table gateway object.
* You can provide a class name as string or an object.
*
* The objects should be of the class returned by getTableClassName().
*
* @access public
*
* @param mixed $dbTable
* @return MediaSearch_Model_AbstractMapper
*/
public function setDbTable($dbTable) {
if (is_string($dbTable)) {
$dbTable = new $dbTable();
}
$requiredType = $this->getTableClassName();
if (!$dbTable instanceof $requiredType) {
throw new Exception('Invalid table data gateway provided');
}
$this->dbTable = $dbTable;
return $this;
}
/**
* Returns the atabase table gateway object.
* Constructs a new one if no one is set.
*
* @access public
* @return MediaSearch_Model_DbTable_Abstract
*/
public function getDbTable() {
if (null === $this->dbTable) {
$this->setDbTable($this->getTableClassName());
}
return $this->dbTable;
}
/**
* Constructs the required class name depending on the own classname.
* The schema is as followed. The beginning of each class name is
* MediaSearch_Model_DbTable_ after that the trailing part of mapper class
* name is appended to it without the trailing 'Mapper'.
*
* Example:
* mapper class -> MediaSearch_Model_FooMapper
* resulting db class -> MediaSearch_Model_DbTable_Foo
*
* @access private
* @return string
*/
private function getTableClassName() {
$thisClassName = get_class($this);
$tableClassname = substr($thisClassName, strrpos($thisClassName, '_') + 1);
return 'MediaSearch_Model_DbTable_' . str_replace('Mapper', '', $tableClassname);
}
/**
* Sets up a given model object with the data in the row array.
*
* @abstract
* @access protected
* @param array $row
* @param MediaSearch_Model_FileMeta $fileMeta
*/
abstract protected function createModel($row, MediaSearch_Model_Abstract $model);
/**
* Creates model objectes from multiple rows.
*
* @abstract
* @access protected
* @param array $resultSet
* @return array
*/
abstract protected function createModelFromRowSet(array $resultSet);
/**
/**
* Returns the count of data rows in the db table.
*
* @access public
* @return int
*/
public function count() {
return $this->getDbTable()->count();
}
/**
*
* @param <type> $limit
* @param <type> $offset
* @return <type>
*/
public function fetchAll($limit = null, $offset = null) {
$resultSet = $this->getDbTable()->fetchAll(null, null, $limit, $offset);
if (0 == count($resultSet)) {
return;
}
return $this->createModelFromRowSet($resultSet->toArray());
}
}

Source for file AbstractMapper.php