BurningFlipside / CommonCode

Auth/class.Authenticator.php

Doc Comments +14 added lines, -14 removed lines

@@ -24,7 +24,7 @@ 
      * @param string $username The username
      * @param string $password The password
      *
-     * @return mixed False if unsuccessfuly login, opaque data otherwise
+     * @return boolean False if unsuccessfuly login, opaque data otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -36,7 +36,7 @@ 
     /**
      * Does the data indicate a logged in user?
      *
-     * @param mixed $data The data returned from login
+     * @param \stdClass $data The data returned from login
      *
      * @return boolean True if successfully logged in, false otherwise
      *
@@ -50,7 +50,7 @@ 
     /**
      * Get the user data for the specified data
      *
-     * @param mixed $data The data returned from login
+     * @param \stdClass $data The data returned from login
      *
      * @return Auth\User The user object if successfully logged in or null otherwise
      *
@@ -93,12 +93,12 @@ 
      * Get the groups that match the filters
      *
      * @param mixed $filter The filter to use to find a set of groups
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of groups to select
      * @param mixed $skip The number of groups to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All groups that fit the filters
+     * @return boolean All groups that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -111,12 +111,12 @@ 
      * Get the users that match the filters
      *
      * @param mixed $filter The filter to use to find a set of users
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of users to select
      * @param mixed $skip The number of users to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All users that fit the filters
+     * @return boolean All users that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -129,12 +129,12 @@ 
      * Get the pending users that match the filters
      *
      * @param mixed $filter The filter to use to find a set of users
-     * @param mixed $select The list of fields to select
+     * @param boolean $select The list of fields to select
      * @param mixed $top The number of users to select
      * @param mixed $skip The number of users to skip
      * @param mixed $orderby The fields to sort by
      *
-     * @return array All users that fit the filters
+     * @return boolean All users that fit the filters
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -191,7 +191,7 @@ 
     /**
      * Get the link to login using this method
      *
-     * @return string The link to login using this method
+     * @return boolean The link to login using this method
      */
     public function getSupplementLink()
     {
@@ -215,7 +215,7 @@ 
     /**
      * Convert a pending user to an active user
      *
-     * @param Auth\PendingUser $user The user to activate
+     * @param PendingUser $user The user to activate
      *
      * @return boolean True if activated, false otherwise
      *
@@ -231,7 +231,7 @@ 
      *
      * @param string $hash The hash to search by
      *
-     * @return Auth\User The user whoes hash was specified
+     * @return boolean The user whoes hash was specified
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -245,7 +245,7 @@ 
      *
      * @param string $hash The hash to search by
      *
-     * @return Auth\PendingUser The user whoes hash was specified
+     * @return boolean The user whoes hash was specified
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -257,7 +257,7 @@ 
     /**
      * Get the host name this authenticator uses
      *
-     * @return string The host name this authenticator uses
+     * @return boolean The host name this authenticator uses
      */
     public function getHostName()
     {

Auth/class.LDAPAuthenticator.php

Doc Comments +9 added lines

@@ -279,6 +279,12 @@ 
         return $server->count($this->user_base);
     }
 
+    /**
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function processFilteringParams(&$data, &$select, $top, $skip, $orderby)
     {
         if($orderby !== false)
@@ -303,6 +309,9 @@ 
         }
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     public function getUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
     {
         $server = $this->get_and_bind_server();

Auth/class.LDAPCachableObject.php

Doc Comments +12 added lines

@@ -18,6 +18,9 @@ 
         }
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getField($fieldName)
     {
         if(!is_object($this->ldapObj))
@@ -27,6 +30,9 @@ 
         return $this->getFieldServer($fieldName);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function getFieldSingleValue($fieldName)
     {
         if(!is_object($this->ldapObj))
@@ -36,6 +42,9 @@ 
         return $this->getFieldServerSingleValue($fieldName);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function setField($fieldName, $fieldValue)
     {
         if(!is_object($this->ldapObj))
@@ -45,6 +54,9 @@ 
         return $this->setFieldServer($fieldName, $fieldValue);
     }
 
+    /**
+     * @param string $fieldName
+     */
     protected function appendField($fieldName, $fieldValue)
     {
         if(!is_object($this->ldapObj))

Auth/class.PendingUser.php

Doc Comments +5 added lines, -6 removed lines

@@ -35,7 +35,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
      */
     public function isInGroupNamed($name)
     {
@@ -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 string The current password
+     * @return boolean The current password
      */
     public function getPassword()
     {
@@ -135,7 +135,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
      */
     public function setEmail($email)
     {
@@ -146,9 +146,8 @@ 
     /**
      * Set the user's given (first) name
      *
-     * @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
      */
     public function setGivenName($givenName)
     {
@@ -161,7 +160,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
      */
     public function setLastName($sn)
     {

Auth/class.SQLAuthenticator.php

Doc Comments +20 added lines

@@ -138,6 +138,9 @@ 
          return $dataTable;
     }
 
+    /**
+     * @return boolean
+     */
     private function getPendingUserDataTable()
     {
         if(isset($this->params['pending_user_table']))
@@ -208,6 +211,14 @@ 
         return $dataTable->read($filter, $select, $top, $skip, $orderby);
     }
 
+    /**
+     * @param string $dataTableName
+     * @param string $className
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function convertDataToClass($dataTableName, $className, $filter, $select, $top, $skip, $orderby)
     {
         $data = $this->getDataByFilter($dataTableName, $filter, $select, $top, $skip, $orderby);
@@ -241,6 +252,12 @@ 
         return $dataTable->count();
     }
 
+    /**
+     * @param boolean $select
+     * @param boolean $top
+     * @param boolean $skip
+     * @param boolean $orderby
+     */
     private function searchPendingUsers($filter, $select, $top, $skip, $orderby)
     {
         $userDataTable = $this->getPendingUserDataTable();
@@ -272,6 +289,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param \Data\Filter $filter
+     */
     public function getPendingUsersByFilter($filter, $select=false, $top=false, $skip=false, $orderby=false)
 
     {

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

Auth/OAuth2/class.OAuth2Authenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
      * @param $params The set of parameters obtained from the authentication call
      * @param $current_user The user from the current system if the user is not authorized to login via this method
      *
-     * @return SUCCESS|LOGIN_FAILED|ALREADY_PRESENT SUCCESS if the user is now logged in. ALREADY_PRESENT if the authorization was
+     * @return integer SUCCESS if the user is now logged in. ALREADY_PRESENT if the authorization was
      *                                              successful, but the user has not authorized that login method. LOGIN_FAILED for all other errors
      */
     public function authenticate($params, &$current_user)

class.AuthProvider.php

Doc Comments +6 added lines, -6 removed lines

@@ -53,7 +53,7 @@ 
      *
      * @param string $methodName The class name of the Authenticator to get the instance for
      *
-     * @return Auth\Authenticator|false The specified Authenticator class instance or false if it is not loaded
+     * @return string The specified Authenticator class instance or false if it is not loaded
      */
     public function getAuthenticator($methodName)
     {
@@ -269,11 +269,11 @@ 
      * Get an array of Auth\PendingUser from a filtered set
      *
      * @param Data\Filter|false $filter The filter conditions or false to retreive all
-     * @param array|false $methodName The user fields to obtain or false to obtain all
-     * @param integer|false $top The number of users to obtain or false to obtain all
-     * @param integer|false $skip The number of users to skip or false to skip none
-     * @param array|false $orderby The field to sort by and the method to sort or false to not sort
-     * @param string|false $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
+     * @param boolean $methodName 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 boolean $methodName The AuthMethod if information is desired only from a particular Auth\Authenticator
      *
      * @return array|false An array of Auth\PendingUser objects or false if no pending users were found
      */

class.FlipAdminPage.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         $this->addWellKnownJS(JS_METISMENU, false);
     }
 
+    /**
+     * @param string $adminGroup
+     */
     protected function userIsAdmin($adminGroup)
     {
         if($this->user === false || $this->user === null)