BurningFlipside / CommonCode

Email/class.Email.php

Doc Comments +3 added lines, -3 removed lines

@@ -72,7 +72,7 @@ 
     /**
      * Who is this email going to
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getToAddresses()
     {
@@ -82,7 +82,7 @@ 
     /**
      * Who is this email going to (CC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getCCAddresses()
     {
@@ -92,7 +92,7 @@ 
     /**
      * Who is this email going to (BCC)
      *
-     * @return array The recipients of the email
+     * @return string The recipients of the email
      */
     public function getBCCAddresses()
     {

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

Auth/class.SQLAuthenticator.php

Doc Comments +7 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()
     {
@@ -213,6 +213,9 @@ 
         return new SQLUser($users[0], $this);
     }
 
+    /**
+     * @param string $dataTableName
+     */
     private function getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby)
     {
         $dataTable = $this->getDataTable($dataTableName);
@@ -278,6 +281,9 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();

Data/class.SQLDataSet.php

Doc Comments +12 added lines

@@ -113,6 +113,9 @@ 
         throw new \Exception('No such table '.$name);
     }
 
+    /**
+     * @param string $tablename
+     */
     function read($tablename, $where = false, $select = '*', $count = false, $skip = false, $sort = false)
     {
         if($select === false)
@@ -158,6 +161,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $tablename
+     */
     function update($tablename, $where, $data)
     {
         $set = array();
@@ -180,6 +186,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function create($tablename, $data)
     {
         $set = array();
@@ -203,6 +212,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $tablename
+     */
     function delete($tablename, $where)
     {
         $sql = "DELETE FROM $tablename WHERE $where";

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

Data/class.FilterClause.php

Doc Comments +6 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)

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

Auth/class.LDAPAuthenticator.php

Doc Comments +2 added lines, -2 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
      *
@@ -309,7 +309,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

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
      */