Fix phpdoc

Author: pitbulk

lib/Saml2/Auth.php

@@ -129,7 +129,7 @@ class OneLogin_Saml2_Auth
      * (SAMLResponse, LogoutResponse). If the SAMLResponse was
      * encrypted, by default tries to return the decrypted XML
      *
-     * @var string
+     * @var string|\DomDocument|null
      */
     private $_lastResponse;
 
@@ -215,13 +215,13 @@ public function processResponse($requestId = null)
     /**
      * Process the SAML Logout Response / Logout Request sent by the IdP.
      *
-     * @param bool        $keepLocalSession              When false will destroy the local session, otherwise will keep it
-     * @param string|null $requestId                     The ID of the LogoutRequest sent by this SP to the IdP
-     * @param bool        $retrieveParametersFromServer
-     * @param callable    $cbDeleteSession
-     * @param bool        $stay                          True if we want to stay (returns the url string) False to redirect
+     * @param bool        $keepLocalSession             When false will destroy the local session, otherwise will keep it
+     * @param string|null $requestId                    The ID of the LogoutRequest sent by this SP to the IdP
+     * @param bool        $retrieveParametersFromServer True if we want to use parameters from $_SERVER to validate the signature
+     * @param callable    $cbDeleteSession              Callback to be executed to delete session
+     * @param bool        $stay                         True if we want to stay (returns the url string) False to redirect
      *
-     * @return string|void
+     * @return string|null
      *
      * @throws OneLogin_Saml2_Error
      */
@@ -386,7 +386,7 @@ public function getSessionIndex()
     /**
      * Returns the SessionNotOnOrAfter
      *
-     * @return DateTime|null  The SessionNotOnOrAfter of the assertion
+     * @return int|null  The SessionNotOnOrAfter of the assertion
      */
     public function getSessionExpiration()
     {
@@ -454,10 +454,10 @@ public function getAttributeWithFriendlyName($friendlyName)
      *
      * @param string|null $returnTo        The target URL the user should be returned to after login.
      * @param array       $parameters      Extra parameters to be added to the GET
-     * @param bool        $forceAuthn      When true the AuthNReuqest will set the ForceAuthn='true'
-     * @param bool        $isPassive       When true the AuthNReuqest will set the Ispassive='true'
+     * @param bool        $forceAuthn      When true the AuthNRequest will set the ForceAuthn='true'
+     * @param bool        $isPassive       When true the AuthNRequest will set the Ispassive='true'
      * @param bool        $stay            True if we want to stay (returns the url string) False to redirect
-     * @param bool        $setNameIdPolicy When true the AuthNReuqest will set a nameIdPolicy element
+     * @param bool        $setNameIdPolicy When true the AuthNRueqest will set a nameIdPolicy element
      *
      * @return string|null If $stay is True, it return a string with the SLO URL + LogoutRequest + parameters
      */
@@ -560,7 +560,7 @@ public function getSSOurl()
     /**
      * Gets the SLO url.
      *
-     * @return string The url of the Single Logout Service
+     * @return string|null The url of the Single Logout Service
      */
     public function getSLOurl()
     {

lib/Saml2/AuthnRequest.php

@@ -141,6 +141,8 @@ public function __construct(OneLogin_Saml2_Settings $settings, $forceAuthn = fal
      * Returns deflated, base64 encoded, unsigned AuthnRequest.
      *
      * @param bool|null $deflate Whether or not we should 'gzdeflate' the request body before we return it.
+     *
+     * @return string
      */
     public function getRequest($deflate = null)
     {

lib/Saml2/Response.php

@@ -950,7 +950,7 @@ public function validateSignedElements($signedElements)
     /**
      * Extracts a node from the DOMDocument (Assertion).
      *
-     * @param string $assertionXpath Xpath Expresion
+     * @param string $assertionXpath Xpath Expression
      *
      * @return DOMNodeList The queried node
      *

lib/Saml2/Utils.php

@@ -406,7 +406,7 @@ public static function setBaseURLPath($baseurlpath)
     }
 
     /**
-     * return string The baseurlpath to be used when constructing URLs
+     * @return string The baseurlpath to be used when constructing URLs
      */
     public static function getBaseURLPath()
     {
@@ -716,7 +716,7 @@ public static function parseSAML2Time($time)
      *                            duration to. Optional, default to the
      *                            current time.
      *
-     * @return int|null The new timestamp, after the duration is applied.
+     * @return int The new timestamp, after the duration is applied.
      *
      * @throws Exception
      */
@@ -799,8 +799,8 @@ public static function parseDuration($duration, $timestamp = null)
     /**
      * Compares 2 dates and returns the earliest.
      *
-     * @param string $cacheDuration The duration, as a string.
-     * @param string $validUntil    The valid until date, as a string or as a timestamp
+     * @param string|null       $cacheDuration The duration, as a string.
+     * @param string|int|null   $validUntil    The valid until date, as a string or as a timestamp
      *
      * @return int|null $expireTime  The expiration time.
      */
@@ -830,9 +830,9 @@ public static function getExpireTime($cacheDuration = null, $validUntil = null)
     /**
      * Extracts nodes from the DOMDocument.
      *
-     * @param DOMDocument $dom     The DOMDocument
-     * @param string      $query   Xpath Expresion
-     * @param DomElement  $context Context Node (DomElement)
+     * @param DOMDocument       $dom     The DOMDocument
+     * @param string            $query   Xpath Expresion
+     * @param DomElement|null   $context Context Node (DomElement)
      *
      * @return DOMNodeList The queried nodes
      */
@@ -953,7 +953,7 @@ public static function formatFingerPrint($fingerprint)
      *
      * @param string      $value  fingerprint
      * @param string      $spnq   SP Name Qualifier
-     * @param string      $format SP Format
+     * @param string|null $format SP Format
      * @param string|null $cert   IdP Public cert to encrypt the nameID
      * @param string|null $nq     IdP Name Qualifier
      *
@@ -1381,6 +1381,18 @@ public static function validateSign($xml, $cert = null, $fingerprint = null, $fi
         return $valid;
     }
 
+    /**
+     * Validates a binary signature
+     *
+     * @param string $messageType                    Type of SAML Message
+     * @param array  $getData                        HTTP GET array
+     * @param array  $idpData                        IdP setting data
+     * @param bool   $retrieveParametersFromServer   Indicates where to get the values in order to validate the Sign, from getData or from $_SERVER
+     *
+     * @return bool
+     *
+     * @throws Exception
+     */
     public static function validateBinarySign($messageType, $getData, $idpData, $retrieveParametersFromServer = false)
     {
         if (!isset($getData['SigAlg'])) {