Updates class documentation of ProcessibleDatabaseObject

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / ProcessibleDatabaseObject.class.php

<?php
namespace wcf\data;
use wcf\system\exception\SystemException;
use wcf\util\ClassUtil;

/**
 * Abstract class for all processible DatabaseObject classes.
 *
 * @author	Marcel Werk
 * @copyright	2001-2011 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	com.woltlab.wcf
 * @subpackage	data
 * @category 	Community Framework
 */
class ProcessibleDatabaseObject extends DatabaseObject {
	/**
	 * name of the interface the processor of this database object should implement
	 * @var string
	 */
	protected static $processorInterface = '';
	
	/**
	 * processor this database object
	 * @var wcf\data\IDatabaseObjectProcessor
	 */
	protected $processor = null;
	
	/**
	 * Returns the processor this database object.
	 * 
	 * @return wcf\data\IDatabaseObjectProcessor
	 */
	public function getProcessor() {
		if ($this->processor === null) {
			if ($this->className) {
				if (!class_exists($this->className)) {
					throw new SystemException("Unable to find class '".$this->className."'");
				}
				if (!ClassUtil::isInstanceOf($this->className, 'wcf\data\IDatabaseObjectProcessor')) {
					throw new SystemException("'".$this->className."' should implement wcf\data\IDatabaseObjectProcessor");
				}
				if (!ClassUtil::isInstanceOf($this->className, static::$processorInterface)) {
					throw new SystemException("'".$this->className."' should implement ".$this->processorInterface);
				}
				
				$this->processor = new $this->className($this);
			}
		}
		
		return $this->processor;
	}
}