experiment: add return types to a unit test facility

This commit is contained in:
El RIDO 2024-10-25 07:09:13 +02:00
parent e468f07626
commit 0268e01ab5

View File

@ -116,7 +116,7 @@ class Helper
* *
* @return string * @return string
*/ */
public static function getPasteId() public static function getPasteId(): string
{ {
return self::$pasteid; return self::$pasteid;
} }
@ -128,7 +128,7 @@ class Helper
* @param array $meta * @param array $meta
* @return array * @return array
*/ */
public static function getPaste($version = 2, array $meta = array()) public static function getPaste($version = 2, array $meta = array()): array
{ {
$example = self::getPasteWithAttachment($version, $meta); $example = self::getPasteWithAttachment($version, $meta);
// v1 has the attachment stored in a separate property // v1 has the attachment stored in a separate property
@ -145,7 +145,7 @@ class Helper
* @param array $meta * @param array $meta
* @return array * @return array
*/ */
public static function getPasteWithAttachment($version = 2, array $meta = array()) public static function getPasteWithAttachment($version = 2, array $meta = array()): array
{ {
$example = $version === 1 ? self::$pasteV1 : self::$pasteV2; $example = $version === 1 ? self::$pasteV1 : self::$pasteV2;
$example['meta']['salt'] = ServerSalt::generate(); $example['meta']['salt'] = ServerSalt::generate();
@ -160,7 +160,7 @@ class Helper
* @param array $meta * @param array $meta
* @return array * @return array
*/ */
public static function getPastePost($version = 2, array $meta = array()) public static function getPastePost($version = 2, array $meta = array()): array
{ {
$example = self::getPaste($version, $meta); $example = self::getPaste($version, $meta);
if ($version == 2) { if ($version == 2) {
@ -176,9 +176,9 @@ class Helper
* *
* @param int $version * @param int $version
* @param array $meta * @param array $meta
* @return array * @return string
*/ */
public static function getPasteJson($version = 2, array $meta = array()) public static function getPasteJson($version = 2, array $meta = array()): string
{ {
return json_encode(self::getPastePost($version, $meta)); return json_encode(self::getPastePost($version, $meta));
} }
@ -188,7 +188,7 @@ class Helper
* *
* @return string * @return string
*/ */
public static function getCommentId() public static function getCommentId(): string
{ {
return self::$commentid; return self::$commentid;
} }
@ -200,7 +200,7 @@ class Helper
* @param array $meta * @param array $meta
* @return array * @return array
*/ */
public static function getComment($version = 2, array $meta = array()) public static function getComment($version = 2, array $meta = array()): array
{ {
$example = $version === 1 ? self::$commentV1 : self::$pasteV2; $example = $version === 1 ? self::$commentV1 : self::$pasteV2;
if ($version === 2) { if ($version === 2) {
@ -220,7 +220,7 @@ class Helper
* @param int $version * @param int $version
* @return array * @return array
*/ */
public static function getCommentPost() public static function getCommentPost(): array
{ {
$example = self::getComment(); $example = self::getComment();
unset($example['meta']); unset($example['meta']);
@ -231,9 +231,9 @@ class Helper
* get example comment, as received via POST by user * get example comment, as received via POST by user
* *
* @param int $version * @param int $version
* @return array * @return string
*/ */
public static function getCommentJson() public static function getCommentJson(): string
{ {
return json_encode(self::getCommentPost()); return json_encode(self::getCommentPost());
} }
@ -243,7 +243,7 @@ class Helper
* *
* @return string * @return string
*/ */
public static function getRandomId() public static function getRandomId(): string
{ {
// 8 binary bytes are 16 characters long in hex // 8 binary bytes are 16 characters long in hex
return bin2hex(random_bytes(8)); return bin2hex(random_bytes(8));
@ -254,8 +254,9 @@ class Helper
* *
* @param string $path * @param string $path
* @throws Exception * @throws Exception
* @return void
*/ */
public static function rmDir($path) public static function rmDir($path): void
{ {
if (is_dir($path)) { if (is_dir($path)) {
$path .= DIRECTORY_SEPARATOR; $path .= DIRECTORY_SEPARATOR;
@ -283,7 +284,7 @@ class Helper
* *
* @return void * @return void
*/ */
public static function confBackup() public static function confBackup(): void
{ {
if (!is_file(CONF . '.bak') && is_file(CONF)) { if (!is_file(CONF . '.bak') && is_file(CONF)) {
rename(CONF, CONF . '.bak'); rename(CONF, CONF . '.bak');
@ -298,7 +299,7 @@ class Helper
* *
* @return void * @return void
*/ */
public static function confRestore() public static function confRestore(): void
{ {
if (is_file(CONF . '.bak')) { if (is_file(CONF . '.bak')) {
rename(CONF . '.bak', CONF); rename(CONF . '.bak', CONF);
@ -314,7 +315,7 @@ class Helper
* @param string $pathToFile * @param string $pathToFile
* @param array $values * @param array $values
*/ */
public static function createIniFile($pathToFile, array $values) public static function createIniFile($pathToFile, array $values): void
{ {
if (count($values)) { if (count($values)) {
@unlink($pathToFile); @unlink($pathToFile);
@ -357,7 +358,7 @@ class Helper
* @param bool $return * @param bool $return
* @return void|string * @return void|string
*/ */
public static function varExportMin($var, $return = false) public static function varExportMin($var, $return = false): string
{ {
if (is_array($var)) { if (is_array($var)) {
$toImplode = array(); $toImplode = array();
@ -380,7 +381,7 @@ class Helper
* *
* @return void * @return void
*/ */
public static function updateSubresourceIntegrity() public static function updateSubresourceIntegrity(): void
{ {
foreach (new GlobIterator(PATH . 'js' . DIRECTORY_SEPARATOR . '*.js') as $file) { foreach (new GlobIterator(PATH . 'js' . DIRECTORY_SEPARATOR . '*.js') as $file) {
if ($file->getBasename() == 'common.js') { if ($file->getBasename() == 'common.js') {