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

Auth/class.User.php

Doc Comments +21 added lines, -21 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * The name the user should be displayed as
      *
-     * @return boolean|string The name the user should be displayed as
+     * @return boolean The name the user should be displayed as
      */
     public function getDisplayName()
     {
@@ -51,7 +51,7 @@ 
     /**
      * The given (or first) name for the user
      *
-     * @return boolean|string The user's first name
+     * @return boolean The user's first name
      */
     public function getGivenName()
     {
@@ -61,7 +61,7 @@ 
     /**
      * The email address for the user
      *
-     * @return boolean|string The user's email address
+     * @return boolean The user's email address
      */
     public function getEmail()
     {
@@ -71,7 +71,7 @@ 
     /**
      * The user ID for the user
      *
-     * @return boolean|string The user's ID or username
+     * @return boolean The user's ID or username
      */
     public function getUid()
     {
@@ -81,7 +81,7 @@ 
     /**
      * The photo for the user
      *
-     * @return boolean|string The user's photo as a binary string
+     * @return boolean The user's photo as a binary string
      */ 
     public function getPhoto()
     {
@@ -91,7 +91,7 @@ 
     /**
      * The phone number for the user
      *
-     * @return boolean|string The user's phone number
+     * @return boolean The user's phone number
      */
     public function getPhoneNumber()
     {
@@ -101,7 +101,7 @@ 
     /**
      * The organziation for the user
      *
-     * @return boolean|string The user's organization
+     * @return boolean The user's organization
      */
     public function getOrganization()
     {
@@ -111,7 +111,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return boolean|array The user's title(s) in short format
+     * @return boolean The user's title(s) in short format
      */
     public function getTitles()
     {
@@ -121,7 +121,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return boolean|array The user's title(s) in user friendly strings
+     * @return boolean The user's title(s) in user friendly strings
      *
      * @SuppressWarnings("StaticAccess")
      */
@@ -159,7 +159,7 @@ 
     /**
      * The state the user's mailing address is in
      *
-     * @return boolean|string The user's state from their mailing address
+     * @return boolean The user's state from their mailing address
      */
     public function getState()
     {
@@ -169,7 +169,7 @@ 
     /**
      * The city the user's mailing address is in
      *
-     * @return boolean|string The user's city from their mailing address
+     * @return boolean The user's city from their mailing address
      */
     public function getCity()
     {
@@ -179,7 +179,7 @@ 
     /**
      * The last name for the user
      *
-     * @return boolean|string The user's last name
+     * @return boolean The user's last name
      */
     public function getLastName()
     {
@@ -189,7 +189,7 @@ 
     /**
      * The nick name for the user
      *
-     * @return boolean|string The user's nick name
+     * @return boolean The user's nick name
      */
     public function getNickName()
     {
@@ -199,7 +199,7 @@ 
     /**
      * The street address for the user
      *
-     * @return boolean|string The user's street address
+     * @return boolean The user's street address
      */
     public function getAddress()
     {
@@ -209,7 +209,7 @@ 
     /**
      * The postal (zip) code for the user's mailing address
      *
-     * @return boolean|string The user's postal code
+     * @return boolean The user's postal code
      */
     public function getPostalCode()
     {
@@ -219,7 +219,7 @@ 
     /**
      * The country the user's mailing address is in
      *
-     * @return boolean|string The user's country from their mailing address
+     * @return boolean The user's country from their mailing address
      */
     public function getCountry()
     {
@@ -231,7 +231,7 @@ 
      *
      * This is the same as Areas in Flipside speak. 
      *
-     * @return boolean|array The user's orgnaiational units
+     * @return boolean The user's orgnaiational units
      */
     public function getOrganizationUnits()
     {
@@ -241,7 +241,7 @@ 
     /**
      * The supplemental login types that the user can use to login
      *
-     * @return boolean|array The user's login providers
+     * @return boolean The user's login providers
      */
     public function getLoginProviders()
     {
@@ -251,7 +251,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()
     {
@@ -727,7 +727,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)
     {
@@ -754,7 +754,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()
     {

LDAP/class.LDAPServer.php

Doc Comments +1 added lines, -1 removed lines

@@ -210,7 +210,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
      */

Auth/class.LDAPAuthenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,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.LDAPCachableObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,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)
     {

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