Fix various errors and warnings detected in VS Code (simplesamlphp#2468)

- Undeclared variable (incorrect name)
- Move some deprecated static functions to instances
- Namespacing on various PHPdoc tags
- Various PHPdoc tags NULL to lowercase
- Fix a PHP 8.2 deprecation re string interpolation

Author: rcnsheppardp

bin/memcacheSync.php

@@ -26,7 +26,8 @@
 require_once($baseDir . '/src/_autoload.php');
 
 // Initialize the configuration
-$configdir = SimpleSAML\Utils\Config::getConfigDir();
+$configUtils = new SimpleSAML\Utils\Config();
+$configdir = $configUtils->getConfigDir();
 \SimpleSAML\Configuration::setConfigDir($configdir);
 
 // Things we should warn the user about

modules/saml/src/Controller/ServiceProvider.php

@@ -119,7 +119,7 @@ public function login(Request $request, string $sourceId): RedirectResponse
      * @param   Utils\HTTP    $httpUtils
      *
      * @return string
-     * @throws BadRequest
+     * @throws \SimpleSAML\Error\BadRequest
      * @throws Error\Exception
      */
     protected function loginHandler(

modules/saml/src/IdP/SAML2.php

@@ -746,7 +746,7 @@ public static function receiveLogoutMessage(Request $request, IdP $idp): Respons
      *
      * @param \SimpleSAML\IdP $idp The IdP we are sending a logout request from.
      * @param array           $association The association that should be terminated.
-     * @param string|NULL     $relayState An id that should be carried across the logout.
+     * @param string|null     $relayState An id that should be carried across the logout.
      *
      * @return string The logout URL.
      */

src/SimpleSAML/Command/SspCacheClearCommand.php

@@ -59,7 +59,7 @@ protected function configure(): void
     }
 
     /**
-     * @throws ExceptionInterface
+     * @throws \Symfony\Component\Console\Exception\ExceptionInterface
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {

src/SimpleSAML/Metadata/MetaDataStorageHandlerDirectory.php

@@ -131,12 +131,10 @@ private function load(string $set): ?array
             }
         }
 
-
-
-
         if (!is_array($metadata)) {
-            throw new Exception('Could not load metadata set [' . $set . '] from file: ' . $metadatasetfile);
+            throw new Exception('Could not load metadata set [' . $set . '] from file: ' . $metadatasetdir);
         }
+        
         return $metadata;
     }
 

src/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php

@@ -104,7 +104,7 @@ private function load(string $set): ?array
             while ($d = $stmt->fetch()) {
                 $data = json_decode($d['entity_data'], true);
                 if ($data === null) {
-                    throw new Error\Exception("Cannot decode metadata for entity '${d['entity_id']}'");
+                    throw new Error\Exception("Cannot decode metadata for entity '{$d['entity_id']}'");
                 }
                 if (!array_key_exists('entityid', $data)) {
                     $data['entityid'] = $d['entity_id'];
@@ -188,7 +188,7 @@ public function getMetaData(string $entityId, string $set): ?array
             $data = json_decode($d['entity_data'], true);
             if (json_last_error() != JSON_ERROR_NONE) {
                 throw new Error\Exception(
-                    "Cannot decode metadata for entity '${d['entity_id']}'",
+                    "Cannot decode metadata for entity '{$d['entity_id']}'",
                 );
             }
 

src/SimpleSAML/Metadata/SAMLParser.php

@@ -340,7 +340,7 @@ public static function parseDescriptorsString(string $string): array
      * This function parses a DOMElement which represents either an EntityDescriptor element or an
      * EntitiesDescriptor element. It will return an associative array of SAMLParser instances in both cases.
      *
-     * @param \DOMElement|NULL $element The DOMElement which contains the EntityDescriptor element or the
+     * @param \DOMElement|null $element The DOMElement which contains the EntityDescriptor element or the
      *     EntitiesDescriptor element.
      *
      * @return SAMLParser[] An associative array of SAMLParser instances. The key of the array will
@@ -366,9 +366,8 @@ public static function parseDescriptorsElement(?DOMElement $element = null): arr
 
     /**
      *
-     * @param \SAML2\XML\md\EntityDescriptor|\SAML2\XML\md\EntitiesDescriptor $element
-     *   The element we should process.
-     * @param int|NULL              $maxExpireTime The maximum expiration time of the entities.
+     * @param \SAML2\XML\md\EntityDescriptor|\SAML2\XML\md\EntitiesDescriptor $element The element we should process.
+     * @param int|null              $maxExpireTime The maximum expiration time of the entities.
      * @param array                 $validators The parent-elements that may be signed.
      * @param array                 $parentExtensions An optional array of extensions from the parent element.
      *
@@ -749,9 +748,8 @@ private static function parseRoleDescriptorType(RoleDescriptor $element, ?int $e
      * - 'nameIDFormats': The NameIDFormats supported by this SSODescriptor. This may be an empty array.
      * - 'keys': Array of associative arrays with the elements from parseKeyDescriptor:
      *
-     * @param \SimpleSAML\SAML2\XML\md\SSODescriptorType $element The element we should extract metadata from.
-     * @param int|null                       $expireTime The unix timestamp for when this element should expire, or
-     *                             NULL if unknown.
+     * @param \SAML2\XML\md\SSODescriptorType $element The element we should extract metadata from.
+     * @param int|null $expireTime The unix timestamp for when this element should expire, or NULL if unknown.
      *
      * @return array An associative array with metadata we have extracted from this element.
      */
@@ -778,9 +776,8 @@ private static function parseSSODescriptor(SSODescriptorType $element, ?int $exp
     /**
      * This function extracts metadata from a SPSSODescriptor element.
      *
-     * @param \SimpleSAML\SAML2\XML\md\SPSSODescriptor $element The element which should be parsed.
-     * @param int|null                     $expireTime The unix timestamp for when this element should expire, or
-     *                             NULL if unknown.
+     * @param \SAML2\XML\md\SPSSODescriptor $element The element which should be parsed.
+     * @param int|null $expireTime The unix timestamp for when this element should expire, or NULL if unknown.
      */
     private function processSPSSODescriptor(SPSSODescriptor $element, ?int $expireTime): void
     {
@@ -812,9 +809,8 @@ private function processSPSSODescriptor(SPSSODescriptor $element, ?int $expireTi
     /**
      * This function extracts metadata from a IDPSSODescriptor element.
      *
-     * @param \SimpleSAML\SAML2\XML\md\IDPSSODescriptor $element The element which should be parsed.
-     * @param int|null                      $expireTime The unix timestamp for when this element should expire, or
-     *                             NULL if unknown.
+     * @param \SAML2\XML\md\IDPSSODescriptor $element The element which should be parsed.
+     * @param int|null $expireTime The unix timestamp for when this element should expire, or NULL if unknown.
      */
     private function processIDPSSODescriptor(IDPSSODescriptor $element, ?int $expireTime): void
     {
@@ -836,9 +832,8 @@ private function processIDPSSODescriptor(IDPSSODescriptor $element, ?int $expire
     /**
      * This function extracts metadata from a AttributeAuthorityDescriptor element.
      *
-     * @param \SimpleSAML\SAML2\XML\md\AttributeAuthorityDescriptor $element The element which should be parsed.
-     * @param int|null                                  $expireTime The unix timestamp for when this element should
-     *     expire, or NULL if unknown.
+     * @param \SAML2\XML\md\AttributeAuthorityDescriptor $element The element which should be parsed.
+     * @param int|null $expireTime The unix timestamp for when this element should expire, or NULL if unknown.
      */
     private function processAttributeAuthorityDescriptor(
         AttributeAuthorityDescriptor $element,

src/SimpleSAML/Module.php

@@ -477,7 +477,7 @@ public static function resolveClass(string $id, string $type, ?string $subclass
      * @param string The classname.
      * @param string|null $subclass The class should be a subclass of this class. Optional.
      *
-     * @return object the new object
+     * @return object The new object
      */
     public static function createObject(string $className, ?string $subclass = null): object
     {

src/SimpleSAML/Utils/Auth.php

@@ -17,7 +17,7 @@ class Auth
     /**
      * Retrieve an admin logout URL.
      *
-     * @param string|NULL $returnTo The URL the user should arrive on after admin authentication. Defaults to null.
+     * @param string|null $returnTo The URL the user should arrive on after admin authentication. Defaults to null.
      *
      * @return string A URL which can be used for logging out.
      * @throws \InvalidArgumentException If $returnTo is neither a string nor null.

src/SimpleSAML/Utils/Config/Metadata.php

@@ -60,7 +60,7 @@ class Metadata
      * @param array $endpoints An array with endpoints.
      * @param array|null $bindings An array with acceptable bindings. Can be null if any binding is allowed.
      *
-     * @return array|NULL The default endpoint, or null if no acceptable endpoints are used.
+     * @return array|null The default endpoint, or null if no acceptable endpoints are used.
      *
      */
     public static function getDefaultEndpoint(array $endpoints, ?array $bindings = null): ?array