File Source for Abstract.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.
*
* @see Zend_Application_Bootstrap_Bootstrap
*
* @abstract
* @category MediaSearch
* @package MediaSearch_Model
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
abstract class MediaSearch_Model_Abstract {
/**
* Database mapper class.
*
* @access private
* @var MediaSearch_Model_FileMetaMapper
*/
private $mapper;
/**
* Unique id.
*
* @access private
* @var int
*/
private $id;
/**
* Can take a associatove array with initial values.
* @param array $options
*/
public function __construct(array $options = null) {
if (null !== $options) {
$this->setOptions($options);
}
}
/**
* Returns the unique id.
*
* @access public
* @return int
*/
public function getId() {
return $this->id;
}
/**
* Sets the unique id. This id need to be unique!
*
* @access public
* @param int $id
* @return MediaSearch_Model_FileMeta
*/
public function setId($id) {
$this->id = (int) $id;
return $this;
}
/**
* Set interceptor to access model propertoes.
*
* @todo remove this methods we use explicit setters
*
* @access public
* @throws Exception On invalid name.
* @param string $name
* @param mixed $value
*/
public function __set($name, $value) {
$method = 'set' . $name;
if (('mapper' === $name) || !$this->hasMethod($method)) {
throw new Exception('Invalid filemeta property');
}
$this->$method($value);
}
/**
* Set interceptor to access model propertoes.
*
* @todo remove this methods we use explicit setters
*
* @access public
* @throws Exception On invalid name.
* @param string $name
* @param mixed $value
*/
public function __get($name) {
$method = 'get' . $name;
if (('mapper' === $name) || !$this->hasMethod($method)) {
throw new Exception('Invalid filemeta property');
}
return $this->$method();
}
/**
* Sets the object by an associative option array.
*
* @access public
* @param array $options
* @return self
*/
public function setOptions(array $options) {
foreach ($options as $key => $value) {
$method = 'set' . ucfirst($key);
if ($this->hasMethod($method)) {
$this->$method($value);
}
}
return $this;
}
/**
* Checks if a method exists. Thats used for the __set() and __get()
*
* I cache the results of reflection in a static array because its a
* expensive call.
*
* @access private
* @staticvar array $methods
* @param string $name
* @return bool
*/
private function hasMethod($name) {
static $methods = array();
$className = get_class($this);
if (!isset($methods[$className])) {
$methods[$className] = get_class_methods($this);
}
return in_array($name, $methods[$className]);
}
/**
* Returns the proper maper class name. Its naming schema
* is own class name appended with 'Mapper'.
*
* Example:
* model class -> MediaSearch_Model_Foo
* mapper class name -> MediaSearch_Model_FooMapper
*
* @return string
*/
private function getMapperClassName() {
return get_class($this) . 'Mapper';
}
/**
* Sets the database mappper obejct.
*
* @access public
* @param MediaSearch_Model_AbstractMapper $mapper
* @return MediaSearch_Model_Abstract
*/
public function setMapper(MediaSearch_Model_AbstractMapper $mapper) {
$className = $this->getMapperClassName();
if (!$mapper instanceof $className) {
$message = 'The given mapper object is of type ' . get_class($mapper);
$message .= ' But object of type ' . $className . ' is required!';
throw new Exception($message);
}
$this->mapper = $mapper;
return $this;
}
/**
* Returns the database mappper obejct.
*
* @access public
* @return MediaSearch_Model_AbstractMapper
*/
public function getMapper() {
if (null === $this->mapper) {
$className = $this->getMapperClassName();
$this->setMapper(new $className());
}
return $this->mapper;
}
/**
* Save the model object persistent.
*
* @access public
* @return MediaSearch_Model_Abstract
*/
public function save() {
$this->getMapper()->save($this);
return $this;
}
/**
* Finds a object by the id and loads itself.
*
* @access public
* @param int $id
* @return MediaSearch_Model_Abstract
*/
public function find($id) {
$this->getMapper()->find($id, $this);
return $this;
}
/**
* Fetches all objects and returns in an array.
* You can provide an optional limit and offset.
*
* @access public
* @param int $limit
* @param int $offset
* @return array
*/
public function fetchAll($limit = null, $offset = null) {
return $this->getMapper()->fetchAll($limit, $offset);
}
/**
* Counts how much objects are persistent available.
*
* @access public
* @return int
*/
public function count() {
return $this->getMapper()->count();
}
}

Source for file Abstract.php