mark nullable types explicitly (PHP 8.4 deprecation)

Author: codemasher

src/Authenticator.php

@@ -39,7 +39,7 @@ class Authenticator{
 	/**
 	 * Authenticator constructor
 	 */
-	public function __construct(SettingsContainerInterface $options = null, string $secret = null){
+	public function __construct(?SettingsContainerInterface $options = null, ?string $secret = null){
 		// phpcs:ignore
 		$this->setOptions($options ?? new AuthenticatorOptions);
 
@@ -95,7 +95,7 @@ public function getSecret():string{
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public function createSecret(int $length = null):string{
+	public function createSecret(?int $length = null):string{
 		return $this->authenticator->createSecret($length);
 	}
 
@@ -108,7 +108,7 @@ public function createSecret(int $length = null):string{
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public function code(int $data = null):string{
+	public function code(?int $data = null):string{
 		return $this->authenticator->code($data);
 	}
 
@@ -121,7 +121,7 @@ public function code(int $data = null):string{
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public function verify(string $otp, int $data = null):bool{
+	public function verify(string $otp, ?int $data = null):bool{
 		return $this->authenticator->verify($otp, $data);
 	}
 
@@ -132,7 +132,7 @@ public function verify(string $otp, int $data = null):bool{
 	 *
 	 * @throws \InvalidArgumentException
 	 */
-	public function getUri(string $label, string $issuer, int $hotpCounter = null, bool $omitSettings = null):string{
+	public function getUri(string $label, string $issuer, ?int $hotpCounter = null, ?bool $omitSettings = null):string{
 		$label  = trim($label);
 		$issuer = trim($issuer);
 

src/Authenticators/AuthenticatorAbstract.php

@@ -36,7 +36,7 @@ abstract class AuthenticatorAbstract implements AuthenticatorInterface{
 	/**
 	 * AuthenticatorInterface constructor
 	 */
-	public function __construct(SettingsContainerInterface $options = null){
+	public function __construct(?SettingsContainerInterface $options = null){
 		// phpcs:ignore
 		$this->setOptions($options ?? new AuthenticatorOptions);
 	}
@@ -74,7 +74,7 @@ public function getSecret():string{
 	/**
 	 * @inheritDoc
 	 */
-	public function createSecret(int $length = null):string{
+	public function createSecret(?int $length = null):string{
 		$length ??= $this->options->secret_length;
 
 		if($length < 16){

src/Authenticators/AuthenticatorInterface.php

@@ -62,7 +62,7 @@ public function getSecret():string;
 	 *
 	 * @throws \InvalidArgumentException
 	 */
-	public function createSecret(int $length = null):string;
+	public function createSecret(?int $length = null):string;
 
 	/**
 	 * Returns the current server time as UNIX timestamp for the given application (or `time()` if not applicable)
@@ -74,7 +74,7 @@ public function getServertime():int;
 	 *
 	 * @internal
 	 */
-	public function getCounter(int $data = null):int;
+	public function getCounter(?int $data = null):int;
 
 	/**
 	 * HMAC hashes the given $data integer with the given secret
@@ -104,7 +104,7 @@ public function getOTP(int $code):string;
 	 *  - a UNIX timestamp (TOTP)
 	 *  - a counter value (HOTP)
 	 */
-	public function code(int $data = null):string;
+	public function code(?int $data = null):string;
 
 	/**
 	 * Checks the given $code against the secret
@@ -113,6 +113,6 @@ public function code(int $data = null):string;
 	 *  - a UNIX timestamp (TOTP)
 	 *  - a counter value (HOTP)
 	 */
-	public function verify(string $otp, int $data = null):bool;
+	public function verify(string $otp, ?int $data = null):bool;
 
 }

src/Authenticators/HOTP.php

@@ -29,7 +29,7 @@ class HOTP extends AuthenticatorAbstract{
 	/**
 	 * @inheritDoc
 	 */
-	public function getCounter(int $data = null):int{
+	public function getCounter(?int $data = null):int{
 		return ($data ?? 0);
 	}
 
@@ -76,7 +76,7 @@ public function getOTP(int $code):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function code(int $data = null):string{
+	public function code(?int $data = null):string{
 		$hmac = $this->getHMAC($this->getCounter($data));
 
 		return $this->getOTP($this->getCode($hmac));
@@ -85,7 +85,7 @@ public function code(int $data = null):string{
 	/**
 	 * @inheritDoc
 	 */
-	public function verify(string $otp, int $data = null):bool{
+	public function verify(string $otp, ?int $data = null):bool{
 		return hash_equals($this->code($data), $otp);
 	}
 

src/Authenticators/SteamGuard.php

@@ -67,14 +67,14 @@ public function getSecret():string{
 	 * @inheritDoc
 	 * @codeCoverageIgnore
 	 */
-	public function createSecret(int $length = null):string{
+	public function createSecret(?int $length = null):string{
 		throw new RuntimeException('Not implemented');
 	}
 
 	/**
 	 * @inheritDoc
 	 */
-	public function getCounter(int $data = null):int{
+	public function getCounter(?int $data = null):int{
 		// the period is fixed to 30 seconds for Steam Guard
 		$this->options->period = 30;
 

src/Authenticators/TOTP.php

@@ -23,7 +23,7 @@ class TOTP extends HOTP{
 	/**
 	 * @inheritDoc
 	 */
-	public function getCounter(int $data = null):int{
+	public function getCounter(?int $data = null):int{
 		$data ??= time();
 
 		if($this->options->useLocalTime === false){
@@ -36,7 +36,7 @@ public function getCounter(int $data = null):int{
 	/**
 	 * @inheritDoc
 	 */
-	public function verify(string $otp, int $data = null):bool{
+	public function verify(string $otp, ?int $data = null):bool{
 		$limit = $this->options->adjacent;
 
 		if($limit === 0){

tests/AuthenticatorTest.php

@@ -32,7 +32,7 @@ protected function setUp():void{
 	}
 
 	public function testSetSecretViaConstruct():void{
-		$this->authenticator = new Authenticator(null, self::secret);
+		$this->authenticator = new Authenticator($this->options, self::secret);
 
 		$this::assertSame(self::secret, $this->authenticator->getSecret());
 	}