Updates the documentation of wcf\data\DatabaseObjectDecorator
authorMatthias Schmidt <gravatronics@live.com>
Wed, 7 Sep 2011 08:18:52 +0000 (10:18 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Wed, 7 Sep 2011 08:18:52 +0000 (10:18 +0200)
wcfsetup/install/files/lib/data/DatabaseObjectDecorator.class.php

index a57874050cb87040552c5ec6db2773845a31031e..01d4a7e1315e2717d1af7ba02db03f9795cdb296 100644 (file)
@@ -16,20 +16,20 @@ use wcf\system\WCF;
 abstract class DatabaseObjectDecorator extends DatabaseObject {
        /**
         * name of the base class
-        * @var string
+        * @var string
         */
        protected static $baseClass = '';
        
        /**
-        * the object being decorated
-        * @var DatabaseObject
+        * decorated object
+        * @var wcf\data\DatabaseObject
         */
        protected $object = null;
        
        /**
         * Creates a new DatabaseObjectDecorator object.
         * 
-        * @param       DatabaseObject          $object
+        * @param       wcf\data\DatabaseObject         $object
         */
        public function __construct(DatabaseObject $object) {
                if (empty(static::$baseClass)) {
@@ -44,14 +44,14 @@ abstract class DatabaseObjectDecorator extends DatabaseObject {
        }
        
        /**
-        * @see wcf\data\DatabaseObject::__get()
+        * @see wcf\data\DatabaseObject::__get()
         */
        public function __get($name) {
                return $this->object->__get($name);
        }
        
        /**
-        * @see wcf\data\DatabaseObject::__isset()
+        * @see wcf\data\DatabaseObject::__isset()
         */
        public function __isset($name) {
                return $this->object->__isset($name);
@@ -73,7 +73,7 @@ abstract class DatabaseObjectDecorator extends DatabaseObject {
        }
        
        /**
-        * @see wcf\data\IStorableObject::getDatabaseTableName()
+        * @see wcf\data\IStorableObject::getDatabaseTableName()
         */
        public static function getDatabaseTableName() {
                return call_user_func(array(static::$baseClass, 'getDatabaseTableName'));
@@ -87,7 +87,7 @@ abstract class DatabaseObjectDecorator extends DatabaseObject {
        }
        
        /**
-        * @see wcf\data\IStorableObject::getDatabaseTableIndexName()
+        * @see wcf\data\IStorableObject::getDatabaseTableIndexName()
         */
        public static function getDatabaseTableIndexName() {
                return call_user_func(array(static::$baseClass, 'getDatabaseTableIndexName'));
@@ -96,7 +96,7 @@ abstract class DatabaseObjectDecorator extends DatabaseObject {
        /**
         * Returns the name of the base class.
         * 
-        * @return string
+        * @return      string
         */
        public static function getBaseClass() {
                return static::$baseClass;
@@ -105,7 +105,7 @@ abstract class DatabaseObjectDecorator extends DatabaseObject {
        /**
         * Returns the decorated object
         * 
-        * @return wcf\data\DatabaseObject
+        * @return      wcf\data\DatabaseObject
         */
        public function getDecoratedObject() {
                return $this->object;