From 60d99afe615e6000da54db12f3696ee803fa76ca Mon Sep 17 00:00:00 2001
From: Tim van Dijen <tvdijen@gmail.com>
Date: Wed, 2 Oct 2019 22:53:24 +0200
Subject: [PATCH] Fix PHPdoc typo
---
lib/SimpleSAML/Auth/Simple.php | 2 +-
lib/SimpleSAML/Auth/Source.php | 2 +-
lib/SimpleSAML/IdP.php | 4 ++--
lib/SimpleSAML/Locale/Localization.php | 2 +-
lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php | 2 +-
lib/SimpleSAML/Metadata/SAMLParser.php | 6 +++---
lib/SimpleSAML/Metadata/Signer.php | 2 +-
lib/SimpleSAML/Utils/EMail.php | 3 +--
lib/SimpleSAML/XHTML/IdPDisco.php | 2 +-
modules/core/lib/Auth/Process/AttributeMap.php | 4 ++--
modules/cron/lib/Cron.php | 2 +-
modules/saml/lib/Auth/Process/AttributeNameID.php | 2 +-
modules/saml/lib/Auth/Process/AuthnContextClassRef.php | 2 +-
13 files changed, 17 insertions(+), 18 deletions(-)
diff --git a/lib/SimpleSAML/Auth/Simple.php b/lib/SimpleSAML/Auth/Simple.php
index 3c5a4f117..5ad7ca2ca 100644
--- a/lib/SimpleSAML/Auth/Simple.php
+++ b/lib/SimpleSAML/Auth/Simple.php
@@ -59,7 +59,7 @@ class Simple
*
* @return Source The authentication source.
*
- * @throws AuthSourceError If the requested auth source is unknown.
+ * @throws \SimpleSAML\Error\AuthSource If the requested auth source is unknown.
*/
public function getAuthSource()
{
diff --git a/lib/SimpleSAML/Auth/Source.php b/lib/SimpleSAML/Auth/Source.php
index 1e00aba0d..36b7e28c6 100644
--- a/lib/SimpleSAML/Auth/Source.php
+++ b/lib/SimpleSAML/Auth/Source.php
@@ -54,7 +54,7 @@ abstract class Source
* @param string $type The type of the authentication source.
*
* @return Source[] Array of \SimpleSAML\Auth\Source objects of the specified type.
- * @throws Exception If the authentication source is invalid.
+ * @throws \Exception If the authentication source is invalid.
*/
public static function getSourcesOfType($type)
{
diff --git a/lib/SimpleSAML/IdP.php b/lib/SimpleSAML/IdP.php
index ec6a622c7..e11926a78 100644
--- a/lib/SimpleSAML/IdP.php
+++ b/lib/SimpleSAML/IdP.php
@@ -368,7 +368,7 @@ class IdP
*
* @param array &$state The authentication request state.
*
- * @throws Exception If there is no auth source defined for this IdP.
+ * @throws \Exception If there is no auth source defined for this IdP.
* @return void
*/
private function reauthenticate(array &$state)
@@ -431,7 +431,7 @@ class IdP
* Find the logout handler of this IdP.
*
* @return IdP\LogoutHandlerInterface The logout handler class.
- * @throws Exception If we cannot find a logout handler.
+ * @throws \Exception If we cannot find a logout handler.
*/
public function getLogoutHandler()
{
diff --git a/lib/SimpleSAML/Locale/Localization.php b/lib/SimpleSAML/Locale/Localization.php
index e334bfc37..7e73ca780 100644
--- a/lib/SimpleSAML/Locale/Localization.php
+++ b/lib/SimpleSAML/Locale/Localization.php
@@ -172,7 +172,7 @@ class Localization
* Get and check path of localization file
*
* @param string $domain Name of localization domain
- * @throws Exception If the path does not exist even for the default, fallback language
+ * @throws \Exception If the path does not exist even for the default, fallback language
*
* @return string
*/
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php
index e47ddedf8..913397412 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerXML.php
@@ -31,7 +31,7 @@ class MetaDataStorageHandlerXML extends MetaDataStorageSource
*
* @param array $config The configuration for this instance of the XML metadata source.
*
- * @throws Exception If neither the 'file' or 'url' options are defined in the configuration.
+ * @throws \Exception If neither the 'file' or 'url' options are defined in the configuration.
*/
protected function __construct($config)
{
diff --git a/lib/SimpleSAML/Metadata/SAMLParser.php b/lib/SimpleSAML/Metadata/SAMLParser.php
index eb72ceddd..2c8fb8fb9 100644
--- a/lib/SimpleSAML/Metadata/SAMLParser.php
+++ b/lib/SimpleSAML/Metadata/SAMLParser.php
@@ -239,7 +239,7 @@ class SAMLParser
* @param string $file The path to the file which contains the metadata.
*
* @return SAMLParser An instance of this class with the metadata loaded.
- * @throws Exception If the file does not parse as XML.
+ * @throws \Exception If the file does not parse as XML.
*/
public static function parseFile($file)
{
@@ -262,7 +262,7 @@ class SAMLParser
* @param string $metadata A string which contains XML encoded metadata.
*
* @return SAMLParser An instance of this class with the metadata loaded.
- * @throws Exception If the string does not parse as XML.
+ * @throws \Exception If the string does not parse as XML.
*/
public static function parseString($metadata)
{
@@ -1463,7 +1463,7 @@ class SAMLParser
* to do a key rollover.
*
* @return boolean True if it is possible to check the signature with the certificate, false otherwise.
- * @throws Exception If the certificate file cannot be found.
+ * @throws \Exception If the certificate file cannot be found.
*/
public function validateSignature($certificates)
{
diff --git a/lib/SimpleSAML/Metadata/Signer.php b/lib/SimpleSAML/Metadata/Signer.php
index c676e967e..7a80bdd13 100644
--- a/lib/SimpleSAML/Metadata/Signer.php
+++ b/lib/SimpleSAML/Metadata/Signer.php
@@ -28,7 +28,7 @@ class Signer
* 'Shib 1.3 SP'.
*
* @return array An associative array with the keys 'privatekey', 'certificate', and optionally 'privatekey_pass'.
- * @throws Exception If the key and certificate used to sign is unknown.
+ * @throws \Exception If the key and certificate used to sign is unknown.
*/
private static function findKeyCert($config, $entityMetadata, $type)
{
diff --git a/lib/SimpleSAML/Utils/EMail.php b/lib/SimpleSAML/Utils/EMail.php
index 062244679..9ed369279 100644
--- a/lib/SimpleSAML/Utils/EMail.php
+++ b/lib/SimpleSAML/Utils/EMail.php
@@ -3,7 +3,6 @@
namespace SimpleSAML\Utils;
use PHPMailer\PHPMailer\PHPMailer;
-use PHPMailer\PHPMailer\Exception;
use SimpleSAML\Configuration;
use SimpleSAML\Logger;
use SimpleSAML\XHTML\Template;
@@ -38,7 +37,7 @@ class EMail
* @param string $from The from-address (both envelope and header)
* @param string $to The recipient
*
- * @throws PHPMailer\PHPMailer\Exception
+ * @throws \PHPMailer\PHPMailer\Exception
*/
public function __construct($subject, $from = null, $to = null)
{
diff --git a/lib/SimpleSAML/XHTML/IdPDisco.php b/lib/SimpleSAML/XHTML/IdPDisco.php
index c7f37b43f..1b8f56cc6 100644
--- a/lib/SimpleSAML/XHTML/IdPDisco.php
+++ b/lib/SimpleSAML/XHTML/IdPDisco.php
@@ -113,7 +113,7 @@ class IdPDisco
* @param array $metadataSets Array with metadata sets we find remote entities in.
* @param string $instance The name of this instance of the discovery service.
*
- * @throws Exception If the request is invalid.
+ * @throws \Exception If the request is invalid.
*/
public function __construct(array $metadataSets, $instance)
{
diff --git a/modules/core/lib/Auth/Process/AttributeMap.php b/modules/core/lib/Auth/Process/AttributeMap.php
index a007d3805..7efdd2f73 100644
--- a/modules/core/lib/Auth/Process/AttributeMap.php
+++ b/modules/core/lib/Auth/Process/AttributeMap.php
@@ -32,7 +32,7 @@ class AttributeMap extends \SimpleSAML\Auth\ProcessingFilter
* @param array &$config Configuration information about this filter.
* @param mixed $reserved For future use.
*
- * @throws Exception If the configuration of the filter is wrong.
+ * @throws \Exception If the configuration of the filter is wrong.
*/
public function __construct(&$config, $reserved)
{
@@ -76,7 +76,7 @@ class AttributeMap extends \SimpleSAML\Auth\ProcessingFilter
* @param string $fileName Name of attribute map file. Expected to be in the attributemap directory in the root
* of the SimpleSAMLphp installation, or in the root of a module.
*
- * @throws Exception If the filter could not load the requested attribute map file.
+ * @throws \Exception If the filter could not load the requested attribute map file.
* @return void
*/
private function loadMapFile($fileName)
diff --git a/modules/cron/lib/Cron.php b/modules/cron/lib/Cron.php
index 321431576..7a673ba10 100644
--- a/modules/cron/lib/Cron.php
+++ b/modules/cron/lib/Cron.php
@@ -34,7 +34,7 @@ class Cron
* Invoke the cron hook for the given tag
* @param string $tag The tag to use. Must be valid in the cronConfig
* @return array the tag, and summary information from the run.
- * @throws Exception If an invalid tag specified
+ * @throws \Exception If an invalid tag specified
*/
public function runTag($tag)
{
diff --git a/modules/saml/lib/Auth/Process/AttributeNameID.php b/modules/saml/lib/Auth/Process/AttributeNameID.php
index b8e1b8889..d0b4393bf 100644
--- a/modules/saml/lib/Auth/Process/AttributeNameID.php
+++ b/modules/saml/lib/Auth/Process/AttributeNameID.php
@@ -27,7 +27,7 @@ class AttributeNameID extends \SimpleSAML\Module\saml\BaseNameIDGenerator
* @param array $config Configuration information about this filter.
* @param mixed $reserved For future use.
*
- * @throws \SimpleSAMLError\Exception If the required options 'Format' or 'attribute' are missing.
+ * @throws \SimpleSAML\Error\Exception If the required options 'Format' or 'attribute' are missing.
*/
public function __construct($config, $reserved)
{
diff --git a/modules/saml/lib/Auth/Process/AuthnContextClassRef.php b/modules/saml/lib/Auth/Process/AuthnContextClassRef.php
index c9330a8db..b2e6eb358 100644
--- a/modules/saml/lib/Auth/Process/AuthnContextClassRef.php
+++ b/modules/saml/lib/Auth/Process/AuthnContextClassRef.php
@@ -25,7 +25,7 @@ class AuthnContextClassRef extends \SimpleSAML\Auth\ProcessingFilter
* @param array $config Configuration information about this filter.
* @param mixed $reserved For future use.
*
- * @throws \SimpleSAML\Error\_Exception if the mandatory 'AuthnContextClassRef' option is missing.
+ * @throws \SimpleSAML\Error\Exception if the mandatory 'AuthnContextClassRef' option is missing.
*/
public function __construct($config, $reserved)
{
--
GitLab