Added return statements, updated return types (#958)

*    Updated the phpDoc comments to match the code
*    Added return statements
*    Added return values

lib/SimpleSAML/Auth/LDAP.php

@@ -205,6 +205,7 @@ private function makeException($description, $type = null)
                     return new Error\AuthSource('ldap', $description);
             }
         }
+        return new \Exception('Unknown LDAP error.');
     }
 
 

lib/SimpleSAML/Auth/ProcessingChain.php

@@ -316,7 +316,7 @@ public function processStatePassive(&$state)
      *
      * @param string $id The state identifier.
      * @see State::parseStateID()
-     * @return Array The state referenced by the $id parameter.
+     * @return array The state referenced by the $id parameter.
      */
     public static function fetchProcessedState($id)
     {

lib/SimpleSAML/Metadata/SAMLParser.php

@@ -1340,7 +1340,7 @@ private static function parseKeyDescriptor(\SAML2\XML\md\KeyDescriptor $kd)
      *
      * @param $protocols Array with the protocols we accept.
      *
-     * @return Array with SP descriptors which supports one of the given protocols.
+     * @return array with SP descriptors which supports one of the given protocols.
      */
     private function getSPDescriptors($protocols)
     {
@@ -1364,7 +1364,7 @@ private function getSPDescriptors($protocols)
      *
      * @param $protocols Array with the protocols we accept.
      *
-     * @return Array with IdP descriptors which supports one of the given protocols.
+     * @return array with IdP descriptors which supports one of the given protocols.
      */
     private function getIdPDescriptors($protocols)
     {

lib/SimpleSAML/XHTML/Template.php

@@ -155,7 +155,7 @@ private function normalizeTemplateName($templateName)
     /**
      * Set up the places where twig can look for templates.
      *
-     * @return \Twig_Loader_Filesystem The twig template loader or false if the template does not exist.
+     * @return TemplateLoader The twig template loader or false if the template does not exist.
      * @throws \Twig_Error_Loader In case a failure occurs.
      */
     private function setupTwigTemplatepaths()

modules/authYubiKey/lib/Auth/Source/YubiKey.php

@@ -121,7 +121,7 @@ public function authenticate(&$state)
      *
      * @param string $authStateId  The identifier of the authentication state.
      * @param string $otp  The one time password entered-
-     * @return string  Error code in the case of an error.
+     * @return string|null  Error code in the case of an error.
      */
     public static function handleLogin($authStateId, $otp)
     {
@@ -158,6 +158,8 @@ public static function handleLogin($authStateId, $otp)
 
         $state['Attributes'] = $attributes;
         \SimpleSAML\Auth\Source::completeAuth($state);
+
+        return null;
     }
 
     /**

modules/authfacebook/extlibinc/base_facebook.php

@@ -352,6 +352,8 @@ public function setAccessToken($access_token)
      * Extend an access token, while removing the short-lived token that might
      * have been generated via client-side flow. Thanks to http://bit.ly/b0Pt0H
      * for the workaround.
+     *
+     * @return boolean Return true is the access token is set.
      */
     public function setExtendedAccessToken()
     {
@@ -390,6 +392,7 @@ public function setExtendedAccessToken()
             'access_token',
             $response_params['access_token']
         );
+        return true;
     }
 
     /**
@@ -492,7 +495,7 @@ protected function getUserAccessToken()
      * Retrieve the signed request, either from a request parameter or,
      * if not present, from a cookie.
      *
-     * @return string the signed request, if available, or null otherwise.
+     * @return array the signed request, if available, or null otherwise.
      */
     public function getSignedRequest()
     {

modules/cas/lib/Auth/Source/CAS.php

@@ -178,7 +178,6 @@ protected function casValidation($ticket, $service)
     /**
      * Called by linkback, to finish validate/ finish logging in.
      * @param array $state
-     * @return array username, casattributes/ldap attributes
      */
     public function finalStep(&$state)
     {

modules/cdc/lib/Server.php

@@ -420,5 +420,7 @@ private function setCDC(array $list)
         );
 
         \SimpleSAML\Utils\HTTP::setCookie('_saml_idp', $cookie, $params, false);
+
+        return '_saml_idp';
     }
 }

modules/consent/lib/Consent/Store/Database.php

@@ -263,17 +263,16 @@ public function deleteConsent($userId, $destinationId)
         );
 
         if ($st === false) {
-            return;
+            return 0;
         }
 
         if ($st->rowCount() > 0) {
             \SimpleSAML\Logger::debug('consent:Database - Deleted consent.');
             return $st->rowCount();
-        } else {
-            \SimpleSAML\Logger::warning(
-                'consent:Database - Attempted to delete nonexistent consent'
-            );
         }
+
+        \SimpleSAML\Logger::warning('consent:Database - Attempted to delete nonexistent consent');
+        return 0;
     }
 
 
@@ -294,15 +293,16 @@ public function deleteAllConsents($userId)
         );
 
         if ($st === false) {
-            return;
+            return 0;
         }
 
         if ($st->rowCount() > 0) {
             \SimpleSAML\Logger::debug('consent:Database - Deleted ('.$st->rowCount().') consent(s).');
             return $st->rowCount();
-        } else {
-            \SimpleSAML\Logger::warning('consent:Database - Attempted to delete nonexistent consent');
         }
+
+        \SimpleSAML\Logger::warning('consent:Database - Attempted to delete nonexistent consent');
+        return 0;
     }
 
 

modules/core/lib/ACL.php

@@ -87,6 +87,7 @@ public function allows(array $attributes)
                 return false;
             }
         }
+        return false;
     }
 
     /**

modules/statistics/lib/Graph/GoogleCharts.php

@@ -171,5 +171,6 @@ public static function roof($max)
                 return $target_top;
             }
         }
+        return 1;
     }
 }