DomCI : Update all the PHPDoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3279 bf3deb0d-5f1a-0410-827f-c0cc1f45334c

dblayerauthzgroups.php

@@ -31,19 +31,20 @@ class dblayerauthzgroups extends dblayer
   ///   MAIN METHODS   ///
   ////////////////////////
   /** Hook preread
-      This hook is run before selecting the data in the database, after the
-      verification
-      @param array|null &$select Rows to select with
-         $select = array (array ($key, $val, $operator), ...)
-         $key=>column, $val=>value to found, $operator=>'LIKE', =...
-      @param array|null &$display Columns displayed
-         $display = array ($col1, $col2...);
-      @param array|null &$order Sort the columns by orientation
-         $order = array (array ($key, $orientation), ...)
-         $key=>column, $orientation=ASC/DESC
-      @param boolean|null &$whereOr The WHERE parameters are separated by OR
-                                 instead of AND
-      @param array|null &$foreignSelect Add a filter on foreign keys */
+    * This hook is run before selecting the data in the database, after the
+    * verification
+    * @param array|null &$select Rows to select with
+    *    $select = array (array ($key, $val, $operator), ...)
+    *    $key=>column, $val=>value to found, $operator=>'LIKE', =...
+    * @param array|null &$display Columns displayed
+    *    $display = array ($col1, $col2...);
+    * @param array|null &$order Sort the columns by orientation
+    *    $order = array (array ($key, $orientation), ...)
+    *    $key=>column, $orientation=ASC/DESC
+    * @param boolean|null &$whereOr The WHERE parameters are separated by OR
+    *                            instead of AND
+    * @param array|null &$foreignSelect Add a filter on foreign keys
+    */
   public function hookpreread (&$select, &$display, &$order, &$whereOr,
                                &$foreignSelect)
   {
@@ -67,10 +68,11 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook postread
-      This hook is run after selecting the data. Return only the allowed data to
-      the user. It must have at least the RO flag.
-      @param array $data the data selected by the select
-      @return array The data modified by the hook */
+    * This hook is run after selecting the data. Return only the allowed data to
+    * the user. It must have at least the RO flag.
+    * @param array $data the data selected by the select
+    * @return array The data modified by the hook
+    */
   public function hookpostread ($data)
   {
     // TODO : If foreign keys, do we check if the access is allowed too ?
@@ -103,10 +105,11 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook preinsert
-      This hook is run before inserting a new data in the database, after the
-      verification
-      @param array the data to insert in the database
-      @return the modified data */
+    * This hook is run before inserting a new data in the database, after the
+    * verification
+    * @param array $data the data to insert in the database
+    * @return the modified data
+    */
   public function hookpreinsert ($data)
   {
     if ($this->module === null)
@@ -128,8 +131,11 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook postinsert
-      This hook is run after successfuly insert a new data in the database
-      @return the modified lastID */
+    * This hook is run after successfuly insert a new data in the database
+    * @param array $data The data stored in the database
+    * @param integer $lastID The lastID stored
+    * @return the modified lastID
+    */
   public function hookpostinsert ($data, $lastID)
   {
     if ($this->module === null)
@@ -169,9 +175,12 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook preupdate
-      This hook is run before updating a data in the database, after the
-      verification
-      @return the modified data */
+    * This hook is run before updating a data in the database, after the
+    * verification
+    * @param integer $updatekey The key which will be updated
+    * @param array $data The data to store in the provided key
+    * @return the modified data
+    */
   public function hookpreupdate ($updatekey, $data)
   {
     if ($this->module === null)
@@ -192,8 +201,10 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook predelete
-      This hook is run before deleting a data in the database
-      @return the modified $deletekey */
+    * This hook is run before deleting a data in the database
+    * @param string $deletekey The key to delete
+    * @return the modified $deletekey
+    */
   public function hookpredelete ($deletekey)
   {
     if ($this->module === null)
@@ -214,8 +225,11 @@ class dblayerauthzgroups extends dblayer
   }
 
   /** Hook postdelete
-      This hook is run after successfuly deleting a data in the database
-      @return $nbLinesUpdated */
+    * This hook is run after successfuly deleting a data in the database
+    * @param string $deletekey The key to delete
+    * @param integer $nbLinesDeleted The number of deleted lines
+    * @return $nbLinesUpdated
+    */
   public function hookpostdelete ($deletekey, $nbLinesDeleted)
   {
     if ($this->module === null)
@@ -232,7 +246,8 @@ class dblayerauthzgroups extends dblayer
     return $nbLinesDeleted;
   }
 
-  /** Return true if all the paths are allowed. Throw an exception elsewhere */
+  /** Return true if all the paths are allowed. Throw an exception elsewhere
+    */
   private function allowPath ()
   {
     if ($this->module === null)
@@ -261,49 +276,63 @@ class dblayerauthzgroups extends dblayer
   ///////////////////
   ///   SETTERS   ///
   ///////////////////
-  /** Set the authzgroups property */
+  /** Set the authzgroups property
+    * @param object $authzgroups The object of the authzgroups
+    */
   public function authzgroupsSet ($authzgroups)
   {
     $this->authzgroups = $authzgroups;
     return $this;
   }
 
-  /** Set the module property */
+  /** Set the module property
+    * @param string $module The module name to use
+    */
   public function moduleSet ($module)
   {
     $this->module = $module;
     return $this;
   }
 
-  /** Set the auth property */
+  /** Set the auth property
+    * @param array $auth The auth array
+    */
   public function authSet ($auth)
   {
     $this->auth = $auth;
     return $this;
   }
 
-  /** Set the user property */
+  /** Set the user property
+    * @param string $user The user to authorize
+    */
   public function userSet ($user)
   {
     $this->user = $user;
     return $this;
   }
 
-  /** Set the createGroup property */
+  /** Set the createGroup property
+    * @param array|string $createGroup The createGroup to set
+    */
   public function createGroupSet ($createGroup)
   {
     $this->createGroup = $createGroup;
     return $this;
   }
 
-  /** Set the createRight property */
+  /** Set the createRight property
+    * @param string $createRight The right to create
+    */
   public function createRightSet ($createRight)
   {
     $this->createRight = $createRight;
     return $this;
   }
 
-  /** Set the path property */
+  /** Set the path property
+    * @param string $path The pre-path to use
+    */
   public function pathSet ($path)
   {
     $this->path = $path;