BurningFlipside / CommonCode

Data/class.SQLDataSet.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _get_row_count_for_query($sql)
     {
         $stmt = $this->pdo->query($sql);

Data/class.SQLDataTable.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
     protected $dataset;
     protected $tablename;
 
+    /**
+     * @param SQLDataSet $dataset
+     */
     function __construct($dataset, $tablename)
     {
         $this->dataset   = $dataset;

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

LDAP/class.LDAPServer.php

Doc Comments +6 added lines

@@ -117,6 +117,9 @@ 
         $this->connect = false;
     }
 
+    /**
+     * @param string $password
+     */
     function bind($cn=null, $password=null)
     {
         $res = false;
@@ -199,6 +202,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param boolean $filter
+     */
     private function filterToString($filter)
     {
         if($filter === false)

Auth/class.LDAPUser.php

Doc Comments +3 added lines

@@ -50,6 +50,9 @@
         return $res;
     }
 
+    /**
+     * @param string $listName
+     */
     private function isInListOrChild($listName, $group, $dn)
     {
         if(!isset($group[$listName]))

Auth/class.User.php

Doc Comments +43 added lines, -43 removed lines

@@ -31,7 +31,7 @@ 
      *
      * @param string $name The name of the group to check if the user is in
      *
-     * @return true|false True if the user is in the group, false otherwise
+     * @return boolean True if the user is in the group, false otherwise
      */
     function isInGroupNamed($name)
     {
@@ -41,7 +41,7 @@ 
     /**
      * The name the user should be displayed as
      *
-     * @return string The name the user should be displayed as
+     * @return boolean The name the user should be displayed as
      */
     function getDisplayName()
     {
@@ -51,7 +51,7 @@ 
     /**
      * The given (or first) name for the user
      *
-     * @return string The user's first name
+     * @return boolean The user's first name
      */
     function getGivenName()
     {
@@ -61,7 +61,7 @@ 
     /**
      * The email address for the user
      *
-     * @return string The user's email address
+     * @return boolean The user's email address
      */
     function getEmail()
     {
@@ -71,7 +71,7 @@ 
     /**
      * The user ID for the user
      *
-     * @return string The user's ID or username
+     * @return boolean The user's ID or username
      */
     function getUid()
     {
@@ -81,7 +81,7 @@ 
     /**
      * The photo for the user
      *
-     * @return string The user's photo as a binary string
+     * @return boolean The user's photo as a binary string
      */ 
     function getPhoto()
     {
@@ -91,7 +91,7 @@ 
     /**
      * The phone number for the user
      *
-     * @return false|string The user's phone number
+     * @return boolean The user's phone number
      */
     function getPhoneNumber()
     {
@@ -101,7 +101,7 @@ 
     /**
      * The organziation for the user
      *
-     * @return false|string The user's organization
+     * @return boolean The user's organization
      */
     function getOrganization()
     {
@@ -111,7 +111,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return array The user's title(s) in short format
+     * @return boolean The user's title(s) in short format
      */
     function getTitles()
     {
@@ -121,7 +121,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return 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 string The user's state from their mailing address
+     * @return boolean The user's state from their mailing address
      */
     function getState()
     {
@@ -169,7 +169,7 @@ 
     /**
      * The city the user's mailing address is in
      *
-     * @return string The user's city from their mailing address
+     * @return boolean The user's city from their mailing address
      */
     function getCity()
     {
@@ -179,7 +179,7 @@ 
     /**
      * The last name for the user
      *
-     * @return string The user's last name
+     * @return boolean The user's last name
      */
     function getLastName()
     {
@@ -189,7 +189,7 @@ 
     /**
      * The nick name for the user
      *
-     * @return string The user's nick name
+     * @return boolean The user's nick name
      */
     function getNickName()
     {
@@ -199,7 +199,7 @@ 
     /**
      * The street address for the user
      *
-     * @return string The user's street address
+     * @return boolean The user's street address
      */
     function getAddress()
     {
@@ -209,7 +209,7 @@ 
     /**
      * The postal (zip) code for the user's mailing address
      *
-     * @return string The user's postal code
+     * @return boolean The user's postal code
      */
     function getPostalCode()
     {
@@ -219,7 +219,7 @@ 
     /**
      * The country the user's mailing address is in
      *
-     * @return string The user's country from their mailing address
+     * @return boolean The user's country from their mailing address
      */
     function getCountry()
     {
@@ -231,7 +231,7 @@ 
      *
      * This is the same as Areas in Flipside speak. 
      *
-     * @return array The user's orgnaiational units
+     * @return boolean The user's orgnaiational units
      */
     function getOrganizationUnits()
     {
@@ -241,7 +241,7 @@ 
     /**
      * The supplemental login types that the user can use to login
      *
-     * @return array The user's login providers
+     * @return boolean The user's login providers
      */
     function getLoginProviders()
     {
@@ -251,7 +251,7 @@ 
     /**
      * The groups the user is a part of
      *
-     * @return false|array The user's Auth\Group structures
+     * @return boolean The user's Auth\Group structures
      */
     function getGroups()
     {
@@ -275,7 +275,7 @@ 
      *
      * @param string $provider The hostname for the provider
      *
-     * @return true|false true if they can login with the provider, false otherwise
+     * @return boolean true if they can login with the provider, false otherwise
      */
     function canLoginWith($provider)
     {
@@ -294,7 +294,7 @@ 
      *
      * @param string $password The new user password
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     protected function setPass($password)
     {
@@ -304,7 +304,7 @@ 
     /**
      * Has the user completely filled out their user profile?
      *
-     * @return true|false true if the user's profile is complete, false otherwise
+     * @return boolean true if the user's profile is complete, false otherwise
      */
     function isProfileComplete()
     {
@@ -322,7 +322,7 @@ 
      *
      * @param string $password The user's current password
      *
-     * @return true|false true if the user's password is correct, false otherwise
+     * @return boolean true if the user's password is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -336,7 +336,7 @@ 
      *
      * @param string $hash The user's reset hash
      *
-     * @return true|false true if the user's hash is correct, false otherwise
+     * @return boolean true if the user's hash is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -352,7 +352,7 @@ 
      * @param string $newpass The user's new password
      * @param boolean $isHash Is $old_pass a password or a hash
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     function change_pass($oldpass, $newpass, $isHash=false)
     {
@@ -376,7 +376,7 @@ 
      *
      * @param string $name The user's new display name
      *
-     * @return true|false true if the user's display name was changed, false otherwise
+     * @return boolean true if the user's display name was changed, false otherwise
      */
     function setDisplayName($name)
     {
@@ -388,7 +388,7 @@ 
      *
      * @param string $name The user's new given name
      *
-     * @return true|false true if the user's given name was changed, false otherwise
+     * @return boolean true if the user's given name was changed, false otherwise
      */
     function setGivenName($name)
     {
@@ -400,7 +400,7 @@ 
      *
      * @param string $email The user's new email address
      *
-     * @return true|false true if the user's email address was changed, false otherwise
+     * @return boolean true if the user's email address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -414,7 +414,7 @@ 
      *
      * @param string $uid The user's new user ID
      *
-     * @return true|false true if the user's ID was changed, false otherwise
+     * @return boolean true if the user's ID was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -428,7 +428,7 @@ 
      *
      * @param string $photo The user's new photo as a binary string
      *
-     * @return true|false true if the user's photo was changed, false otherwise
+     * @return boolean true if the user's photo was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -442,7 +442,7 @@ 
      *
      * @param string $phone The user's new phonew number
      *
-     * @return true|false true if the user's phone number was changed, false otherwise
+     * @return boolean true if the user's phone number was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -456,7 +456,7 @@ 
      *
      * @param string $org The user's new organization
      *
-     * @return true|false true if the user's organization was changed, false otherwise
+     * @return boolean true if the user's organization was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -470,7 +470,7 @@ 
      *
      * @param string $titles The user's new titles
      *
-     * @return true|false true if the user's titles were changed, false otherwise
+     * @return boolean true if the user's titles were changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -484,7 +484,7 @@ 
      *
      * @param string $state The user's new state
      *
-     * @return true|false true if the user's state was changed, false otherwise
+     * @return boolean true if the user's state was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -498,7 +498,7 @@ 
      *
      * @param string $city The user's new city
      *
-     * @return true|false true if the user's city was changed, false otherwise
+     * @return boolean true if the user's city was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -512,7 +512,7 @@ 
      *
      * @param string $sn The user's new last name
      *
-     * @return true|false true if the user's last name was changed, false otherwise
+     * @return boolean true if the user's last name was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -526,7 +526,7 @@ 
      *
      * @param string $displayName The user's new nick name
      *
-     * @return true|false true if the user's nick name was changed, false otherwise
+     * @return boolean true if the user's nick name was changed, false otherwise
      */
     function setNickName($displayName)
     {
@@ -538,7 +538,7 @@ 
      *
      * @param string $address The user's new mailing address
      *
-     * @return true|false true if the user's mailing address was changed, false otherwise
+     * @return boolean true if the user's mailing address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -552,7 +552,7 @@ 
      *
      * @param string $postalcode The user's new postal code
      *
-     * @return true|false true if the user's postal code was changed, false otherwise
+     * @return boolean true if the user's postal code was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -566,7 +566,7 @@ 
      *
      * @param string $country The user's new country
      *
-     * @return true|false true if the user's country was changed, false otherwise
+     * @return boolean true if the user's country was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -580,7 +580,7 @@ 
      *
      * @param string $ous The user's new organizations
      *
-     * @return true|false true if the user's organizations was changed, false otherwise
+     * @return boolean true if the user's organizations was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -704,7 +704,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()
     {