Merge pull request #308 from stof/fix_phpdoc

Fix phpdoc

Author: pitbulk

src/Saml2/Auth.php

@@ -122,7 +122,7 @@ class Auth
     /**
      * Last error.
      *
-     * @var String|null
+     * @var string|null
      */
     private $_lastError;
 
@@ -146,7 +146,7 @@ class Auth
      * (SAMLResponse, LogoutResponse). If the SAMLResponse was
      * encrypted, by default tries to return the decrypted XML
      *
-     * @var string
+     * @var string|\DomDocument|null
      */
     private $_lastResponse;
 
@@ -236,10 +236,10 @@ public function processResponse($requestId = null)
      * @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              Method name to be executed to delete session
+     * @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 Error
      */
@@ -397,7 +397,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()
     {
@@ -428,7 +428,7 @@ public function getLastErrorReason()
     /**
      * Returns the last error
      *
-     * @return Exception Error
+     * @return Exception|null Error
      */
     public function getLastErrorException()
     {
@@ -458,10 +458,10 @@ public function getAttribute($name)
      *
      * @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 AuthNRequest 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()
     {

src/Saml2/AuthnRequest.php

@@ -156,6 +156,8 @@ public function __construct(\OneLogin\Saml2\Settings $settings, $forceAuthn = fa
      * 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)
     {

src/Saml2/LogoutResponse.php

@@ -55,7 +55,7 @@ class LogoutResponse
     /**
      * After execute a validation process, if it fails, this var contains the cause
      *
-     * @var string|null
+     * @var Exception|null
      */
     private $_error;
 
@@ -129,8 +129,6 @@ public function getStatus()
      * @param bool        $retrieveParametersFromServer True if we want to use parameters from $_SERVER to validate the signature
      *
      * @return bool Returns if the SAML LogoutResponse is or not valid
-     *
-     * @throws Exception
      */
     public function isValid($requestId = null, $retrieveParametersFromServer = false)
     {
@@ -287,7 +285,7 @@ public function getResponse($deflate = null)
     /**
      * After execute a validation process, if fails this method returns the cause.
      *
-     * @return Exception Cause
+     * @return Exception|null Cause
      */
     public function getErrorException()
     {

src/Saml2/Metadata.php

@@ -35,7 +35,7 @@ class Metadata
      * @param array         $sp            The SP data
      * @param bool|string   $authnsign     authnRequestsSigned attribute
      * @param bool|string   $wsign         wantAssertionsSigned attribute
-     * @param DateTime|null $validUntil    Metadata's valid time
+     * @param int|null      $validUntil    Metadata's valid time
      * @param int|null      $cacheDuration Duration of the cache in seconds
      * @param array         $contacts      Contacts info
      * @param array         $organization  Organization ingo
@@ -207,7 +207,7 @@ public static function signMetadata($metadata, $key, $cert, $signAlgorithm = XML
     }
 
     /**
-     * Adds the x509 descriptors (sign/encriptation) to the metadata
+     * Adds the x509 descriptors (sign/encryption) to the metadata
      * The same cert will be used for sign/encrypt
      *
      * @param string $metadata       SAML Metadata XML

src/Saml2/Response.php

@@ -66,7 +66,7 @@ class Response
     /**
      * After validation, if it fail this var has the cause of the problem
      *
-     * @var Exception
+     * @var Exception|null
      */
     private $_error;
 
@@ -1023,7 +1023,7 @@ protected function _queryAssertion($assertionXpath)
     /**
      * Extracts nodes that match the query from the DOMDocument (Response Menssage)
      *
-     * @param string $query Xpath Expresion
+     * @param string $query Xpath Expression
      *
      * @return DOMNodeList The queried nodes
      */
@@ -1125,7 +1125,7 @@ protected function decryptAssertion(\DomNode $dom)
     /**
      * After execute a validation process, if fails this method returns the cause
      *
-     * @return Exception Cause
+     * @return Exception|null Cause
      */
     public function getErrorException()
     {

src/Saml2/Utils.php

@@ -399,7 +399,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()
     {
@@ -712,7 +712,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
      */
@@ -796,8 +796,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.
      */
@@ -827,9 +827,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
      */
@@ -950,7 +950,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
      *
@@ -1382,10 +1382,10 @@ public static function validateSign($xml, $cert = null, $fingerprint = null, $fi
     /**
      * Validates a binary signature
      *
-     * @param string        $messageType                    Type of SAML Message
-     * @param array         $getData                        HTTP GET array
-     * @param array         $idpData                        IdP setting data
-     * @param string|null   $retrieveParametersFromServer   Indicates where to get the values in order to validate the Sign, from getData or from $_SERVER
+     * @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
      *