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.User.php

Doc Comments +3 added lines, -3 removed lines

@@ -93,7 +93,7 @@ 
     /**
      * The groups the user is a part of
      *
-     * @return boolean|array The user's Auth\Group structures
+     * @return boolean The user's Auth\Group structures
      */
     public function getGroups()
     {
@@ -576,7 +576,7 @@ 
      *
      * @param stdClass $data The user's new data
      *
-     * @return boolean true if the user's data was changed, false otherwise
+     * @return boolean|null true if the user's data was changed, false otherwise
      */
     public function editUser($data)
     {
@@ -603,7 +603,7 @@ 
     /**
      * Obtain the user's password reset hash
      *
-     * @return string|false A hash if available, false otherwise
+     * @return boolean A hash if available, false otherwise
      */
     public function getPasswordResetHash()
     {

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)
     {

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);

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();

LDAP/class.LDAPServer.php

Doc Comments -1 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
  */

Data/class.SQLDataSet.php

Doc Comments +14 added lines, -1 removed lines

@@ -116,6 +116,10 @@ 
         return $sql;
     }
 
+    /**
+     * @param boolean|string $count
+     * @param boolean|string $skip
+     */
     private function getLimitClause($count, $skip)
     {
         if($count === false)
@@ -139,7 +143,7 @@ 
      * @param string $select The colums to read
      * @param boolean|string $count The number of rows to read
      * @param boolean|string $skip The number of rows to skip over
-     * @param boolean|array $sort The array to sort by or false to not sort
+     * @param boolean $sort The array to sort by or false to not sort
      *
      * @return false|array An array of all the returned records
      */
@@ -177,6 +181,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $tablename
+     */
     function update($tablename, $where, $data)
     {
         $set = array();
@@ -199,6 +206,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function create($tablename, $data)
     {
         $set = array();
@@ -222,6 +232,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function delete($tablename, $where)
     {
         $sql = "DELETE FROM $tablename WHERE $where";

Auth/class.Group.php

Doc Comments +3 added lines, -3 removed lines

@@ -6,7 +6,7 @@ 
     /**
      * Get the Group's Name
      *
-     * @return boolean|string The name of the group or false on error
+     * @return boolean The name of the group or false on error
      */
     public function getGroupName()
     {
@@ -16,7 +16,7 @@ 
     /**
      * Get the Group's Description
      *
-     * @return boolean|string The description of the group or false on error
+     * @return boolean The description of the group or false on error
      */
     public function getDescription()
     {
@@ -154,7 +154,7 @@ 
      * @param string $name The name of the group to get
      * @param mixed $data The data used to help get the Group
      *
-     * @return boolean|\Auth\Group The group with the specified name or false otherwise
+     * @return boolean The group with the specified name or false otherwise
      */
     public static function from_name($name, $data = false)
     {