📖

Author: codemasher

src/Crypto.php

@@ -64,7 +64,10 @@ public static function sha512(string $data, bool $binary = false):string{
 	}
 
 	/**
-	 * Generates a secure random string of the given $length, using the characters (8-bit byte) in the given $keyspace.
+	 * Generates a secure random string of the given `$length`, using the characters (8-bit byte) in the given `$keyspace`.
+	 *
+	 * @see \random_int() - PHP <= 8.2
+	 * @see \Random\Randomizer - PHP >= 8.3
 	 *
 	 * @noinspection PhpFullyQualifiedNameUsageInspection
 	 * @SuppressWarnings(PHPMD.MissingImport)
@@ -88,7 +91,10 @@ public static function randomString(int $length, string $keyspace = self::ASCII_
 	}
 
 	/**
-	 * Creates a new cryptographically secure random encryption key (returned in hexadecimal format)
+	 * Creates a new cryptographically secure random encryption key for use with `encrypt()` and `decrypt()` (returned in hexadecimal format)
+	 *
+	 * @see \sodium_crypto_secretbox_keygen()
+	 * @see \sodium_crypto_secretbox())
 	 *
 	 * @throws \SodiumException
 	 */
@@ -97,7 +103,7 @@ public static function createEncryptionKey():string{
 	}
 
 	/**
-	 * Encrypts the given $data with $key, $format output [binary, base64, hex]
+	 * Encrypts the given `$data` with `$key`, formats the output according to `$format` [binary, base64, hex]
 	 *
 	 * @see \sodium_crypto_secretbox()
 	 * @see \sodium_bin2base64()
@@ -125,7 +131,7 @@ public static function encrypt(string $data, string $keyHex, int $format = self:
 	}
 
 	/**
-	 * Decrypts the given $encrypted data with $key from $format input [binary, base64, hex]
+	 * Decrypts the given `$encrypted` data with `$key` from input formatted according to `$format` [binary, base64, hex]
 	 *
 	 * @see \sodium_crypto_secretbox_open()
 	 * @see \sodium_base642bin()

src/Directory.php

@@ -29,17 +29,29 @@
  */
 final class Directory{
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether a directory exists
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function exists(string $dir):bool{
 		return file_exists($dir) && is_dir($dir);
 	}
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether the given directory is readable
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function isReadable(string $dir):bool{
 		return self::exists($dir) && is_readable($dir);
 	}
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether the given directory is writable
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function isWritable(string $dir):bool{
 		return self::exists($dir) && is_writable($dir);
 	}

src/File.php

@@ -28,17 +28,29 @@
  */
 final class File{
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether a file exists
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function exists(string $file):bool{
 		return file_exists($file) && is_file($file);
 	}
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether the given file is readable
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function isReadable(string $file):bool{
 		return self::exists($file) && is_readable($file);
 	}
 
-	/** @codeCoverageIgnore */
+	/**
+	 * Checks whether the given file is writable
+	 *
+	 * @codeCoverageIgnore
+	 */
 	public static function isWritable(string $file):bool{
 		return self::exists($file) && is_writable($file);
 	}

src/Str.php

@@ -39,7 +39,6 @@ final class Str{
 	/**
 	 * Filters an array and removes all elements that are not strings. Array keys are *not* retained.
 	 *
-	 *
 	 * @see array_filter()
 	 * @see array_values()
 	 * @see is_string()

tests/StrTest.php

@@ -33,6 +33,9 @@ public static function startsWithProvider():array{
 		];
 	}
 
+	/**
+	 * @param string[] $needles
+	 */
 	#[Test]
 	#[DataProvider('startsWithProvider')]
 	public function startsWith(array $needles, bool $ignoreCase, bool $expected):void{
@@ -52,6 +55,9 @@ public static function containsAllProvider():array{
 		];
 	}
 
+	/**
+	 * @param string[] $needles
+	 */
 	#[Test]
 	#[DataProvider('containsAllProvider')]
 	public function containsAll(array $needles, bool $ignoreCase, bool $expected):void{
@@ -71,11 +77,13 @@ public static function containsAnyProvider():array{
 		];
 	}
 
+	/**
+	 * @param string[] $needles
+	 */
 	#[Test]
 	#[DataProvider('containsAnyProvider')]
 	public function containsAny(array $needles, bool $ignoreCase, bool $expected):void{
 		$this::assertSame(Str::containsAny('Hello world!', $needles, $ignoreCase), $expected);
 	}
 
-
 }