Doc types, param names (#9)

- Add variable to docblock otherwise it's ignored
- Replace a deprecated call
- Replace docblocks with type declarations
- Document `onBeforeDataWrite()` added by `SmartObject` due to `$onBeforeDataWrite`
- Rename parameters to what's used on the `SessionHandlerInterface` interface

Author: spaze

src/DI/MysqlSessionHandlerExtension.php

@@ -33,7 +33,7 @@ public function loadConfiguration(): void
 		$builder = $this->getContainerBuilder();
 
 		$definition = $builder->addDefinition($this->prefix('sessionHandler'))
-			->setClass('Spaze\Session\MysqlSessionHandler')
+			->setType('Spaze\Session\MysqlSessionHandler')
 			->addSetup('setTableName', [$this->config->tableName])
 			->addSetup('setLockTimeout', [$this->config->lockTimeout])
 			->addSetup('setUnchangedUpdateDelay', [$this->config->unchangedUpdateDelay]);
@@ -42,7 +42,7 @@ public function loadConfiguration(): void
 			$definition->addSetup('setEncryptionService', [$this->config->encryptionService]);
 		}
 
-		/** @var ServiceDefinition */
+		/** @var ServiceDefinition $sessionDefinition */
 		$sessionDefinition = $builder->getDefinition('session');
 		$sessionSetup = $sessionDefinition->getSetup();
 		# Prepend setHandler method to other possible setups (setExpiration) which would start session prematurely

src/MysqlSessionHandler.php

@@ -12,6 +12,8 @@
 /**
  * Storing session to database.
  * Inspired by: https://github.com/JedenWeb/SessionStorage/
+ *
+ * @method onBeforeDataWrite()
  */
 class MysqlSessionHandler implements SessionHandlerInterface
 {
@@ -46,7 +48,7 @@ class MysqlSessionHandler implements SessionHandlerInterface
 	 *
 	 * @var callable[] function ()
 	 */
-	public $onBeforeDataWrite;
+	public array $onBeforeDataWrite;
 
 
 	public function __construct(
@@ -79,11 +81,7 @@ public function setEncryptionService(StaticKeyEncryption $encryptionService): vo
 	}
 
 
-	/**
-	 * @param string $key
-	 * @param mixed $value
-	 */
-	public function setAdditionalData(string $key, $value): void
+	public function setAdditionalData(string $key, mixed $value): void
 	{
 		$this->additionalData[$key] = $value;
 	}
@@ -121,12 +119,7 @@ private function unlock(): void
 	}
 
 
-	/**
-	 * @param string $savePath
-	 * @param string $name
-	 * @return bool
-	 */
-	public function open($savePath, $name): bool
+	public function open(string $path, string $name): bool
 	{
 		$this->lock();
 		return true;
@@ -140,64 +133,51 @@ public function close(): bool
 	}
 
 
-	/**
-	 * @param string $sessionId
-	 * @return bool
-	 */
-	public function destroy($sessionId): bool
+	public function destroy(string $id): bool
 	{
-		$hashedSessionId = $this->hash($sessionId);
+		$hashedSessionId = $this->hash($id);
 		$this->explorer->table($this->tableName)->where('id', $hashedSessionId)->delete();
 		$this->unlock();
 		return true;
 	}
 
 
-	/**
-	 * @param string $sessionId
-	 * @return string
-	 */
-	public function read($sessionId): string
+	public function read(string $id): string
 	{
 		$this->lock();
-		$hashedSessionId = $this->hash($sessionId);
+		$hashedSessionId = $this->hash($id);
 		$this->row = $this->explorer->table($this->tableName)->get($hashedSessionId);
 
 		if ($this->row) {
-			$this->data[$sessionId] = ($this->encryptionService ? $this->encryptionService->decrypt($this->row->data) : $this->row->data);
-			return $this->data[$sessionId];
+			$this->data[$id] = ($this->encryptionService ? $this->encryptionService->decrypt($this->row->data) : $this->row->data);
+			return $this->data[$id];
 		}
 		return '';
 	}
 
 
-	/**
-	 * @param string $sessionId
-	 * @param string $sessionData
-	 * @return bool
-	 */
-	public function write($sessionId, $sessionData): bool
+	public function write(string $id, string $data): bool
 	{
 		$this->lock();
-		$hashedSessionId = $this->hash($sessionId);
+		$hashedSessionId = $this->hash($id);
 		$time = \time();
 
-		if (!isset($this->data[$sessionId]) || $this->data[$sessionId] !== $sessionData) {
+		if (!isset($this->data[$id]) || $this->data[$id] !== $data) {
 			if ($this->encryptionService) {
-				$sessionData = $this->encryptionService->encrypt($sessionData);
+				$data = $this->encryptionService->encrypt($data);
 			}
 			$this->onBeforeDataWrite();
 			$row = $this->explorer->table($this->tableName)->get($hashedSessionId);
 			if ($row) {
 				$row->update([
 					'timestamp' => $time,
-					'data' => $sessionData,
+					'data' => $data,
 				] + $this->additionalData);
 			} else {
 				$this->explorer->table($this->tableName)->insert([
 					'id' => $hashedSessionId,
 					'timestamp' => $time,
-					'data' => $sessionData,
+					'data' => $data,
 				] + $this->additionalData);
 			}
 		} elseif ($this->row && ($this->unchangedUpdateDelay === 0 || $time - $this->row->timestamp > $this->unchangedUpdateDelay)) {
@@ -212,9 +192,9 @@ public function write($sessionId, $sessionData): bool
 	}
 
 
-	public function gc(int $maxLifeTime): int|false
+	public function gc(int $max_lifetime): int|false
 	{
-		$maxTimestamp = \time() - $maxLifeTime;
+		$maxTimestamp = \time() - $max_lifetime;
 
 		// Try to avoid a conflict when running garbage collection simultaneously on two
 		// MySQL servers at a very busy site in a master-master replication setup by
@@ -226,7 +206,7 @@ public function gc(int $maxLifeTime): int|false
 		// subtraction on server 2.
 		$row = $this->explorer->query('SELECT @@server_id as `serverId`')->fetch();
 		if ($row && $row->serverId > 1 && $row->serverId < 10) {
-			$maxTimestamp -= ($row->serverId - 1) * \max(86400, $maxLifeTime / 10);
+			$maxTimestamp -= ($row->serverId - 1) * \max(86400, $max_lifetime / 10);
 		}
 
 		return $this->explorer->table($this->tableName)