Typed properties & strict typing

tvdijen · tvdijen · commit 47d523d69d72 · 2021-01-24T11:43:39.000+01:00
diff --git a/lib/Cas/AttributeExtractor.php b/lib/Cas/AttributeExtractor.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas;
 
 use SimpleSAML\Configuration;
diff --git a/lib/Cas/CasException.php b/lib/Cas/CasException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas;
 
 /**
@@ -15,7 +17,7 @@ class CasException extends \Exception
     public const INVALID_SERVICE = 'INVALID_SERVICE';
 
     /** @var string */
-    private $casCode;
+    private string $casCode;
 
     /**
      * CasException constructor.
diff --git a/lib/Cas/Protocol/Cas10.php b/lib/Cas/Protocol/Cas10.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Protocol;
 
 use SimpleSAML\Configuration;
diff --git a/lib/Cas/Protocol/Cas20.php b/lib/Cas/Protocol/Cas20.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Protocol;
 
 use DOMDocument;
@@ -32,19 +34,19 @@
 class Cas20
 {
     /** @var bool $sendAttributes */
-    private $sendAttributes;
+    private bool $sendAttributes;
 
     /** @var bool $base64EncodeAttributes */
-    private $base64EncodeAttributes;
+    private bool $base64EncodeAttributes;
 
     /** @var string|null $base64IndicatorAttribute */
-    private $base64IndicatorAttribute;
+    private ?string $base64IndicatorAttribute;
 
     /** @var array $attributes */
-    private $attributes = [];
+    private array $attributes = [];
 
     /** @var string|null $proxyGrantingTicketIOU */
-    private $proxyGrantingTicketIOU = null;
+    private ?string $proxyGrantingTicketIOU = null;
 
 
     /**
diff --git a/lib/Cas/Protocol/SamlValidateResponder.php b/lib/Cas/Protocol/SamlValidateResponder.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Protocol;
 
 use SimpleSAML\Configuration;
diff --git a/lib/Cas/ServiceValidator.php b/lib/Cas/ServiceValidator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas;
 
 use SimpleSAML\Configuration;
@@ -12,9 +14,9 @@
 class ServiceValidator
 {
     /**
-     * @var Configuration
+     * @var \SimpleSAML\Configuration
      */
-    private $mainConfig;
+    private Configuration $mainConfig;
 
     /**
      * ServiceValidator constructor.
diff --git a/lib/Cas/Ticket/DelegatingTicketStore.php b/lib/Cas/Ticket/DelegatingTicketStore.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use Exception;
@@ -17,17 +19,18 @@ class DelegatingTicketStore extends TicketStore
     /**
      * @var string Delegate to 'all', 'first', or a named entry.
      */
-    private $delegateTo = 'all';
+    private string $delegateTo = 'all';
 
     /**
-     * @var TicketStore[]
+     * @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore[]
      */
-    private $ticketStores = [];
+    private array $ticketStores = [];
 
     /**
-     * @var TicketStore
+     * @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore
      */
-    private $primaryDelegate;
+    private TicketStore $primaryDelegate;
+
 
     /**
      * @param \SimpleSAML\Configuration $casConfig The cas configuration.
diff --git a/lib/Cas/Ticket/FileSystemTicketStore.php b/lib/Cas/Ticket/FileSystemTicketStore.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use Exception;
@@ -29,7 +31,7 @@
 class FileSystemTicketStore extends TicketStore
 {
     /** @var string $pathToTicketDirectory */
-    private $pathToTicketDirectory;
+    private string $pathToTicketDirectory;
 
 
     /**
diff --git a/lib/Cas/Ticket/MemCacheTicketStore.php b/lib/Cas/Ticket/MemCacheTicketStore.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use SimpleSAML\Configuration;
@@ -29,7 +31,7 @@
 class MemCacheTicketStore extends TicketStore
 {
     /** @var string $prefix */
-    private $prefix = '';
+    private string $prefix = '';
 
 
     /**
diff --git a/lib/Cas/Ticket/RedisTicketStore.php b/lib/Cas/Ticket/RedisTicketStore.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use SimpleSAML\Configuration;
@@ -29,10 +31,10 @@
 class RedisTicketStore extends TicketStore
 {
     /** @var string $prefix */
-    private $prefix = '';
+    private string $prefix = '';
 
     /** @var \SimpleSAML\Store\Redis $redis */
-    private $redis;
+    private Redis $redis;
 
 
     /**
diff --git a/lib/Cas/Ticket/SQLTicketStore.php b/lib/Cas/Ticket/SQLTicketStore.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use Exception;
@@ -34,16 +36,16 @@
 class SQLTicketStore extends TicketStore
 {
     /** @var \PDO $pdo */
-    public $pdo;
+    public PDO $pdo;
 
     /** @var string $driver */
-    public $driver = 'pdo';
+    public string $driver = 'pdo';
 
     /** @var string $prefix */
-    public $prefix;
+    public string $prefix;
 
     /** @var array $tableVersions */
-    private $tableVersions = [];
+    private array $tableVersions = [];
 
 
     /**
diff --git a/lib/Cas/Ticket/TicketFactory.php b/lib/Cas/Ticket/TicketFactory.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use SimpleSAML\Configuration;
@@ -29,13 +31,13 @@
 class TicketFactory
 {
     /** @var int $serviceTicketExpireTime */
-    private $serviceTicketExpireTime;
+    private int $serviceTicketExpireTime;
 
     /** @var int $proxyGrantingTicketExpireTime */
-    private $proxyGrantingTicketExpireTime;
+    private int $proxyGrantingTicketExpireTime;
 
     /** @var int $proxyTicketExpireTime */
-    private $proxyTicketExpireTime;
+    private int $proxyTicketExpireTime;
 
 
     /**
diff --git a/lib/Cas/Ticket/TicketStore.php b/lib/Cas/Ticket/TicketStore.php
@@ -21,6 +21,8 @@
  *
  */
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas\Ticket;
 
 use SimpleSAML\Configuration;
diff --git a/lib/Cas/TicketValidator.php b/lib/Cas/TicketValidator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace SimpleSAML\Module\casserver\Cas;
 
 use SimpleSAML\Configuration;
@@ -13,13 +15,13 @@
 class TicketValidator
 {
     /** @var \SimpleSAML\Configuration */
-    private $casconfig;
+    private Configuration $casconfig;
 
     /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketStore */
-    private $ticketStore;
+    private TicketStore $ticketStore;
 
     /** @var \SimpleSAML\Module\casserver\Cas\Ticket\TicketFactory */
-    private $ticketFactory;
+    private TicketFactory $ticketFactory;
 
     /**
      * The ticket id doesn't match a ticket
diff --git a/lib/Shib13/AuthnResponse.php b/lib/Shib13/AuthnResponse.php
@@ -14,6 +14,7 @@
 use DOMNode;
 use DOMNodeList;
 use DOMXpath;
+use Exception;
 use SAML2\DOMDocumentFactory;
 use SimpleSAML\Configuration;
 use SimpleSAML\Error;
@@ -26,12 +27,12 @@ class AuthnResponse
     /**
      * @var \SimpleSAML\XML\Validator|null This variable contains an XML validator for this message.
      */
-    private $validator = null;
+    private ?Validator $validator = null;
 
     /**
      * @var bool Whether this response was validated by some external means (e.g. SSL).
      */
-    private $messageValidated = false;
+    private bool $messageValidated = false;
 
     /** @var string */
     public const SHIB_PROTOCOL_NS = 'urn:oasis:names:tc:SAML:1.0:protocol';
@@ -42,12 +43,12 @@ class AuthnResponse
     /**
      * @var \DOMDocument|null The DOMDocument which represents this message.
      */
-    private $dom = null;
+    private ?DOMDocument $dom = null;
 
     /**
      * @var string|null The relaystate which is associated with this response.
      */
-    private $relayState = null;
+    private ?string $relayState = null;
 
 
     /**
@@ -69,8 +70,8 @@ public function setXML(string $xml): void
     {
         try {
             $this->dom = DOMDocumentFactory::fromString(str_replace("\r", "", $xml));
-        } catch (\Exception $e) {
-            throw new \Exception('Unable to parse AuthnResponse XML.');
+        } catch (Exception $e) {
+            throw new Exception('Unable to parse AuthnResponse XML.');
         }
     }
 
@@ -237,7 +238,7 @@ public function getAttributes(): array
 
         foreach ($assertions as $assertion) {
             if (!$this->isNodeValidated($assertion)) {
-                throw new \Exception('Shib13 AuthnResponse contained an unsigned assertion.');
+                throw new Exception('Shib13 AuthnResponse contained an unsigned assertion.');
             }
 
             $conditions = $this->doXPathQuery('shib:Conditions', $assertion);
@@ -275,7 +276,7 @@ public function getAttributes(): array
                 }
 
                 if (empty($name)) {
-                    throw new \Exception('Shib13 Attribute node without an AttributeName.');
+                    throw new Exception('Shib13 Attribute node without an AttributeName.');
                 }
 
                 if (!array_key_exists($name, $attributes)) {
@@ -309,7 +310,7 @@ public function getIssuer(): string
         if ($attr = $nodelist->item(0)) {
             return $attr->value;
         } else {
-            throw new \Exception('Could not find Issuer field in Authentication response');
+            throw new Exception('Could not find Issuer field in Authentication response');
         }
     }
 
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 $projectRootDirectory = dirname(__DIR__);
 $projectConfigDirectory = $projectRootDirectory . '/tests/config';
 $casserverModulePath = $projectRootDirectory . '/vendor/simplesamlphp/simplesamlphp/modules/casserver';
diff --git a/tests/lib/AttributeExtractorTest.php b/tests/lib/AttributeExtractorTest.php
@@ -1,11 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Simplesamlphp\Casserver;
 
+use PHPUnit\Framework\TestCase;
 use SimpleSAML\Configuration;
 use SimpleSAML\Module\casserver\Cas\AttributeExtractor;
 
-class AttributeExtractorTest extends \PHPUnit\Framework\TestCase
+class AttributeExtractorTest extends TestCase
 {
     /**
      * Confirm behavior of a default configuration
diff --git a/tests/lib/Cas/Protocol/Cas20Test.php b/tests/lib/Cas/Protocol/Cas20Test.php
@@ -1,13 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Simplesamlphp\Casserver;
 
 use DOMDocument;
 use PHPUnit\Framework\TestCase;
 use SAML2\DOMDocumentFactory;
 use SimpleSAML\Configuration;
 use SimpleSAML\Module\casserver\Cas\Protocol\Cas20;
-//use SimpleSAML\XML\DOMDocumentFactory;
 
 final class Cas20Test extends TestCase
 {
diff --git a/tests/lib/Cas/Protocol/SamlValidateTest.php b/tests/lib/Cas/Protocol/SamlValidateTest.php
diff --git a/tests/lib/ServiceValidatorTest.php b/tests/lib/ServiceValidatorTest.php
diff --git a/tests/lib/Ticket/DelegatingTicketStoreTest.php b/tests/lib/Ticket/DelegatingTicketStoreTest.php
diff --git a/tests/lib/Ticket/ErroringTicketStore.php b/tests/lib/Ticket/ErroringTicketStore.php
diff --git a/tests/lib/TicketValidatorTest.php b/tests/lib/TicketValidatorTest.php
diff --git a/tests/www/LoginIntegrationTest.php b/tests/www/LoginIntegrationTest.php
diff --git a/tests/www/UtilsTest.php b/tests/www/UtilsTest.php
diff --git a/www/utility/urlUtils.php b/www/utility/urlUtils.php
diff --git a/www/utility/validateTicket.php b/www/utility/validateTicket.php

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@`
`21`	`21`	`*`
`22`	`22`	`*/`
`23`	`23`
	`24`	`+declare(strict_types=1);`
	`25`	`+`
`24`	`26`	`namespace SimpleSAML\Module\casserver\Cas\Protocol;`
`25`	`27`
`26`	`28`	`use SimpleSAML\Configuration;`