Skip to content

[MAINTENANCE] Maintenance in Helper class #1792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beatrycze-volk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[MAINTENANCE] Maintenance in Helper class #1792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 17 additions & 122 deletions Classes/Common/Helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,90 +133,6 @@ public static function addMessage(string $message, string $title, ContextualFeed
return $flashMessageQueue;
}

/**
* Check if given identifier is a valid identifier of the German National Library
*
* @access public
*
* @static
*
* @param string $id The identifier to check
* @param string $type What type is the identifier supposed to be? Possible values: PPN, IDN, PND, ZDB, SWD, GKD
*
* @return bool Is $id a valid GNL identifier of the given $type?
*/
public static function checkIdentifier(string $id, string $type): bool
{
$digits = substr($id, 0, 8);
$checksum = self::getChecksum($digits);
switch (strtoupper($type)) {
case 'PPN':
case 'IDN':
case 'PND':
if ($checksum == 10) {
$checksum = 'X';
}
if (!preg_match('/\d{8}[\dX]{1}/i', $id)) {
return false;
} elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
return false;
}
break;
case 'ZDB':
if ($checksum == 10) {
$checksum = 'X';
}
if (!preg_match('/\d{8}-[\dX]{1}/i', $id)) {
return false;
} elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
return false;
}
break;
case 'SWD':
$checksum = 11 - $checksum;
if (!preg_match('/\d{8}-\d{1}/i', $id)) {
return false;
} elseif ($checksum == 10) {
return self::checkIdentifier(((int) $digits + 1) . substr($id, -2, 2), 'SWD');
} elseif (substr($id, -1, 1) != $checksum) {
return false;
}
break;
case 'GKD':
$checksum = 11 - $checksum;
if ($checksum == 10) {
$checksum = 'X';
}
if (!preg_match('/\d{8}-[\dX]{1}/i', $id)) {
return false;
} elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
return false;
}
break;
}
return true;
}

/**
* Get checksum for given digits.
*
* @access private
*
* @static
*
* @param string $digits
*
* @return int
*/
private static function getChecksum(string $digits): int
{
$checksum = 0;
for ($i = 0, $j = strlen($digits); $i < $j; $i++) {
$checksum += (9 - $i) * (int) substr($digits, $i, 1);
}
return (11 - ($checksum % 11)) % 11;
}

/**
* Decrypt encrypted value with given control hash
*
Expand All @@ -226,9 +142,9 @@ private static function getChecksum(string $digits): int
*
* @param string $encrypted The encrypted value to decrypt
*
* @return mixed The decrypted value or false on error
* @return false|string The decrypted value or false on error
*/
public static function decrypt(string $encrypted)
public static function decrypt(string $encrypted): false|string
{
if (
!in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
Expand Down Expand Up @@ -269,7 +185,7 @@ public static function decrypt(string $encrypted)
*
* @return \SimpleXMLElement|false
*/
public static function getXmlFileAsString($content)
public static function getXmlFileAsString($content): \SimpleXMLElement|false
{
// Don't make simplexml_load_string throw (when $content is an array
// or object)
Expand Down Expand Up @@ -348,9 +264,9 @@ public static function error(string $message): void
*
* @param string $string The string to encrypt
*
* @return mixed Hashed string or false on error
* @return false|string Hashed string or false on error
*/
public static function digest(string $string)
public static function digest(string $string): false|string
{
if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
self::error('OpenSSL library doesn\'t support hash algorithm');
Expand All @@ -369,9 +285,9 @@ public static function digest(string $string)
*
* @param string $string The string to encrypt
*
* @return mixed Encrypted string or false on error
* @return false|string Encrypted string or false on error
*/
public static function encrypt(string $string)
public static function encrypt(string $string): false|string
{
if (
!in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
Expand All @@ -396,29 +312,6 @@ public static function encrypt(string $string)
return $encrypted;
}

/**
* Clean up a string to use in a URL.
*
* @access public
*
* @static
*
* @param string $string The string to clean up
*
* @return string The cleaned up string
*/
public static function getCleanString(string $string): string
{
// Convert to lowercase.
$string = strtolower($string);
// Remove non-alphanumeric characters.
$string = preg_replace('/[^a-z\d_\s-]/', '', $string);
// Remove multiple dashes or whitespaces.
$string = preg_replace('/[\s-]+/', ' ', $string);
// Convert whitespaces and underscore to dash.
return preg_replace('/[\s_]/', '-', $string);
}

/**
* Get the registered hook objects for a class
*
Expand Down Expand Up @@ -509,8 +402,10 @@ public static function getIndexNameFromUid(int $uid, string $table, int $pid = -
* @access public
*
* @static
*
* @return void
*/
public static function resetIndexNameCache()
public static function resetIndexNameCache(): void
{
self::$indexNameCache = [];
}
Expand Down Expand Up @@ -589,7 +484,7 @@ public static function getDocumentStructures(int $pid = -1): array
}

/**
* Determine whether or not $url is a valid URL using HTTP or HTTPS scheme.
* Determine whether $url is a valid URL using HTTP or HTTPS scheme.
*
* @access public
*
Expand Down Expand Up @@ -626,7 +521,7 @@ public static function isValidHttpUrl(string $url): bool
*
* @return array Array of substituted "NEW..." identifiers and their actual UIDs.
*/
public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], bool $reverseOrder = false, bool $cmdFirst = false): array
{
$context = GeneralUtility::makeInstance(Context::class);

Expand Down Expand Up @@ -783,7 +678,7 @@ public static function translate(string $indexName, string $table, string $pid):
->where(
$queryBuilder->expr()->eq($table . '.pid', $pid),
$queryBuilder->expr()->eq($table . '.uid', $row['l18n_parent']),
$queryBuilder->expr()->eq($table . '.sys_language_uid', (int) $languageContentId),
$queryBuilder->expr()->eq($table . '.sys_language_uid', $languageContentId),
self::whereExpression($table, true)
)
->setMaxResults(1)
Expand All @@ -806,7 +701,7 @@ public static function translate(string $indexName, string $table, string $pid):
$additionalWhere = $queryBuilder->expr()->and(
$queryBuilder->expr()->or(
$queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]),
$queryBuilder->expr()->eq($table . '.sys_language_uid', (int) $languageContentId)
$queryBuilder->expr()->eq($table . '.sys_language_uid', $languageContentId)
),
$queryBuilder->expr()->eq($table . '.l18n_parent', 0)
);
Expand Down Expand Up @@ -926,9 +821,9 @@ public static function getLanguageService(): LanguageService
*
* @param string $url
*
* @return string|bool
* @return bool|string
*/
public static function getUrl(string $url)
public static function getUrl(string $url): bool|string
{
if (!Helper::isValidHttpUrl($url)) {
return false;
Expand Down Expand Up @@ -1010,7 +905,7 @@ private static function getEncryptionKey(): ?string
*
* @return mixed
*/
private static function getLocalConfigurationByPath(string $path)
private static function getLocalConfigurationByPath(string $path): mixed
{
$configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);

Expand Down
Loading