Updates documentation of DatabaseObject and ProcessibleDatabaseObject
authorMatthias Schmidt <gravatronics@live.com>
Thu, 22 Sep 2011 10:54:46 +0000 (12:54 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Thu, 22 Sep 2011 10:54:46 +0000 (12:54 +0200)
wcfsetup/install/files/lib/data/DatabaseObject.class.php
wcfsetup/install/files/lib/data/ProcessibleDatabaseObject.class.php

index ddfa28255e830b3bdfbba694e59a3fd3a3a230e2..bac9d2843ed3895f1fc7fdee0b332a7878bdba51 100644 (file)
@@ -15,47 +15,46 @@ use wcf\system\WCF;
 abstract class DatabaseObject implements IStorableObject {
        /**
         * database table for this object
-        * @var string
+        * @var string
         */
        protected static $databaseTableName = '';
        
        /**
         * indicates if database table index is an identity column
-        * @var boolean 
+        * @var boolean 
         */     
        protected static $databaseTableIndexIsIdentity = true;
        
        /**
         * name of the primary index column
-        * @var string
+        * @var string
         */
        protected static $databaseTableIndexName = '';
        
        /**
         * sort field
-        * @var mixed
+        * @var mixed
         */
        protected static $sortBy = null;
        
        /**
         * sort order
-        * @var mixed
+        * @var mixed
         */
        protected static $sortOrder = null;
        
        /**
         * object data
-        * @var array
+        * @var array
         */
        protected $data = null;
        
        /**
         * Creates a new instance of the DatabaseObject class.
-        * Stores object data.
         *  
-        * @param       mixed                   $id
-        * @param       array                   $row
-        * @param       DatabaseObject          $object
+        * @param       mixed                           $id
+        * @param       array                           $row
+        * @param       wcf\data\DatabaseObject         $object
         */
        public function __construct($id, array $row = null, DatabaseObject $object = null) {
                if ($id !== null) {
@@ -91,7 +90,7 @@ abstract class DatabaseObject implements IStorableObject {
        }
 
        /**
-        * @see wcf\data\IStorableObject::__get()
+        * @see wcf\data\IStorableObject::__get()
         */
        public function __get($name) {
                if (isset($this->data[$name])) {
@@ -103,14 +102,14 @@ abstract class DatabaseObject implements IStorableObject {
        }
        
        /**
-        * @see wcf\data\IStorableObject::__isset()
+        * @see wcf\data\IStorableObject::__isset()
         */
        public function __isset($name) {
                return isset($this->data[$name]);
        }
        
        /**
-        * @see wcf\data\IStorableObject::getDatabaseTableName()
+        * @see wcf\data\IStorableObject::getDatabaseTableName()
         */
        public static function getDatabaseTableName() {
                return 'wcf'.WCF_N.'_'.static::$databaseTableName;
@@ -131,7 +130,7 @@ abstract class DatabaseObject implements IStorableObject {
        }
        
        /**
-        * @see wcf\data\IStorableObject::getDatabaseTableIndexName()
+        * @see wcf\data\IStorableObject::getDatabaseTableIndexName()
         */
        public static function getDatabaseTableIndexName() {
                return static::$databaseTableIndexName;
@@ -140,9 +139,9 @@ abstract class DatabaseObject implements IStorableObject {
        /**
         * Sorts a list of database objects.
         *
-        * @param       array<DatabaseObject>   $objects
-        * @param       mixed                   $sortBy
-        * @param       string                  $sortOrder
+        * @param       array<wcf\data\DatabaseObject>  $objects
+        * @param       mixed                           $sortBy
+        * @param       string                          $sortOrder
         * @return      boolean
         */
        public static function sort(&$objects, $sortBy, $sortOrder = 'ASC', $maintainIndexAssociation = true) {
@@ -160,8 +159,8 @@ abstract class DatabaseObject implements IStorableObject {
        /**
         * Compares to database objects.
         *
-        * @param       DatabaseObject          $objectA
-        * @param       DatabaseObject          $objectB
+        * @param       wcf\data\DatabaseObject         $objectA
+        * @param       wcf\data\DatabaseObject         $objectB
         * @return      float
         */
        protected static function compareObjects($objectA, $objectB) {
index 9f6ceb9556831acd2c0de7e90a62dea8c84b5d5c..823a0c337f7e94e66bdc8ec6421c1cadd532da98 100644 (file)
@@ -16,20 +16,20 @@ use wcf\util\ClassUtil;
 class ProcessibleDatabaseObject extends DatabaseObject {
        /**
         * name of the interface the processor of this database object should implement
-        * @var string
+        * @var string
         */
        protected static $processorInterface = '';
        
        /**
         * processor this database object
-        * @var wcf\data\IDatabaseObjectProcessor
+        * @var wcf\data\IDatabaseObjectProcessor
         */
        protected $processor = null;
        
        /**
         * Returns the processor this database object.
         * 
-        * @return wcf\data\IDatabaseObjectProcessor
+        * @return      wcf\data\IDatabaseObjectProcessor
         */
        public function getProcessor() {
                if ($this->processor === null) {