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

index f09e4f222ad069ab6f4d682aa100b3090fe07991..c8d649c8abc6d3f3c4c80d3ebcbd698479d268df 100644 (file)
@@ -20,63 +20,54 @@ use wcf\util\StringUtil;
 abstract class AbstractDatabaseObjectAction implements IDatabaseObjectAction {
        /**
         * pending action
-        *
         * @var string
         */
        protected $action = '';
        
        /**
         * object editor class name
-        *
         * @var string
         */
        protected $className = '';
        
        /**
         * list of object ids
-        *
         * @var array<integer>
         */
        protected $objectIDs = array();
        
        /**
-        * list of objects
-        *
+        * list of object editors
         * @var array<DatabaseObjectEditor>
         */
        protected $objects = array();
        
        /**
         * multi-dimensional array of parameters required by an action
-        *
         * @var array<array>
         */
        protected $parameters = array();
        
        /**
         * list of permissions required to create objects
-        *
-        * @var array
+        * @var array<string>
         */
        protected $permissionsCreate = array();
        
        /**
         * list of permissions required to delete objects
-        *
-        * @var array
+        * @var array<string>
         */
        protected $permissionsDelete = array();
        
        /**
         * list of permissions required to update objects
-        *
-        * @var array
+        * @var array<string>
         */
        protected $permissionsUpdate = array();
        
        /**
         * values returned by executed action
-        *
         * @var mixed
         */
        protected $returnValues = null;
@@ -235,18 +226,16 @@ abstract class AbstractDatabaseObjectAction implements IDatabaseObjectAction {
        }
        
        /**
-        * Creates a new data.
+        * Creates new database object.
         *
         * @return      DatabaseObject
         */
        public function create() {
-               // create data
                return call_user_func(array($this->className, 'create'), $this->parameters['data']);
        }
        
        /**
-        * Deletes data.
-        * Returns the number of deleted data.
+        * Deletes database object and returns the number of deleted objects.
         *
         * @return      integer
         */