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

class.FlipPage.php

Doc Comments +10 added lines, -6 removed lines

@@ -487,7 +487,6 @@ 
     /**
      * Add a Cascading Style Sheet file from its src URI
      *
-     * @param string $src The webpath to the Cascading Style Sheet file
      * @param boolean $async Can the CSS be loaded asynchronously?
      */
     public function addCSSByURI($uri, $async=false)
@@ -514,6 +513,9 @@ 
         $this->addWellKnownJS($type, $async);
     }
 
+    /**
+     * @param integer $type
+     */
     function add_js($type, $async=true)
     {
         $this->addWellKnownJS($type, $async);
@@ -582,6 +584,9 @@ 
         return $ret;
     }
 
+    /**
+     * @return string
+     */
     protected function getHrefForDropdown(&$link)
     {
         if(isset($link['_']))
@@ -685,7 +690,7 @@ 
      *
      * @param string $msg The message to show in the notifcation
      * @param string $sev The severity of the notifcation
-     * @param boolean $dismissible Can the user dismiss the notificaton?
+     * @param integer $dismissible Can the user dismiss the notificaton?
      *
      * @deprecated 2.0.0 Use the addNotification function instead 
      */
@@ -699,7 +704,7 @@ 
      * Add a notification to the page
      *
      * @param string $message The message to show in the notifcation
-     * @param string $sevity The severity of the notifcation
+     * @param string $severity The severity of the notifcation
      * @param boolean $dismissible Can the user dismiss the notificaton?
      *
      * @deprecated 2.0.0 Use the addNotification function instead
@@ -793,7 +798,6 @@ 
      * Draw the page
      *
      * @param boolean $header Draw the header
-     * @param boolean $analytics Include analytics on the page
      */
     public function printPage($header=true)
     {
@@ -812,7 +816,7 @@ 
      *
      * @param string $name The name of the link
      * @param false|string $url The URL to link to
-     * @param false|array $subment Any submenu items for the dropdown
+     * @param false|array $submenu Any submenu items for the dropdown
      *
      * @deprecated 1.0.0 Use addLink instead
      */
@@ -826,7 +830,7 @@ 
      *
      * @param string $name The name of the link
      * @param false|string $url The URL to link to
-     * @param false|array $subment Any submenu items for the dropdown
+     * @param false|array $submenu Any submenu items for the dropdown
      */
     public function addLink($name, $url=false, $submenu=false)
     {