improved phpDoc

Author: dg

src/Bridges/CacheLatte/Runtime.php

@@ -45,6 +45,7 @@ public function initialize(Latte\Runtime\Template $template): void
 
 	/**
 	 * Starts the output cache. Returns true if buffering was started.
+	 * @param array<string, mixed>|null $args {if?: bool, tags?: string[], expire?: string, expiration?: string, dependencies?: callable}
 	 */
 	public function createCache(string $key, ?array $args = null): bool
 	{

src/Bridges/Psr/PsrCacheAdapter.php

@@ -81,6 +81,7 @@ public function setMultiple(iterable $values, null|int|DateInterval $ttl = null)
 	}
 
 
+	/** @param  iterable<string>  $keys */
 	public function deleteMultiple(iterable $keys): bool
 	{
 		foreach ($keys as $value) {

src/Caching/BulkReader.php

@@ -17,7 +17,8 @@ interface BulkReader
 {
 	/**
 	 * Reads from cache in bulk.
-	 * @return array key => value pairs, missing items are omitted
+	 * @param  string[] $keys
+	 * @return array<string, mixed>  key => value pairs, missing items are omitted
 	 */
 	function bulkRead(array $keys): array;
 }

src/Caching/BulkWriter.php

@@ -17,12 +17,14 @@ interface BulkWriter
 {
 	/**
 	 * Writes to cache in bulk.
-	 * @param array{string, mixed} $items
+	 * @param  array<string, mixed>  $items
+	 * @param  array<string, mixed>  $dependencies
 	 */
 	function bulkWrite(array $items, array $dependencies): void;
 
 	/**
-	 * Removes multiple items from cache
+	 * Removes multiple items from cache.
+	 * @param  string[]  $keys
 	 */
 	function bulkRemove(array $keys): void;
 }

src/Caching/OutputHelper.php

@@ -17,6 +17,7 @@
  */
 class OutputHelper
 {
+	/** @var array<string, mixed> */
 	public array $dependencies = [];
 
 
@@ -30,6 +31,7 @@ public function __construct(
 
 	/**
 	 * Stops and saves the cache.
+	 * @param  array<string, mixed>  $dependencies
 	 */
 	public function end(array $dependencies = []): void
 	{

src/Caching/Storage.php

@@ -28,6 +28,7 @@ function lock(string $key): void;
 
 	/**
 	 * Writes item into the cache.
+	 * @param  array<string, mixed>  $dependencies
 	 */
 	function write(string $key, $data, array $dependencies): void;
 
@@ -38,6 +39,7 @@ function remove(string $key): void;
 
 	/**
 	 * Removes items from the cache by conditions.
+	 * @param  array<string, mixed>  $conditions
 	 */
 	function clean(array $conditions): void;
 }

src/Caching/Storages/FileStorage.php

@@ -52,6 +52,8 @@ class FileStorage implements Nette\Caching\Storage
 
 	private string $dir;
 	private ?Journal $journal;
+
+	/** @var array<string, resource>  key => file handle */
 	private array $locks;
 
 
@@ -136,6 +138,7 @@ public function lock(string $key): void
 	}
 
 
+	/** @param  array<string, mixed>  $dp */
 	public function write(string $key, $data, array $dp): void
 	{
 		$meta = [
@@ -224,6 +227,7 @@ public function remove(string $key): void
 	}
 
 
+	/** @param  array<string, mixed>  $conditions */
 	public function clean(array $conditions): void
 	{
 		$all = !empty($conditions[Cache::All]);
@@ -293,6 +297,7 @@ public function clean(array $conditions): void
 
 	/**
 	 * Reads cache data from disk.
+	 * @return array<string, mixed>|null  meta data with 'file' and 'handle' keys added, or null if not found
 	 */
 	protected function readMetaAndLock(string $file, int $lock): ?array
 	{

src/Caching/Storages/Journal.php

@@ -17,12 +17,14 @@ interface Journal
 {
 	/**
 	 * Writes entry information into the journal.
+	 * @param  array<string, mixed>  $dependencies  {Cache::Tags => string[], Cache::Priority => int}
 	 */
 	function write(string $key, array $dependencies): void;
 
 	/**
 	 * Cleans entries from journal.
-	 * @return array|null of removed items or null when performing a full cleanup
+	 * @param  array<string, mixed>  $conditions  {Cache::Tags => string[], Cache::Priority => int, Cache::All => bool}
+	 * @return string[]|null  array of removed keys or null when performing a full cleanup
 	 */
 	function clean(array $conditions): ?array;
 }

src/Caching/Storages/MemoryStorage.php

@@ -17,6 +17,7 @@
  */
 class MemoryStorage implements Nette\Caching\Storage
 {
+	/** @var array<string, mixed>  key => cached value */
 	private array $data = [];