From: Matthias Schmidt <gravatronics@live.com>
Date: Wed, 7 Sep 2011 08:30:50 +0000 (+0200)
Subject: Adds documentation for wcf\data\IDatabaseObjectProcessor
X-Git-Tag: 2.0.0_Beta_1~1791^2~2^2~4
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=19d026b2ddc2092cb88a6e3399d42b0ffc41bb47;p=GitHub%2FWoltLab%2FWCF.git

Adds documentation for wcf\data\IDatabaseObjectProcessor
---

diff --git a/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php b/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
index a08d833e95..f3a04bd799 100644
--- a/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
+++ b/wcfsetup/install/files/lib/data/IDatabaseObjectProcessor.class.php
@@ -1,9 +1,48 @@
 <?php
 namespace wcf\data;
 
+/**
+ * Default interface for DatabaseObject processors.
+ *
+ * @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
+ */
 interface IDatabaseObjectProcessor {
+	/**
+	 * Creates a new instance of a database object processor.
+	 * 
+	 * @param	wcf\data\DatabaseObject		$object
+	 */
 	public function __construct(DatabaseObject $object);
+	
+	/**
+	 * Delegates property accesses to the processed object if the processor
+	 * object has no such property.
+	 *   
+	 * @param	string		$name
+	 * @return	mixed
+	 */
 	public function __get($name);
+	
+	/**
+	 * Delegates isset calls for object properties to the processed object if
+	 * the processor object has no such property.
+	 * 
+	 * @param	string		$name
+	 * @return	boolean
+	 */
 	public function __isset($name);
+	
+	/**
+	 * Delegates inaccessible methods calls to the processed database object.
+	 *  
+	 * @param	string		$name
+	 * @param	array		$arguments
+	 * @return	mixed
+	 */
 	public function __call($name, $arguments);
 }