BurningFlipside / CommonCode

Auth/class.PendingUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
      * We need the ability to obtain the user's unhashed plain text password to allow for it to be sent 
      * to the correct backend which will hash it
      *
-     * @return boolean|string The current password
+     * @return boolean The current password
      */
     public function getPassword()
     {

class.AuthProvider.php

Doc Comments +4 added lines, -4 removed lines

@@ -253,10 +253,10 @@
      * Get an array of Auth\PendingUser from a filtered set
      *
      * @param Data\Filter|boolean $filter The filter conditions or false to retreive all
-     * @param array|boolean $select The user fields to obtain or false to obtain all
-     * @param integer|boolean $top The number of users to obtain or false to obtain all
-     * @param integer|boolean $skip The number of users to skip or false to skip none
-     * @param array|boolean $orderby The field to sort by and the method to sort or false to not sort
+     * @param boolean $select The user fields to obtain or false to obtain all
+     * @param boolean $top The number of users to obtain or false to obtain all
+     * @param boolean $skip The number of users to skip or false to skip none
+     * @param boolean $orderby The field to sort by and the method to sort or false to not sort
      * @param string|boolean $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
      *
      * @return array|boolean An array of Auth\PendingUser objects or false if no pending users were found

Auth/class.LDAPCachableObject.php

Doc Comments +4 added lines, -1 removed lines

@@ -22,6 +22,9 @@ 
         $this->ldapObj = $this->initializeFromArray($data);
     }
 
+    /**
+     * @param string $dn
+     */
     private function initializeFromDN($dn)
     {
         $filter = new \Data\Filter("dn eq $dn");
@@ -93,7 +96,7 @@ 
      *
      * @param string $fieldName The name of the field to retrieve
      *
-     * @return mixed string the value of the field
+     * @return string string the value of the field
      */
     protected function getFieldSingleValue($fieldName)
     {

LDAP/class.LDAPServer.php

Doc Comments +1 added lines, -2 removed lines

@@ -6,7 +6,6 @@ 
  * @author Chris Wright
  * @version 2.0
  * @param string $subject The subject string
- * @param bool $dn Treat subject as a DN if TRUE
  * @param string|array $ignore Set of characters to leave untouched
  * @return string The escaped string
  */
@@ -216,7 +215,7 @@ 
     /**
      * Get the LDAP filter represented by the passed object
      *
-     * @param boolean|string|\Data\Filter $filter The fiter to use
+     * @param boolean $filter The fiter to use
      *
      * @return string The filter in LDAP format
      */

Data/class.FilterClause.php

Doc Comments +9 added lines

@@ -28,12 +28,18 @@ 
         return substr($haystack, 0, strlen($needle)) === $needle;
     }
 
+    /**
+     * @param string $string
+     */
     protected function filterIsFunction($string)
     {
         return (self::str_startswith($string, 'substringof') || self::str_startswith($string, 'contains') ||
                 self::str_startswith($string, 'indexof'));
     }
 
+    /**
+     * @param string $op
+     */
     protected function odataOpToStd($op)
     {
         switch($op)
@@ -146,6 +152,9 @@ 
         }
     }
 
+    /**
+     * @param string $op
+     */
     private function getMongoClauseArray($op, $var2)
     {
         return array($this->opToMongo($op)=>$var2);

Data/class.SQLDataSet.php

Doc Comments +13 added lines

@@ -132,6 +132,10 @@ 
         return $sql;
     }
 
+    /**
+     * @param false|string $count
+     * @param false|string $skip
+     */
     private function getLimitClause($count, $skip)
     {
         if($count === false)
@@ -193,6 +197,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $tablename
+     */
     function update($tablename, $where, $data)
     {
         $set = array();
@@ -215,6 +222,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function create($tablename, $data)
     {
         $set = array();
@@ -238,6 +248,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function delete($tablename, $where)
     {
         $sql = "DELETE FROM $tablename WHERE $where";

Auth/class.LDAPAuthenticator.php

Doc Comments +3 added lines, -3 removed lines

@@ -140,7 +140,7 @@ 
     /**
      * Return an instance to the \LDAP\LDAPServer object instance
      *
-     * @param boolean $bind_write Should we be able to write to the server?
+     * @param boolean $bindWrite Should we be able to write to the server?
      *
      * @return \LDAP\LDAPServer|false The server instance if the binding was successful, otherwise false
      *
@@ -219,7 +219,7 @@ 
      *
      * @param \stdClass	$data The AuthData from the session
      *
-     * @return null|\Auth\LDAPUser The LDAPUser represented by this data
+     * @return LDAPUser The LDAPUser represented by this data
      */
     public function getUser($data)
     {
@@ -316,7 +316,7 @@ 
 
     
     /**
-     * @param boolean|\Data\Filter $filter The filter to user when reading users
+     * @param \Data\Filter $filter The filter to user when reading users
      * @param boolean|array   $select The fields to return
      * @param boolean|integer $top The number of records to return
      * @param boolean|integer $skip The number of records to skip

Auth/class.SQLAuthenticator.php

Doc Comments +11 added lines, -1 removed lines

@@ -140,7 +140,7 @@ 
     /**
      * Get the data table for Pending Users
      *
-     * @return boolean|\Data\DataTable The Pending User Data Table
+     * @return boolean The Pending User Data Table
      */
     private function getPendingUserDataTable()
     {
@@ -189,6 +189,10 @@ 
         return new SQLUser($data, $this);
     }
 
+    /**
+     * @param string $tableName
+     * @param string $className
+     */
     private function getEntityByFilter($tableName, $filterStr, $className)
     {
         $dataTable = $this->getDataTable($tableName);
@@ -211,6 +215,9 @@ 
         return $this->getEntityByFilter('user', "uid eq '$name'", 'SQLUser');
     }
 
+    /**
+     * @param string $dataTableName
+     */
     private function getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby)
     {
         $dataTable = $this->getDataTable($dataTableName);
@@ -276,6 +283,9 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();

class.Provider.php

Doc Comments +5 added lines, -1 removed lines

@@ -59,7 +59,7 @@ 
      * @param string $functionName The function to call
      * @param array $args The arguments for the function
      * @param string $checkField A field to check if it is set a certain way before calling the function
-     * @param mixed $checkValue The value that field should be set to to not call the function
+     * @param boolean $checkValue The value that field should be set to to not call the function
      * @param callable $resFunction Function to call on the result, otherwise the function will return on the first non-false result
      *
      * @return Auth\Group|Auth\User|false The merged returnValue
@@ -91,6 +91,10 @@ 
         return $ret;
     }
 
+    /**
+     * @param string|boolean $methodName
+     * @param string $functionName
+     */
     protected function callFunction($methodName, $functionName, $args, $checkField = false, $checkValue = false, $resFunction = null)
     {
         if($methodName === false)