Erikmitk / kitodo-presentation

Classes/Common/Helper.php

Spacing +49 added lines, -49 removed lines

@@ -136,7 +136,7 @@ 
                 if (!preg_match('/[0-9]{8}-[0-9]{1}/i', $id)) {
                     return false;
                 } elseif ($checksum == 10) {
-                    return self::checkIdentifier(($digits + 1) . substr($id, -2, 2), 'SWD');
+                    return self::checkIdentifier(($digits + 1).substr($id, -2, 2), 'SWD');
                 } elseif (substr($id, -1, 1) != $checksum) {
                     return false;
                 }
@@ -278,7 +278,7 @@ 
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialisation vector and encrypted data.
         if ($encrypted !== false) {
-            $encrypted = base64_encode($iv . $encrypted);
+            $encrypted = base64_encode($iv.$encrypted);
         }
         return $encrypted;
     }
@@ -332,8 +332,8 @@ 
     public static function getHookObjects($scriptRelPath)
     {
         $hookObjects = [];
-        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
-            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
+        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey.'/'.$scriptRelPath]['hookClass'])) {
+            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey.'/'.$scriptRelPath]['hookClass'] as $classRef) {
                 $hookObjects[] = GeneralUtility::makeInstance($classRef);
             }
         }
@@ -359,7 +359,7 @@ 
             !$uid
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::log('Invalid UID "' . $uid . '" or table "' . $table . '"', LOG_SEVERITY_ERROR);
+            self::log('Invalid UID "'.$uid.'" or table "'.$table.'"', LOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -370,15 +370,15 @@ 
         // Should we check for a specific PID, too?
         if ($pid !== -1) {
             $pid = max(intval($pid), 0);
-            $where = $queryBuilder->expr()->eq($table . '.pid', $pid);
+            $where = $queryBuilder->expr()->eq($table.'.pid', $pid);
         }
 
         // Get index_name from database.
         $result = $queryBuilder
-            ->select($table . '.index_name AS index_name')
+            ->select($table.'.index_name AS index_name')
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.uid', $uid),
+                $queryBuilder->expr()->eq($table.'.uid', $uid),
                 $where,
                 self::whereExpression($table)
             )
@@ -388,7 +388,7 @@ 
         if ($resArray = $result->fetch()) {
             return $resArray['index_name'];
         } else {
-            self::log('No "index_name" with UID ' . $uid . ' and PID ' . $pid . ' found in table "' . $table . '"', LOG_SEVERITY_WARNING);
+            self::log('No "index_name" with UID '.$uid.' and PID '.$pid.' found in table "'.$table.'"', LOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -412,7 +412,7 @@ 
             !$uid
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::log('Invalid UID "' . $uid . '" or table "' . $table . '"', LOG_SEVERITY_ERROR);
+            self::log('Invalid UID "'.$uid.'" or table "'.$table.'"', LOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -423,15 +423,15 @@ 
         // Should we check for a specific PID, too?
         if ($pid !== -1) {
             $pid = max(intval($pid), 0);
-            $where = $queryBuilder->expr()->eq($table . '.pid', $pid);
+            $where = $queryBuilder->expr()->eq($table.'.pid', $pid);
         }
 
         // Get label from database.
         $result = $queryBuilder
-            ->select($table . '.label AS label')
+            ->select($table.'.label AS label')
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.uid', $uid),
+                $queryBuilder->expr()->eq($table.'.uid', $uid),
                 $where,
                 self::whereExpression($table)
             )
@@ -441,7 +441,7 @@ 
         if ($resArray = $result->fetch()) {
             return $resArray['label'];
         } else {
-            self::log('No "label" with UID ' . $uid . ' and PID ' . $pid . ' found in table "' . $table . '"', LOG_SEVERITY_WARNING);
+            self::log('No "label" with UID '.$uid.' and PID '.$pid.' found in table "'.$table.'"', LOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -460,9 +460,9 @@ 
         // Analyze code and set appropriate ISO table.
         $isoCode = strtolower(trim($code));
         if (preg_match('/^[a-z]{3}$/', $isoCode)) {
-            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey) . 'Resources/Private/Data/iso-639-2b.xml';
+            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey).'Resources/Private/Data/iso-639-2b.xml';
         } elseif (preg_match('/^[a-z]{2}$/', $isoCode)) {
-            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey) . 'Resources/Private/Data/iso-639-1.xml';
+            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey).'Resources/Private/Data/iso-639-1.xml';
         } else {
             // No ISO code, return unchanged.
             return $code;
@@ -479,13 +479,13 @@ 
                 $lang = $GLOBALS['LANG']->getLLL($isoCode, $iso639);
             }
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return $code;
         }
         if (!empty($lang)) {
             return $lang;
         } else {
-            self::log('Language code "' . $code . '" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
+            self::log('Language code "'.$code.'" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
             return $code;
         }
     }
@@ -513,7 +513,7 @@ 
             } elseif (\TYPO3_MODE === 'BE') {
                 self::$messages = $GLOBALS['LANG']->includeLLFile($file, false, true);
             } else {
-                self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+                self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             }
         }
         // Get translation.
@@ -523,7 +523,7 @@ 
             } elseif (\TYPO3_MODE === 'BE') {
                 $translated = $GLOBALS['LANG']->getLLL($key, self::$messages);
             } else {
-                self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+                self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             }
         }
         // Escape HTML characters if applicable.
@@ -550,7 +550,7 @@ 
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::log('Invalid UID ' . $index_name . ' or table "' . $table . '"', LOG_SEVERITY_ERROR);
+            self::log('Invalid UID '.$index_name.' or table "'.$table.'"', LOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -561,14 +561,14 @@ 
         // Should we check for a specific PID, too?
         if ($pid !== -1) {
             $pid = max(intval($pid), 0);
-            $where = $queryBuilder->expr()->eq($table . '.pid', $pid);
+            $where = $queryBuilder->expr()->eq($table.'.pid', $pid);
         }
         // Get index_name from database.
         $result = $queryBuilder
-            ->select($table . '.uid AS uid')
+            ->select($table.'.uid AS uid')
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
+                $queryBuilder->expr()->eq($table.'.index_name', $queryBuilder->expr()->literal($index_name)),
                 $where,
                 self::whereExpression($table)
             )
@@ -580,7 +580,7 @@ 
         if (count($allResults) == 1) {
             return $allResults[0]['uid'];
         } else {
-            self::log('No UID for given index_name "' . $index_name . '" and PID ' . $pid . ' found in table "' . $table . '"', LOG_SEVERITY_WARNING);
+            self::log('No UID for given index_name "'.$index_name.'" and PID '.$pid.' found in table "'.$table.'"', LOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -638,7 +638,7 @@ 
             '-' => 39,
             ':' => 17,
         ];
-        $urn = strtolower($base . $id);
+        $urn = strtolower($base.$id);
         if (preg_match('/[^a-z0-9:-]/', $urn)) {
             self::log('Invalid chars in given parameters', LOG_SEVERITY_WARNING);
             return '';
@@ -652,7 +652,7 @@ 
             $checksum += ($i + 1) * intval(substr($digits, $i, 1));
         }
         $checksum = substr(intval($checksum / intval(substr($digits, -1, 1))), -1, 1);
-        return $base . $id . $checksum;
+        return $base.$id.$checksum;
     }
 
     /**
@@ -683,7 +683,7 @@ 
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
-            self::log('Invalid key "' . $key . '" for session data retrieval', LOG_SEVERITY_WARNING);
+            self::log('Invalid key "'.$key.'" for session data retrieval', LOG_SEVERITY_WARNING);
             return;
         }
         // Get the session data.
@@ -692,7 +692,7 @@ 
         } elseif (\TYPO3_MODE === 'BE') {
             return $GLOBALS['BE_USER']->getSessionData($key);
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return;
         }
     }
@@ -801,7 +801,7 @@ 
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
-            self::log('Invalid key "' . $key . '" for session data saving', LOG_SEVERITY_WARNING);
+            self::log('Invalid key "'.$key.'" for session data saving', LOG_SEVERITY_WARNING);
             return false;
         }
         // Save value in session data.
@@ -813,7 +813,7 @@ 
             $GLOBALS['BE_USER']->setAndSaveSessionData($key, $value);
             return true;
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return false;
         }
     }
@@ -836,7 +836,7 @@ 
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
-            self::log('Invalid PID ' . $pid . ' for translation', LOG_SEVERITY_WARNING);
+            self::log('Invalid PID '.$pid.' for translation', LOG_SEVERITY_WARNING);
             return $index_name;
         }
         // Check if "index_name" is an UID.
@@ -853,13 +853,13 @@ 
         // First fetch the uid of the received index_name
         $result = $queryBuilder
             ->select(
-                $table . '.uid AS uid',
-                $table . '.l18n_parent AS l18n_parent'
+                $table.'.uid AS uid',
+                $table.'.l18n_parent AS l18n_parent'
             )
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.pid', $pid),
-                $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
+                $queryBuilder->expr()->eq($table.'.pid', $pid),
+                $queryBuilder->expr()->eq($table.'.index_name', $queryBuilder->expr()->literal($index_name)),
                 self::whereExpression($table, true)
             )
             ->setMaxResults(1)
@@ -872,12 +872,12 @@ 
             $resArray = $allResults[0];
 
             $result = $queryBuilder
-                ->select($table . '.index_name AS index_name')
+                ->select($table.'.index_name AS index_name')
                 ->from($table)
                 ->where(
-                    $queryBuilder->expr()->eq($table . '.pid', $pid),
-                    $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
-                    $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content)),
+                    $queryBuilder->expr()->eq($table.'.pid', $pid),
+                    $queryBuilder->expr()->eq($table.'.uid', $resArray['l18n_parent']),
+                    $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content)),
                     self::whereExpression($table, true)
                 )
                 ->setMaxResults(1)
@@ -895,14 +895,14 @@ 
         if (empty($labels[$table][$pid][$GLOBALS['TSFE']->sys_language_content][$index_name])) {
             // Check if this table is allowed for translation.
             if (in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures'])) {
-                $additionalWhere = $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]);
+                $additionalWhere = $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]);
                 if ($GLOBALS['TSFE']->sys_language_content > 0) {
                     $additionalWhere = $queryBuilder->expr()->andX(
                         $queryBuilder->expr()->orX(
-                            $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]),
-                            $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content))
+                            $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]),
+                            $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content))
                         ),
-                        $queryBuilder->expr()->eq($table . '.l18n_parent', 0)
+                        $queryBuilder->expr()->eq($table.'.l18n_parent', 0)
                     );
                 }
 
@@ -911,7 +911,7 @@ 
                     ->select('*')
                     ->from($table)
                     ->where(
-                        $queryBuilder->expr()->eq($table . '.pid', $pid),
+                        $queryBuilder->expr()->eq($table.'.pid', $pid),
                         $additionalWhere,
                         self::whereExpression($table, true)
                     )
@@ -929,10 +929,10 @@ 
                         }
                     }
                 } else {
-                    self::log('No translation with PID ' . $pid . ' available in table "' . $table . '" or translation not accessible', LOG_SEVERITY_NOTICE);
+                    self::log('No translation with PID '.$pid.' available in table "'.$table.'" or translation not accessible', LOG_SEVERITY_NOTICE);
                 }
             } else {
-                self::log('No translations available for table "' . $table . '"', LOG_SEVERITY_WARNING);
+                self::log('No translations available for table "'.$table.'"', LOG_SEVERITY_WARNING);
             }
         }
 
@@ -971,9 +971,9 @@ 
             return GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable($table)
                 ->expr()
-                ->eq($table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'], 0);
+                ->eq($table.'.'.$GLOBALS['TCA'][$table]['ctrl']['delete'], 0);
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return '1=-1';
         }
     }

Upper-Lower-Casing +40 added lines, -40 removed lines

@@ -74,7 +74,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
+    public static function addMessage($message, $title, $severity, $session = FALSE, $queue = 'kitodo.default.flashMessages')
     {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
@@ -116,9 +116,9 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'ZDB':
@@ -126,19 +126,19 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}-[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'SWD':
                 $checksum = 11 - $checksum;
                 if (!preg_match('/[0-9]{8}-[0-9]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif ($checksum == 10) {
                     return self::checkIdentifier(($digits + 1) . substr($id, -2, 2), 'SWD');
                 } elseif (substr($id, -1, 1) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'GKD':
@@ -147,13 +147,13 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}-[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -168,28 +168,28 @@ 
     public static function decrypt($encrypted)
     {
         if (
-            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
-            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
+            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(TRUE))
+            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))
         ) {
             self::log('OpenSSL library doesn\'t support cipher and/or hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::log('No encryption key set in TYPO3 configuration', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (
             empty($encrypted)
             || strlen($encrypted) < openssl_cipher_iv_length(self::$cipherAlgorithm)
         ) {
             self::log('Invalid parameters given for decryption', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Split initialisation vector and encrypted data.
         $binary = base64_decode($encrypted);
         $iv = substr($binary, 0, openssl_cipher_iv_length(self::$cipherAlgorithm));
         $data = substr($binary, openssl_cipher_iv_length(self::$cipherAlgorithm));
-        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, true);
+        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, TRUE);
         // Decrypt data.
         $decrypted = openssl_decrypt($data, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         return $decrypted;
@@ -207,9 +207,9 @@ 
     public static function getXmlFileAsString($content)
     {
         // Turn off libxml's error logging.
-        $libxmlErrors = libxml_use_internal_errors(true);
+        $libxmlErrors = libxml_use_internal_errors(TRUE);
         // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
-        $previousValueOfEntityLoader = libxml_disable_entity_loader(true);
+        $previousValueOfEntityLoader = libxml_disable_entity_loader(TRUE);
         // Try to load XML from file.
         $xml = simplexml_load_string($content);
         // reset entity loader setting
@@ -264,9 +264,9 @@ 
      */
     public static function digest($string)
     {
-        if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
+        if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Hash string.
         $hashed = openssl_digest($string, self::$hashAlgorithm);
@@ -285,23 +285,23 @@ 
     public static function encrypt($string)
     {
         if (
-            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
-            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
+            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(TRUE))
+            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))
         ) {
             self::log('OpenSSL library doesn\'t support cipher and/or hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::log('No encryption key set in TYPO3 configuration', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Generate random initialisation vector.
         $iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length(self::$cipherAlgorithm));
-        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, true);
+        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, TRUE);
         // Encrypt data.
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialisation vector and encrypted data.
-        if ($encrypted !== false) {
+        if ($encrypted !== FALSE) {
             $encrypted = base64_encode($iv . $encrypted);
         }
         return $encrypted;
@@ -498,7 +498,7 @@ 
                 $lang = $GLOBALS['TSFE']->getLLL($isoCode, $iso639);
             }
         } elseif (\TYPO3_MODE === 'BE') {
-            $iso639 = $GLOBALS['LANG']->includeLLFile($file, false, true);
+            $iso639 = $GLOBALS['LANG']->includeLLFile($file, FALSE, TRUE);
             if (!empty($iso639['default'][$isoCode])) {
                 $lang = $GLOBALS['LANG']->getLLL($isoCode, $iso639);
             }
@@ -525,7 +525,7 @@ 
      *
      * @return string The translated string or the given key on failure
      */
-    public static function getMessage($key, $hsc = false, $default = '')
+    public static function getMessage($key, $hsc = FALSE, $default = '')
     {
         // Set initial output to default value.
         $translated = (string) $default;
@@ -535,7 +535,7 @@ 
             if (\TYPO3_MODE === 'FE') {
                 self::$messages = $GLOBALS['TSFE']->readLLfile($file);
             } elseif (\TYPO3_MODE === 'BE') {
-                self::$messages = $GLOBALS['LANG']->includeLLFile($file, false, true);
+                self::$messages = $GLOBALS['LANG']->includeLLFile($file, FALSE, TRUE);
             } else {
                 self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
             }
@@ -735,7 +735,7 @@ 
      *
      * @return array Merged array
      */
-    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
+    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = TRUE, $includeEmptyValues = TRUE, $enableUnsetFeature = TRUE)
     {
         \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($original, $overrule, $addKeys, $includeEmptyValues, $enableUnsetFeature);
         return $original;
@@ -753,7 +753,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
+    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = FALSE, $cmdFirst = FALSE)
     {
         if (
             \TYPO3_MODE === 'BE'
@@ -762,7 +762,7 @@ 
             // Instantiate TYPO3 core engine.
             $dataHandler = GeneralUtility::makeInstance(\TYPO3\CMS\Core\DataHandling\DataHandler::class);
             // We do not use workspaces and have to bypass restrictions in DataHandler.
-            $dataHandler->bypassWorkspaceRestrictions = true;
+            $dataHandler->bypassWorkspaceRestrictions = TRUE;
             // Load data and command arrays.
             $dataHandler->start($data, $cmd);
             // Process command map first if default order is reversed.
@@ -826,19 +826,19 @@ 
         $key = (string) $key;
         if (!$key) {
             self::log('Invalid key "' . $key . '" for session data saving', LOG_SEVERITY_WARNING);
-            return false;
+            return FALSE;
         }
         // Save value in session data.
         if (\TYPO3_MODE === 'FE') {
             $GLOBALS['TSFE']->fe_user->setKey('ses', $key, $value);
             $GLOBALS['TSFE']->fe_user->storeSessionData();
-            return true;
+            return TRUE;
         } elseif (\TYPO3_MODE === 'BE') {
             $GLOBALS['BE_USER']->setAndSaveSessionData($key, $value);
-            return true;
+            return TRUE;
         } else {
             self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -884,7 +884,7 @@ 
             ->where(
                 $queryBuilder->expr()->eq($table . '.pid', $pid),
                 $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
-                self::whereExpression($table, true)
+                self::whereExpression($table, TRUE)
             )
             ->setMaxResults(1)
             ->execute();
@@ -902,7 +902,7 @@ 
                     $queryBuilder->expr()->eq($table . '.pid', $pid),
                     $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
                     $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content)),
-                    self::whereExpression($table, true)
+                    self::whereExpression($table, TRUE)
                 )
                 ->setMaxResults(1)
                 ->execute();
@@ -937,7 +937,7 @@ 
                     ->where(
                         $queryBuilder->expr()->eq($table . '.pid', $pid),
                         $additionalWhere,
-                        self::whereExpression($table, true)
+                        self::whereExpression($table, TRUE)
                     )
                     ->setMaxResults(10000)
                     ->execute();
@@ -977,7 +977,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = false)
+    public static function whereExpression($table, $showHidden = FALSE)
     {
         if (\TYPO3_MODE === 'FE') {
             // Should we ignore the record's hidden flag?

Braces +26 added lines, -52 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -74,8 +73,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
-    {
+    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = GeneralUtility::makeInstance(
@@ -100,8 +98,7 @@ 
      *
      * @return bool Is $id a valid GNL identifier of the given $type?
      */
-    public static function checkIdentifier($id, $type)
-    {
+    public static function checkIdentifier($id, $type) {
         $digits = substr($id, 0, 8);
         $checksum = 0;
         for ($i = 0, $j = strlen($digits); $i < $j; $i++) {
@@ -165,8 +162,7 @@ 
      *
      * @return mixed The decrypted value or false on error
      */
-    public static function decrypt($encrypted)
-    {
+    public static function decrypt($encrypted) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -204,8 +200,7 @@ 
      *
      * @return mixed
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Turn off libxml's error logging.
         $libxmlErrors = libxml_use_internal_errors(true);
         // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
@@ -230,8 +225,7 @@ 
      *
      * @return void
      */
-    public static function log($message, $severity = 0)
-    {
+    public static function log($message, $severity = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_called_class());
 
         switch ($severity) {
@@ -261,8 +255,7 @@ 
      *
      * @return mixed Hashed string or false on error
      */
-    public static function digest($string)
-    {
+    public static function digest($string) {
         if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
             return false;
@@ -281,8 +274,7 @@ 
      *
      * @return mixed Encrypted string or false on error
      */
-    public static function encrypt($string)
-    {
+    public static function encrypt($string) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -315,8 +307,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -330,8 +321,7 @@ 
      *
      * @return string The cleaned up string
      */
-    public static function getCleanString($string)
-    {
+    public static function getCleanString($string) {
         // Convert to lowercase.
         $string = strtolower($string);
         // Remove non-alphanumeric characters.
@@ -352,8 +342,7 @@ 
      *
      * @return array Array of hook objects for the class
      */
-    public static function getHookObjects($scriptRelPath)
-    {
+    public static function getHookObjects($scriptRelPath) {
         $hookObjects = [];
         if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
             foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
@@ -374,8 +363,7 @@ 
      *
      * @return string "index_name" for the given UID
      */
-    public static function getIndexNameFromUid($uid, $table, $pid = -1)
-    {
+    public static function getIndexNameFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -427,8 +415,7 @@ 
      *
      * @return string "label" for the given UID
      */
-    public static function getLabelFromUid($uid, $table, $pid = -1)
-    {
+    public static function getLabelFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -478,8 +465,7 @@ 
      *
      * @return string Localized full name of language or unchanged input
      */
-    public static function getLanguageName($code)
-    {
+    public static function getLanguageName($code) {
         // Analyze code and set appropriate ISO table.
         $isoCode = strtolower(trim($code));
         if (preg_match('/^[a-z]{3}$/', $isoCode)) {
@@ -524,8 +510,7 @@ 
      *
      * @return string The translated string or the given key on failure
      */
-    public static function getMessage($key, $hsc = false, $default = '')
-    {
+    public static function getMessage($key, $hsc = false, $default = '') {
         // Set initial output to default value.
         $translated = (string) $default;
         // Load common messages file.
@@ -567,8 +552,7 @@ 
      *
      * @return string "uid" for the given index_name
      */
-    public static function getUidFromIndexName($index_name, $table, $pid = -1)
-    {
+    public static function getUidFromIndexName($index_name, $table, $pid = -1) {
         if (
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
@@ -619,8 +603,7 @@ 
      *
      * @return string Uniform Resource Name as string
      */
-    public static function getURN($base, $id)
-    {
+    public static function getURN($base, $id) {
         $concordance = [
             '0' => 1,
             '1' => 2,
@@ -687,8 +670,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -701,8 +683,7 @@ 
      *
      * @return mixed Session value for given key or null on failure
      */
-    public static function loadFromSession($key)
-    {
+    public static function loadFromSession($key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -734,8 +715,7 @@ 
      *
      * @return array Merged array
      */
-    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
-    {
+    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true) {
         \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($original, $overrule, $addKeys, $includeEmptyValues, $enableUnsetFeature);
         return $original;
     }
@@ -752,8 +732,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
-    {
+    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false) {
         if (
             \TYPO3_MODE === 'BE'
             && $GLOBALS['BE_USER']->isAdmin()
@@ -799,8 +778,7 @@ 
      *
      * @return string All flash messages in the queue rendered as HTML.
      */
-    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages')
-    {
+    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessages = $flashMessageQueue->getAllMessagesAndFlush();
@@ -819,8 +797,7 @@ 
      *
      * @return bool true on success, false on failure
      */
-    public static function saveToSession($value, $key)
-    {
+    public static function saveToSession($value, $key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -852,8 +829,7 @@ 
      *
      * @return string Localized label for $index_name
      */
-    public static function translate($index_name, $table, $pid)
-    {
+    public static function translate($index_name, $table, $pid) {
         // Load labels into static variable for future use.
         static $labels = [];
         // Sanitize input.
@@ -976,8 +952,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = false)
-    {
+    public static function whereExpression($table, $showHidden = false) {
         if (\TYPO3_MODE === 'FE') {
             // Should we ignore the record's hidden flag?
             $ignoreHide = 0;
@@ -1006,8 +981,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

Classes/Plugin/Eid/SearchInDocument.php

Spacing +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
      */
     private function getQuery($fields, $parameters)
     {
-        return $fields['fulltext'] . ':(' . Solr::escapeQuery((string) $parameters['q']) . ') AND ' . $fields['uid'] . ':' . $this->getUid($parameters['uid']);
+        return $fields['fulltext'].':('.Solr::escapeQuery((string) $parameters['q']).') AND '.$fields['uid'].':'.$this->getUid($parameters['uid']);
     }
 
     /**

Braces +4 added lines, -8 removed lines

@@ -28,16 +28,14 @@ 
  * @subpackage dlf
  * @access public
  */
-class SearchInDocument
-{
+class SearchInDocument {
     /**
      * The main method of the eID script
      *
      * @param ServerRequestInterface $request
      * @return ResponseInterface JSON response of search suggestions
      */
-    public function main(ServerRequestInterface $request)
-    {
+    public function main(ServerRequestInterface $request) {
         $output = [
             'documents' => [],
             'numFound' => 0
@@ -118,8 +116,7 @@ 
      *
      * @return string SOLR query
      */
-    private function getQuery($fields, $parameters)
-    {
+    private function getQuery($fields, $parameters) {
         return $fields['fulltext'] . ':(' . Solr::escapeQuery((string) $parameters['q']) . ') AND ' . $fields['uid'] . ':' . $this->getUid($parameters['uid']);
     }
 
@@ -133,8 +130,7 @@ 
      *
      * @return int|string uid of the document
      */
-    private function getUid($uid)
-    {
+    private function getUid($uid) {
         return is_numeric($uid) ? intval($uid) : $uid;
     }
 }

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
         ];
         // Get input parameters and decrypt core name.
         $parameters = $request->getParsedBody();
-        if ($parameters === null) {
+        if ($parameters === NULL) {
             throw new \InvalidArgumentException('No parameters passed!', 1632322297);
         }
         $encrypted = (string) $parameters['encrypted'];

Classes/Common/DocumentList.php

Spacing +17 added lines, -17 removed lines

@@ -139,7 +139,7 @@ 
         if ($this->valid()) {
             return $this->getRecord($this->elements[$this->position]);
         } else {
-            $this->logger->notice('Invalid position "' . $this->position . '" for list element');
+            $this->logger->notice('Invalid position "'.$this->position.'" for list element');
             return;
         }
     }
@@ -267,7 +267,7 @@ 
 
         $query = $this->solr->service->createSelect();
         // Restrict the fields to the required ones
-        $query->setFields($fields['uid'] . ',' . $fields['id'] . ',' . $fields['toplevel'] . ',' . $fields['thumbnail'] . ',' . $fields['page']);
+        $query->setFields($fields['uid'].','.$fields['id'].','.$fields['toplevel'].','.$fields['thumbnail'].','.$fields['page']);
         foreach ($this->solrConfig as $solr_name) {
             $query->addField($solr_name);
         }
@@ -280,16 +280,16 @@ 
         // Extend filter query to get all documents with the same UID.
         foreach ($filterQueries as $key => $value) {
             if (isset($value['query'])) {
-                $filterQuery[$key] = $value['query'] . ' OR ' . $fields['toplevel'] . ':true';
+                $filterQuery[$key] = $value['query'].' OR '.$fields['toplevel'].':true';
                 $filterQuery = [
                     'key' => $key,
-                    'query' => $value['query'] . ' OR ' . $fields['toplevel'] . ':true'
+                    'query' => $value['query'].' OR '.$fields['toplevel'].':true'
                 ];
                 $query->addFilterQuery($filterQuery);
             }
         }
         // Add filter query to get all documents with the required uid.
-        $query->createFilterQuery('uid')->setQuery($fields['uid'] . ':' . Solr::escapeQuery($record['uid']));
+        $query->createFilterQuery('uid')->setQuery($fields['uid'].':'.Solr::escapeQuery($record['uid']));
         // Add sorting.
         if (is_array($this->metadata['options']['params']['sort'])) {
             foreach ($this->metadata['options']['params']['sort'] as $key => $direction) {
@@ -297,7 +297,7 @@ 
             }
         }
         // Set query.
-        $query->setQuery($this->metadata['options']['select'] . ' OR ' . $fields['toplevel'] . ':true');
+        $query->setQuery($this->metadata['options']['select'].' OR '.$fields['toplevel'].':true');
 
         // If it is a fulltext search, enable highlighting.
         if ($this->metadata['fulltextSearch']) {
@@ -405,7 +405,7 @@ 
             $position < 0
             || $position >= $this->count
         ) {
-            $this->logger->warning('Invalid position "' . $position . '" for element moving');
+            $this->logger->warning('Invalid position "'.$position.'" for element moving');
             return;
         }
         $steps = intval($steps);
@@ -413,7 +413,7 @@ 
         if (($position + $steps) < 0
             || ($position + $steps) >= $this->count
         ) {
-            $this->logger->warning('Invalid steps "' . $steps . '" for moving element at position "' . $position . '"');
+            $this->logger->warning('Invalid steps "'.$steps.'" for moving element at position "'.$position.'"');
             return;
         }
         $element = $this->remove($position);
@@ -491,7 +491,7 @@ 
         if ($this->offsetExists($offset)) {
             return $this->getRecord($this->elements[$offset]);
         } else {
-            $this->logger->notice('Invalid offset "' . $offset . '" for list element');
+            $this->logger->notice('Invalid offset "'.$offset.'" for list element');
             return;
         }
     }
@@ -535,7 +535,7 @@ 
             $position < 0
             || $position >= $this->count
         ) {
-            $this->logger->warning('Invalid position "' . $position . '" for element removing');
+            $this->logger->warning('Invalid position "'.$position.'" for element removing');
             return;
         }
         $removed = array_splice($this->elements, $position, 1);
@@ -560,7 +560,7 @@ 
             $position < 0
             || $position >= $this->count
         ) {
-            $this->logger->warning('Invalid position "' . $position . '" for element removing');
+            $this->logger->warning('Invalid position "'.$position.'" for element removing');
             return;
         }
         $removed = array_splice($this->elements, $position, $length);
@@ -653,7 +653,7 @@ 
                     ->execute();
 
                 while ($resArray = $result->fetch()) {
-                    $this->solrConfig[$resArray['index_name']] = $resArray['index_name'] . '_' . ($resArray['index_tokenized'] ? 't' : 'u') . 's' . ($resArray['index_indexed'] ? 'i' : 'u');
+                    $this->solrConfig[$resArray['index_name']] = $resArray['index_name'].'_'.($resArray['index_tokenized'] ? 't' : 'u').'s'.($resArray['index_indexed'] ? 'i' : 'u');
                 }
                 // Add static fields.
                 $this->solrConfig['type'] = 'type';
@@ -681,7 +681,7 @@ 
         foreach ($this->elements as $num => $element) {
             // Is this element sortable?
             if (!empty($element['s'][$by])) {
-                $newOrder[$element['s'][$by] . str_pad($num, 6, '0', STR_PAD_LEFT)] = $element;
+                $newOrder[$element['s'][$by].str_pad($num, 6, '0', STR_PAD_LEFT)] = $element;
             } else {
                 $nonSortable[] = $element;
             }
@@ -819,12 +819,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -857,12 +857,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }

Braces +32 added lines, -64 removed lines

@@ -104,8 +104,7 @@ 
      *
      * @return void
      */
-    public function add(array $elements, $position = -1)
-    {
+    public function add(array $elements, $position = -1) {
         $position = MathUtility::forceIntegerInRange($position, 0, $this->count, $this->count);
         if (!empty($elements)) {
             array_splice($this->elements, $position, 0, $elements);
@@ -121,8 +120,7 @@ 
      *
      * @return int The number of elements in the list
      */
-    public function count()
-    {
+    public function count() {
         return $this->count;
     }
 
@@ -134,8 +132,7 @@ 
      *
      * @return array The current element
      */
-    public function current()
-    {
+    public function current() {
         if ($this->valid()) {
             return $this->getRecord($this->elements[$this->position]);
         } else {
@@ -153,8 +150,7 @@ 
      *
      * @return mixed The element's full record
      */
-    protected function getRecord($element)
-    {
+    protected function getRecord($element) {
         if (
             is_array($element)
             && array_keys($element) == ['u', 'h', 's', 'p']
@@ -261,8 +257,7 @@ 
      *
      * @return Result
      */
-    private function getSolrResult($record)
-    {
+    private function getSolrResult($record) {
         $fields = Solr::getFields();
 
         $query = $this->solr->service->createSelect();
@@ -334,8 +329,7 @@ 
      *
      * @return array
      */
-    private function getSolrRecord($record, $result)
-    {
+    private function getSolrRecord($record, $result) {
         // If it is a fulltext search, fetch the highlighting results.
         if ($this->metadata['fulltextSearch']) {
             $data = $result->getData();
@@ -382,8 +376,7 @@ 
      *
      * @return int The current position
      */
-    public function key()
-    {
+    public function key() {
         return $this->position;
     }
 
@@ -397,8 +390,7 @@ 
      *
      * @return void
      */
-    public function move($position, $steps)
-    {
+    public function move($position, $steps) {
         $position = intval($position);
         // Check if list position is valid.
         if (
@@ -429,8 +421,7 @@ 
      *
      * @return void
      */
-    public function moveUp($position)
-    {
+    public function moveUp($position) {
         $this->move($position, -1);
     }
 
@@ -443,8 +434,7 @@ 
      *
      * @return void
      */
-    public function moveDown($position)
-    {
+    public function moveDown($position) {
         $this->move($position, 1);
     }
 
@@ -456,8 +446,7 @@ 
      *
      * @return void
      */
-    public function next()
-    {
+    public function next() {
         $this->position++;
     }
 
@@ -471,8 +460,7 @@ 
      *
      * @return bool Does the given offset exist?
      */
-    public function offsetExists($offset)
-    {
+    public function offsetExists($offset) {
         return isset($this->elements[$offset]);
     }
 
@@ -486,8 +474,7 @@ 
      *
      * @return array The element at the given offset
      */
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         if ($this->offsetExists($offset)) {
             return $this->getRecord($this->elements[$offset]);
         } else {
@@ -507,8 +494,7 @@ 
      *
      * @return void
      */
-    public function offsetSet($offset, $value)
-    {
+    public function offsetSet($offset, $value) {
         if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($offset)) {
             $this->elements[$offset] = $value;
         } else {
@@ -528,8 +514,7 @@ 
      *
      * @return array The removed element
      */
-    public function remove($position)
-    {
+    public function remove($position) {
         $position = intval($position);
         if (
             $position < 0
@@ -553,8 +538,7 @@ 
      *
      * @return array The indizes of the removed elements
      */
-    public function removeRange($position, $length)
-    {
+    public function removeRange($position, $length) {
         $position = intval($position);
         if (
             $position < 0
@@ -575,8 +559,7 @@ 
      *
      * @return void
      */
-    public function reset()
-    {
+    public function reset() {
         $this->elements = [];
         $this->records = [];
         $this->metadata = [];
@@ -592,8 +575,7 @@ 
      *
      * @return void
      */
-    public function rewind()
-    {
+    public function rewind() {
         $this->position = 0;
     }
 
@@ -606,8 +588,7 @@ 
      *
      * @return void
      */
-    public function save($pid = 0)
-    {
+    public function save($pid = 0) {
         $pid = max(intval($pid), 0);
         // If no PID is given, save to the user's session instead
         if ($pid > 0) {
@@ -624,8 +605,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function solrConnect()
-    {
+    protected function solrConnect() {
         // Get Solr instance.
         if (!$this->solr) {
             // Connect to Solr server.
@@ -674,8 +654,7 @@ 
      *
      * @return void
      */
-    public function sort($by, $asc = true)
-    {
+    public function sort($by, $asc = true) {
         $newOrder = [];
         $nonSortable = [];
         foreach ($this->elements as $num => $element) {
@@ -712,8 +691,7 @@ 
      *
      * @return void
      */
-    public function offsetUnset($offset)
-    {
+    public function offsetUnset($offset) {
         unset($this->elements[$offset]);
         // Re-number the elements.
         $this->elements = array_values($this->elements);
@@ -728,8 +706,7 @@ 
      *
      * @return bool Is the current list position valid?
      */
-    public function valid()
-    {
+    public function valid() {
         return isset($this->elements[$this->position]);
     }
 
@@ -740,8 +717,7 @@ 
      *
      * @return array The list's metadata
      */
-    protected function _getMetadata()
-    {
+    protected function _getMetadata() {
         return $this->metadata;
     }
 
@@ -754,8 +730,7 @@ 
      *
      * @return void
      */
-    protected function _setMetadata(array $metadata = [])
-    {
+    protected function _setMetadata(array $metadata = []) {
         $this->metadata = $metadata;
     }
 
@@ -769,8 +744,7 @@ 
      *
      * @return void
      */
-    public function __construct(array $elements = [], array $metadata = [])
-    {
+    public function __construct(array $elements = [], array $metadata = []) {
         if (
             empty($elements)
             && empty($metadata)
@@ -803,8 +777,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -817,8 +790,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -840,8 +812,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -855,8 +826,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -876,8 +846,7 @@ 
      *
      * @return array Properties to be serialized
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         return ['elements', 'metadata'];
     }
 
@@ -889,8 +858,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $this->count = count($this->elements);
     }
 }

Upper-Lower-Casing +4 added lines, -4 removed lines

@@ -224,7 +224,7 @@ 
                     if ($resArray['uid'] == $record['uid']) {
                         $record['thumbnail'] = $resArray['thumbnail'];
                         $record['metadata'] = $metadata;
-                    } elseif (($key = array_search(['u' => $resArray['uid']], $record['subparts'], true)) !== false) {
+                    } elseif (($key = array_search(['u' => $resArray['uid']], $record['subparts'], TRUE)) !== FALSE) {
                         $record['subparts'][$key] = [
                             'uid' => $resArray['uid'],
                             'page' => 1,
@@ -658,10 +658,10 @@ 
                 // Add static fields.
                 $this->solrConfig['type'] = 'type';
             } else {
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -674,7 +674,7 @@ 
      *
      * @return void
      */
-    public function sort($by, $asc = true)
+    public function sort($by, $asc = TRUE)
     {
         $newOrder = [];
         $nonSortable = [];

Classes/Common/SolrSearchResult/ResultDocument.php

Braces +15 added lines, -30 removed lines

@@ -24,8 +24,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class ResultDocument
-{
+class ResultDocument {
 
     /**
      * The identifier
@@ -102,8 +101,7 @@ 
      *
      * @return void
      */
-    public function __construct($record, $highlighting, $fields)
-    {
+    public function __construct($record, $highlighting, $fields) {
         $this->id = $record[$fields['id']];
         $this->uid = $record[$fields['uid']];
         $this->page = $record[$fields['page']];
@@ -124,8 +122,7 @@ 
      *
      * @return string The result's record identifier
      */
-    public function getId()
-    {
+    public function getId() {
         return $this->id;
     }
 
@@ -136,8 +133,7 @@ 
      *
      * @return string|null The result's record unified identifier
      */
-    public function getUid()
-    {
+    public function getUid() {
         return $this->uid;
     }
 
@@ -148,8 +144,7 @@ 
      *
      * @return int The result's record page
      */
-    public function getPage()
-    {
+    public function getPage() {
         return $this->page;
     }
 
@@ -160,8 +155,7 @@ 
      *
      * @return string All result's record snippets imploded to one string
      */
-    public function getSnippets()
-    {
+    public function getSnippets() {
         return $this->snippets;
     }
 
@@ -172,8 +166,7 @@ 
      *
      * @return array(Page) All result's pages which contain search phrase
      */
-    public function getPages()
-    {
+    public function getPages() {
         return $this->pages;
     }
 
@@ -184,8 +177,7 @@ 
      *
      * @return array(Region) All result's regions which contain search phrase
      */
-    public function getRegions()
-    {
+    public function getRegions() {
         return $this->regions;
     }
 
@@ -196,8 +188,7 @@ 
      *
      * @return array(Highlight) All result's highlights of search phrase
      */
-    public function getHighlights()
-    {
+    public function getHighlights() {
         return $this->highlights;
     }
 
@@ -208,8 +199,7 @@ 
      *
      * @return array(string) All result's highlights of search phrase
      */
-    public function getHighlightsIds()
-    {
+    public function getHighlightsIds() {
         $highlightsIds = [];
         foreach ($this->highlights as $highlight) {
             array_push($highlightsIds, $highlight->getId());
@@ -225,8 +215,7 @@ 
      *
      * @return void
      */
-    private function parseSnippets()
-    {
+    private function parseSnippets() {
         $snippetArray = $this->getArrayByIndex('text');
 
         $this->snippets = !empty($snippetArray) ? implode(' [...] ', $snippetArray) : '';
@@ -240,8 +229,7 @@ 
      *
      * @return void
      */
-    private function parsePages()
-    {
+    private function parsePages() {
         $pageArray = $this->getArrayByIndex('pages');
 
         $i = 0;
@@ -261,8 +249,7 @@ 
      *
      * @return void
      */
-    private function parseRegions()
-    {
+    private function parseRegions() {
         $regionArray = $this->getArrayByIndex('regions');
 
         $i = 0;
@@ -282,8 +269,7 @@ 
      *
      * @return void
      */
-    private function parseHighlights()
-    {
+    private function parseHighlights() {
         $highlightArray = $this->getArrayByIndex('highlights');
 
         foreach ($highlightArray as $highlights) {
@@ -304,8 +290,7 @@ 
      *
      * @return array
      */
-    private function getArrayByIndex($index)
-    {
+    private function getArrayByIndex($index) {
         $objectArray = [];
         foreach ($this->snippetsForRecord as $snippet) {
             if (!empty($snippet[$index])) {

Classes/Common/SolrSearchResult/Highlight.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
         $this->xEndPosition = $highlight['lrx'];
         $this->yBeginPosition = $highlight['uly'];
         $this->yEndPosition = $highlight['lry'];
-        $this->id = $this->xBeginPosition . '_' . $this->yBeginPosition;
+        $this->id = $this->xBeginPosition.'_'.$this->yBeginPosition;
     }
 
     /**

Braces +7 added lines, -14 removed lines

@@ -20,8 +20,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Highlight
-{
+class Highlight {
 
     /**
      * The identifier in form 'w_h_x_y'
@@ -80,8 +79,7 @@ 
      *
      * @return void
      */
-    public function __construct($highlight)
-    {
+    public function __construct($highlight) {
         $this->parentRegionId = $highlight['parentRegionIdx'];
         $this->xBeginPosition = $highlight['ulx'];
         $this->xEndPosition = $highlight['lrx'];
@@ -97,8 +95,7 @@ 
      *
      * @return string The highlight's identifier
      */
-    public function getId()
-    {
+    public function getId() {
         return $this->id;
     }
 
@@ -109,8 +106,7 @@ 
      *
      * @return int The highlight's horizontal beginning position
      */
-    public function getXBeginPosition()
-    {
+    public function getXBeginPosition() {
         return $this->xBeginPosition;
     }
 
@@ -121,8 +117,7 @@ 
      *
      * @return int The highlight's horizontal ending position
      */
-    public function getXEndPosition()
-    {
+    public function getXEndPosition() {
         return $this->xEndPosition;
     }
 
@@ -133,8 +128,7 @@ 
      *
      * @return int The highlight's vertical beginning position
      */
-    public function getYBeginPosition()
-    {
+    public function getYBeginPosition() {
         return $this->yBeginPosition;
     }
 
@@ -145,8 +139,7 @@ 
      *
      * @return int The highlight's vertical ending position
      */
-    public function getYEndPosition()
-    {
+    public function getYEndPosition() {
         return $this->yEndPosition;
     }
 }

Classes/Format/Alto.php

Spacing +2 added lines, -2 removed lines

@@ -101,7 +101,7 @@ 
      */
     private function getWord($attributes)
     {
-        return htmlspecialchars((string) $attributes['CONTENT']) . ' ';
+        return htmlspecialchars((string) $attributes['CONTENT']).' ';
     }
 
     /**
@@ -115,6 +115,6 @@ 
      */
     private function getCoordinates($attributes)
     {
-        return (string) $attributes['HPOS'] . ' ' . (string) $attributes['VPOS'] . ' ' . (string) $attributes['WIDTH'] . ' ' . (string) $attributes['HEIGHT'];
+        return (string) $attributes['HPOS'].' '.(string) $attributes['VPOS'].' '.(string) $attributes['WIDTH'].' '.(string) $attributes['HEIGHT'];
     }
 }

Braces +5 added lines, -10 removed lines

@@ -22,8 +22,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Alto implements \Kitodo\Dlf\Common\FulltextInterface
-{
+class Alto implements \Kitodo\Dlf\Common\FulltextInterface {
     /**
      * This extracts the fulltext data from ALTO XML
      *
@@ -33,8 +32,7 @@ 
      *
      * @return string The raw unformatted fulltext
      */
-    public function getRawText(\SimpleXMLElement $xml)
-    {
+    public function getRawText(\SimpleXMLElement $xml) {
         $rawText = '';
         $xml->registerXPathNamespace('alto', 'http://www.loc.gov/standards/alto/ns-v2#');
         // Get all (presumed) words of the text.
@@ -54,8 +52,7 @@ 
      *
      * @return string The unformatted fulltext in MiniOCR format
      */
-    public function getTextAsMiniOcr(\SimpleXMLElement $xml)
-    {
+    public function getTextAsMiniOcr(\SimpleXMLElement $xml) {
         $xml->registerXPathNamespace('alto', 'http://www.loc.gov/standards/alto/ns-v2#');
 
         // get all text blocks
@@ -99,8 +96,7 @@ 
      *
      * @return string The parsed word extracted from attribute
      */
-    private function getWord($attributes)
-    {
+    private function getWord($attributes) {
         return htmlspecialchars((string) $attributes['CONTENT']) . ' ';
     }
 
@@ -113,8 +109,7 @@ 
      *
      * @return string The parsed word coordinates extracted from attribute
      */
-    private function getCoordinates($attributes)
-    {
+    private function getCoordinates($attributes) {
         return (string) $attributes['HPOS'] . ' ' . (string) $attributes['VPOS'] . ' ' . (string) $attributes['WIDTH'] . ' ' . (string) $attributes['HEIGHT'];
     }
 }

Classes/Common/Indexer.php

Spacing +15 added lines, -15 removed lines

@@ -102,7 +102,7 @@ 
                 if ($parent->ready) {
                     $success = self::add($parent, $core);
                 } else {
-                    Helper::log('Could not load parent document with UID ' . $doc->parentId, LOG_SEVERITY_ERROR);
+                    Helper::log('Could not load parent document with UID '.$doc->parentId, LOG_SEVERITY_ERROR);
                     return false;
                 }
             }
@@ -111,7 +111,7 @@ 
                 self::$processedDocs[] = $doc->uid;
                 // Delete old Solr documents.
                 $updateQuery = self::$solr->service->createUpdate();
-                $updateQuery->addDeleteQuery('uid:' . $doc->uid);
+                $updateQuery->addDeleteQuery('uid:'.$doc->uid);
                 self::$solr->service->update($updateQuery);
 
                 // Index every logical unit as separate Solr document.
@@ -176,14 +176,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         FlashMessage::ERROR,
                         true,
                         'core.template.flashMessages'
                     );
                 }
-                Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
+                Helper::log('Apache Solr threw exception: "'.$e->getMessage().'"', LOG_SEVERITY_ERROR);
                 return false;
             }
         } else {
@@ -216,7 +216,7 @@ 
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
-            Helper::log('Invalid PID ' . $pid . ' for metadata configuration', LOG_SEVERITY_ERROR);
+            Helper::log('Invalid PID '.$pid.' for metadata configuration', LOG_SEVERITY_ERROR);
             return '';
         }
         // Load metadata configuration.
@@ -225,7 +225,7 @@ 
         $suffix = (in_array($index_name, self::$fields['tokenized']) ? 't' : 'u');
         $suffix .= (in_array($index_name, self::$fields['stored']) ? 's' : 'u');
         $suffix .= (in_array($index_name, self::$fields['indexed']) ? 'i' : 'u');
-        $index_name .= '_' . $suffix;
+        $index_name .= '_'.$suffix;
         return $index_name;
     }
 
@@ -333,7 +333,7 @@ 
             $updateQuery = self::$solr->service->createUpdate();
             $solrDoc = $updateQuery->createDocument();
             // Create unique identifier from document's UID and unit's XML ID.
-            $solrDoc->setField('id', $doc->uid . $logicalUnit['id']);
+            $solrDoc->setField('id', $doc->uid.$logicalUnit['id']);
             $solrDoc->setField('uid', $doc->uid);
             $solrDoc->setField('pid', $doc->pid);
             if (MathUtility::canBeInterpretedAsInteger($logicalUnit['points'])) {
@@ -374,11 +374,11 @@ 
                     $solrDoc->setField(self::getIndexFieldName($index_name, $doc->pid), $data, self::$fields['fieldboost'][$index_name]);
                     if (in_array($index_name, self::$fields['sortables'])) {
                         // Add sortable fields to index.
-                        $solrDoc->setField($index_name . '_sorting', $metadata[$index_name . '_sorting'][0]);
+                        $solrDoc->setField($index_name.'_sorting', $metadata[$index_name.'_sorting'][0]);
                     }
                     if (in_array($index_name, self::$fields['facets'])) {
                         // Add facets to index.
-                        $solrDoc->setField($index_name . '_faceting', $data);
+                        $solrDoc->setField($index_name.'_faceting', $data);
                     }
                     if (in_array($index_name, self::$fields['autocomplete'])) {
                         $autocomplete = array_merge($autocomplete, $data);
@@ -403,14 +403,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         FlashMessage::ERROR,
                         true,
                         'core.template.flashMessages'
                     );
                 }
-                Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
+                Helper::log('Apache Solr threw exception: "'.$e->getMessage().'"', LOG_SEVERITY_ERROR);
                 return false;
             }
         }
@@ -448,7 +448,7 @@ 
             $updateQuery = self::$solr->service->createUpdate();
             $solrDoc = $updateQuery->createDocument();
             // Create unique identifier from document's UID and unit's XML ID.
-            $solrDoc->setField('id', $doc->uid . $physicalUnit['id']);
+            $solrDoc->setField('id', $doc->uid.$physicalUnit['id']);
             $solrDoc->setField('uid', $doc->uid);
             $solrDoc->setField('pid', $doc->pid);
             $solrDoc->setField('page', $page);
@@ -483,7 +483,7 @@ 
                             }
                         }
                         // Add facets to index.
-                        $solrDoc->setField($index_name . '_faceting', $data);
+                        $solrDoc->setField($index_name.'_faceting', $data);
                     }
                 }
             }
@@ -500,14 +500,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         FlashMessage::ERROR,
                         true,
                         'core.template.flashMessages'
                     );
                 }
-                Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
+                Helper::log('Apache Solr threw exception: "'.$e->getMessage().'"', LOG_SEVERITY_ERROR);
                 return false;
             }
         }

Braces +8 added lines, -16 removed lines

@@ -28,8 +28,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * The extension key
      *
@@ -90,8 +89,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public static function add(Document &$doc, $core = 0)
-    {
+    public static function add(Document &$doc, $core = 0) {
         if (in_array($doc->uid, self::$processedDocs)) {
             return true;
         } elseif (self::solrConnect($core, $doc->pid)) {
@@ -211,8 +209,7 @@ 
      *
      * @return string The field's dynamic index name
      */
-    public static function getIndexFieldName($index_name, $pid = 0)
-    {
+    public static function getIndexFieldName($index_name, $pid = 0) {
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
@@ -238,8 +235,7 @@ 
      *
      * @return void
      */
-    protected static function loadIndexConf($pid)
-    {
+    protected static function loadIndexConf($pid) {
         if (!self::$fieldsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_metadata');
@@ -309,8 +305,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processLogical(Document &$doc, array $logicalUnit)
-    {
+    protected static function processLogical(Document &$doc, array $logicalUnit) {
         $success = true;
         // Get metadata for logical unit.
         $metadata = $doc->metadataArray[$logicalUnit['id']];
@@ -439,8 +434,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processPhysical(Document &$doc, $page, array $physicalUnit)
-    {
+    protected static function processPhysical(Document &$doc, $page, array $physicalUnit) {
         if ($doc->hasFulltext && $fullText = $doc->getFullText($physicalUnit['id'])) {
             // Read extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -524,8 +518,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function solrConnect($core, $pid = 0)
-    {
+    protected static function solrConnect($core, $pid = 0) {
         // Get Solr instance.
         if (!self::$solr) {
             // Connect to Solr server.
@@ -548,8 +541,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

Upper-Lower-Casing +33 added lines, -33 removed lines

@@ -62,7 +62,7 @@ 
      * @var bool
      * @access protected
      */
-    protected static $fieldsLoaded = false;
+    protected static $fieldsLoaded = FALSE;
 
     /**
      * List of already processed documents
@@ -93,17 +93,17 @@ 
     public static function add(Document &$doc, $core = 0)
     {
         if (in_array($doc->uid, self::$processedDocs)) {
-            return true;
+            return TRUE;
         } elseif (self::solrConnect($core, $doc->pid)) {
-            $success = true;
+            $success = TRUE;
             // Handle multi-volume documents.
             if ($doc->parentId) {
-                $parent = Document::getInstance($doc->parentId, 0, true);
+                $parent = Document::getInstance($doc->parentId, 0, TRUE);
                 if ($parent->ready) {
                     $success = self::add($parent, $core);
                 } else {
                     Helper::log('Could not load parent document with UID ' . $doc->parentId, LOG_SEVERITY_ERROR);
-                    return false;
+                    return FALSE;
                 }
             }
             try {
@@ -157,17 +157,17 @@ 
                     if ($success) {
                         Helper::addMessage(
                             htmlspecialchars(sprintf(Helper::getMessage('flash.documentIndexed'), $resArray['title'], $doc->uid)),
-                            Helper::getMessage('flash.done', true),
+                            Helper::getMessage('flash.done', TRUE),
                             FlashMessage::OK,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     } else {
                         Helper::addMessage(
                             htmlspecialchars(sprintf(Helper::getMessage('flash.documentNotIndexed'), $resArray['title'], $doc->uid)),
-                            Helper::getMessage('flash.error', true),
+                            Helper::getMessage('flash.error', TRUE),
                             FlashMessage::ERROR,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     }
@@ -176,28 +176,28 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         FlashMessage::ERROR,
-                        true,
+                        TRUE,
                         'core.template.flashMessages'
                     );
                 }
                 Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
-                return false;
+                return FALSE;
             }
         } else {
             if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                 Helper::addMessage(
-                    Helper::getMessage('flash.solrNoConnection', true),
-                    Helper::getMessage('flash.warning', true),
+                    Helper::getMessage('flash.solrNoConnection', TRUE),
+                    Helper::getMessage('flash.warning', TRUE),
                     FlashMessage::WARNING,
-                    true,
+                    TRUE,
                     'core.template.flashMessages'
                 );
             }
             Helper::log('Could not connect to Apache Solr server', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -292,10 +292,10 @@ 
                 if ($indexing['index_boost'] > 0.0) {
                     self::$fields['fieldboost'][$indexing['index_name']] = floatval($indexing['index_boost']);
                 } else {
-                    self::$fields['fieldboost'][$indexing['index_name']] = false;
+                    self::$fields['fieldboost'][$indexing['index_name']] = FALSE;
                 }
             }
-            self::$fieldsLoaded = true;
+            self::$fieldsLoaded = TRUE;
         }
     }
 
@@ -311,7 +311,7 @@ 
      */
     protected static function processLogical(Document &$doc, array $logicalUnit)
     {
-        $success = true;
+        $success = TRUE;
         // Get metadata for logical unit.
         $metadata = $doc->metadataArray[$logicalUnit['id']];
         if (!empty($metadata)) {
@@ -348,7 +348,7 @@ 
             $solrDoc->setField('root', $doc->rootId);
             $solrDoc->setField('sid', $logicalUnit['id']);
             // There can be only one toplevel unit per UID, independently of backend configuration
-            $solrDoc->setField('toplevel', $logicalUnit['id'] == $doc->toplevelId ? true : false);
+            $solrDoc->setField('toplevel', $logicalUnit['id'] == $doc->toplevelId ? TRUE : FALSE);
             $solrDoc->setField('type', $logicalUnit['type'], self::$fields['fieldboost']['type']);
             $solrDoc->setField('title', $metadata['title'][0], self::$fields['fieldboost']['title']);
             $solrDoc->setField('volume', $metadata['volume'][0], self::$fields['fieldboost']['volume']);
@@ -403,15 +403,15 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         FlashMessage::ERROR,
-                        true,
+                        TRUE,
                         'core.template.flashMessages'
                     );
                 }
                 Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
-                return false;
+                return FALSE;
             }
         }
         // Check for child elements...
@@ -462,7 +462,7 @@ 
             $solrDoc->setField('partof', $doc->parentId);
             $solrDoc->setField('root', $doc->rootId);
             $solrDoc->setField('sid', $physicalUnit['id']);
-            $solrDoc->setField('toplevel', false);
+            $solrDoc->setField('toplevel', FALSE);
             $solrDoc->setField('type', $physicalUnit['type'], self::$fields['fieldboost']['type']);
             $solrDoc->setField('collection', $doc->metadataArray[$doc->toplevelId]['collection']);
 
@@ -500,18 +500,18 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         FlashMessage::ERROR,
-                        true,
+                        TRUE,
                         'core.template.flashMessages'
                     );
                 }
                 Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -537,10 +537,10 @@ 
                     self::loadIndexConf($pid);
                 }
             } else {
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**

Classes/Common/Document.php

Spacing +16 added lines, -16 removed lines

@@ -671,14 +671,14 @@ 
                     if ($fileContent !== false) {
                         $textFormat = $this->getTextFormat($fileContent);
                     } else {
-                        $this->logger->warning('Couldn\'t load full text file for structure node @ID "' . $id . '"');
+                        $this->logger->warning('Couldn\'t load full text file for structure node @ID "'.$id.'"');
                         return $fullText;
                     }
                     break;
                 }
             }
         } else {
-            $this->logger->warning('Invalid structure node @ID "' . $id . '"');
+            $this->logger->warning('Invalid structure node @ID "'.$id.'"');
             return $fullText;
         }
         // Is this text format supported?
@@ -697,12 +697,12 @@ 
                     $textMiniOcr = $obj->getTextAsMiniOcr($ocrTextXml);
                     $this->rawTextArray[$id] = $textMiniOcr;
                 } else {
-                    $this->logger->warning('Invalid class/method "' . $class . '->getRawText()" for text format "' . $textFormat . '"');
+                    $this->logger->warning('Invalid class/method "'.$class.'->getRawText()" for text format "'.$textFormat.'"');
                 }
             }
             $fullText = $textMiniOcr;
         } else {
-            $this->logger->warning('Unsupported text format "' . $textFormat . '" in physical node with @ID "' . $id . '"');
+            $this->logger->warning('Unsupported text format "'.$textFormat.'" in physical node with @ID "'.$id.'"');
         }
         return $fullText;
     }
@@ -770,10 +770,10 @@ 
                     $title = self::getTitle($partof, true);
                 }
             } else {
-                Helper::log('No document with UID ' . $uid . ' found or document not accessible', LOG_SEVERITY_WARNING);
+                Helper::log('No document with UID '.$uid.' found or document not accessible', LOG_SEVERITY_WARNING);
             }
         } else {
-            Helper::log('Invalid UID ' . $uid . ' for document', LOG_SEVERITY_ERROR);
+            Helper::log('Invalid UID '.$uid.' for document', LOG_SEVERITY_ERROR);
         }
         return $title;
     }
@@ -908,7 +908,7 @@ 
             // the actual loading is format specific
             return $this->loadLocation($location);
         } else {
-            $this->logger->error('Invalid file location "' . $location . '" for document loading');
+            $this->logger->error('Invalid file location "'.$location.'" for document loading');
         }
         return false;
     }
@@ -1018,7 +1018,7 @@ 
             // Retain current PID.
             $pid = $this->pid;
         } elseif (!$pid) {
-            $this->logger->error('Invalid PID ' . $pid . ' for document saving');
+            $this->logger->error('Invalid PID '.$pid.' for document saving');
             return false;
         }
         // Set PID for metadata definitions.
@@ -1055,7 +1055,7 @@ 
         if ($resArray = $result->fetch()) {
             $structure = $resArray['uid'];
         } else {
-            $this->logger->error('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"');
+            $this->logger->error('Could not identify document/structure type "'.$queryBuilder->expr()->literal($metadata['type'][0]).'"');
             return false;
         }
         $metadata['type'][0] = $structure;
@@ -1304,7 +1304,7 @@ 
         if ($core) {
             return Indexer::add($this, $core);
         } else {
-            $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
+            $this->logger->notice('Invalid UID "'.$core.'" for Solr core');
             return false;
         }
     }
@@ -1382,7 +1382,7 @@ 
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
-            $this->logger->error('Invalid PID ' . $cPid . ' for metadata definitions');
+            $this->logger->error('Invalid PID '.$cPid.' for metadata definitions');
             return [];
         }
         if (
@@ -1710,7 +1710,7 @@ 
             // Document ready!
             $this->ready = true;
         } else {
-            $this->logger->error('No document with UID ' . $uid . ' found or document not accessible');
+            $this->logger->error('No document with UID '.$uid.' found or document not accessible');
         }
     }
 
@@ -1725,12 +1725,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -1763,12 +1763,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }

Braces +32 added lines, -64 removed lines

@@ -48,8 +48,7 @@ 
  * @property-read mixed $uid This holds the UID or the URL of the document
  * @abstract
  */
-abstract class Document
-{
+abstract class Document {
     /**
      * This holds the logger
      *
@@ -341,8 +340,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -607,8 +605,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -653,8 +650,7 @@ 
      *
      * @return string The OCR full text
      */
-    protected function getFullTextFromXml($id)
-    {
+    protected function getFullTextFromXml($id) {
         $fullText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -716,8 +712,7 @@ 
      *
      * @return string The format of the OCR full text
      */
-    private function getTextFormat($fileContent)
-    {
+    private function getTextFormat($fileContent) {
         $xml = Helper::getXmlFileAsString($fileContent);
 
         if ($xml !== false) {
@@ -740,8 +735,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
-    {
+    public static function getTitle($uid, $recursive = false) {
         $title = '';
         // Sanitize input.
         $uid = max(intval($uid), 0);
@@ -793,8 +787,7 @@ 
      *
      * @return array The logical structure node's / resource's parsed metadata array
      */
-    public function getTitledata($cPid = 0)
-    {
+    public function getTitledata($cPid = 0) {
         $titledata = $this->getMetadata($this->_getToplevelId(), $cPid);
         // Add information from METS structural map to titledata array.
         if ($this instanceof MetsDocument) {
@@ -827,8 +820,7 @@ 
      * @return int|bool: false if structure with $logId is not a child of this substructure,
      * or the actual depth.
      */
-    protected function getTreeDepth($structure, $depth, $logId)
-    {
+    protected function getTreeDepth($structure, $depth, $logId) {
         foreach ($structure as $element) {
             if ($element['id'] == $logId) {
                 return $depth;
@@ -850,8 +842,7 @@ 
      * @param string $logId: The id of the logical structure element whose depth is requested
      * @return int|bool tree depth as integer or false if no element with $logId exists within the TOC.
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         return $this->getTreeDepth($this->_getTableOfContents(), 1, $logId);
     }
 
@@ -901,8 +892,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function load($location)
-    {
+    protected function load($location) {
         // Load XML / JSON-LD file.
         if (GeneralUtility::isValidUrl($location)) {
             // Load extension configuration
@@ -935,8 +925,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -976,8 +965,7 @@ 
      *
      * @return void
      */
-    public function registerNamespaces(&$obj)
-    {
+    public function registerNamespaces(&$obj) {
         // TODO Check usage. XML specific method does not seem to be used anywhere outside this class within the project, but it is public and may be used by extensions.
         $this->loadFormats();
         // Do we have a \SimpleXMLElement or \DOMXPath object?
@@ -1006,8 +994,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
-    {
+    public function save($pid = 0, $core = 0, $owner = null) {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
             return false;
@@ -1335,8 +1322,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -1347,8 +1333,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -1360,8 +1345,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -1383,8 +1367,7 @@ 
      *
      * @return array Array of metadata with their corresponding logical structure node ID as key
      */
-    protected function _getMetadataArray()
-    {
+    protected function _getMetadataArray() {
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
@@ -1409,8 +1392,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -1422,8 +1404,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1446,8 +1427,7 @@ 
      *
      * @return array Array of elements' type, label and file representations ordered by @ID attribute / Canvas order
      */
-    protected function _getPhysicalStructureInfo()
-    {
+    protected function _getPhysicalStructureInfo() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Build physical structure array.
@@ -1463,8 +1443,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1475,8 +1454,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1487,8 +1465,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1499,8 +1476,7 @@ 
      *
      * @return int The UID of the root document or zero if not applicable
      */
-    protected function _getRootId()
-    {
+    protected function _getRootId() {
         if (!$this->rootIdLoaded) {
             if ($this->parentId) {
                 $parent = self::getInstance($this->parentId, $this->pid);
@@ -1530,8 +1506,7 @@ 
      *
      * @return array Array of structure nodes' id, label, type and physical page indexes/mptr / Canvas link with original hierarchy preserved
      */
-    protected function _getTableOfContents()
-    {
+    protected function _getTableOfContents() {
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
@@ -1572,8 +1547,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1586,8 +1560,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1598,8 +1571,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -1616,8 +1588,7 @@ 
      *
      * @return void
      */
-    protected function __construct($uid, $pid, $preloadedDocument)
-    {
+    protected function __construct($uid, $pid, $preloadedDocument) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger();
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
@@ -1730,8 +1701,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1753,8 +1723,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -1768,8 +1737,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)

Upper-Lower-Casing +55 added lines, -55 removed lines

@@ -103,7 +103,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $formatsLoaded = false;
+    protected $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -113,7 +113,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltext = false;
+    protected $hasFulltext = FALSE;
 
     /**
      * Last searched logical and physical page
@@ -121,7 +121,7 @@ 
      * @var array
      * @access protected
      */
-    protected $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * This holds the documents location
@@ -155,7 +155,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $metadataArrayLoaded = false;
+    protected $metadataArrayLoaded = FALSE;
 
     /**
      * The holds the total number of pages
@@ -196,7 +196,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $physicalStructureLoaded = false;
+    protected $physicalStructureLoaded = FALSE;
 
     /**
      * This holds the PID of the document or zero if not in database
@@ -221,7 +221,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * The METS file's / IIIF manifest's record identifier
@@ -255,7 +255,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $rootIdLoaded = false;
+    protected $rootIdLoaded = FALSE;
 
     /**
      * This holds the smLinks between logical and physical structMap
@@ -272,7 +272,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $smLinksLoaded = false;
+    protected $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -289,7 +289,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $tableOfContentsLoaded = false;
+    protected $tableOfContentsLoaded = FALSE;
 
     /**
      * This holds the document's thumbnail location
@@ -306,7 +306,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $thumbnailLoaded = false;
+    protected $thumbnailLoaded = FALSE;
 
     /**
      * This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
@@ -423,7 +423,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Document Instance of this class, either MetsDocument or IiifManifest
      */
-    public static function &getInstance($uid, $pid = 0, $forceReload = false)
+    public static function &getInstance($uid, $pid = 0, $forceReload = FALSE)
     {
         // Sanitize input.
         $pid = max(intval($pid), 0);
@@ -463,10 +463,10 @@ 
             }
         }
         // Create new instance depending on format (METS or IIIF) ...
-        $instance = null;
-        $documentFormat = null;
-        $xml = null;
-        $iiif = null;
+        $instance = NULL;
+        $documentFormat = NULL;
+        $xml = NULL;
+        $iiif = NULL;
         // Try to get document format from database
         if (MathUtility::canBeInterpretedAsInteger($uid)) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -515,17 +515,17 @@ 
                     @ini_set('user_agent', $extConf['useragent']);
                 }
                 $content = GeneralUtility::getUrl($location);
-                if ($content !== false) {
+                if ($content !== FALSE) {
                     $xml = Helper::getXmlFileAsString($content);
-                    if ($xml !== false) {
+                    if ($xml !== FALSE) {
                         /* @var $xml \SimpleXMLElement */
                         $xml->registerXPathNamespace('mets', 'http://www.loc.gov/METS/');
                         $xpathResult = $xml->xpath('//mets:mets');
-                        $documentFormat = !empty($xpathResult) ? 'METS' : null;
+                        $documentFormat = !empty($xpathResult) ? 'METS' : NULL;
                     } else {
                         // Try to load file as IIIF resource instead.
-                        $contentAsJsonArray = json_decode($content, true);
-                        if ($contentAsJsonArray !== null) {
+                        $contentAsJsonArray = json_decode($content, TRUE);
+                        if ($contentAsJsonArray !== NULL) {
                             // Load plugin configuration.
                             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
                             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
@@ -580,7 +580,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    public abstract function getLogicalStructure($id, $recursive = false);
+    public abstract function getLogicalStructure($id, $recursive = FALSE);
 
     /**
      * This extracts all the metadata for a logical structure node
@@ -617,7 +617,7 @@ 
         } else {
             $physicalPage = 0;
             foreach ($this->physicalStructureInfo as $page) {
-                if (strpos($page['orderlabel'], $logicalPage) !== false) {
+                if (strpos($page['orderlabel'], $logicalPage) !== FALSE) {
                     $this->lastSearchedPhysicalPage['logicalPage'] = $logicalPage;
                     $this->lastSearchedPhysicalPage['physicalPage'] = $physicalPage;
                     return $physicalPage;
@@ -668,7 +668,7 @@ 
                 if (!empty($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext])) {
                     // Get full text file.
                     $fileContent = GeneralUtility::getUrl($this->getFileLocation($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext]));
-                    if ($fileContent !== false) {
+                    if ($fileContent !== FALSE) {
                         $textFormat = $this->getTextFormat($fileContent);
                     } else {
                         $this->logger->warning('Couldn\'t load full text file for structure node @ID "' . $id . '"');
@@ -720,7 +720,7 @@ 
     {
         $xml = Helper::getXmlFileAsString($fileContent);
 
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             // Get the root element's name as text format.
             return strtoupper($xml->getName());
         } else {
@@ -740,7 +740,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
+    public static function getTitle($uid, $recursive = FALSE)
     {
         $title = '';
         // Sanitize input.
@@ -773,7 +773,7 @@ 
                     && intval($partof)
                     && $partof != $uid
                 ) {
-                    $title = self::getTitle($partof, true);
+                    $title = self::getTitle($partof, TRUE);
                 }
             } else {
                 Helper::log('No document with UID ' . $uid . ' found or document not accessible', LOG_SEVERITY_WARNING);
@@ -834,12 +834,12 @@ 
                 return $depth;
             } elseif (array_key_exists('children', $element)) {
                 $foundInChildren = $this->getTreeDepth($element['children'], $depth + 1, $logId);
-                if ($foundInChildren !== false) {
+                if ($foundInChildren !== FALSE) {
                     return $foundInChildren;
                 }
             }
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -916,7 +916,7 @@ 
         } else {
             $this->logger->error('Invalid file location "' . $location . '" for document loading');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -963,7 +963,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -1006,11 +1006,11 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
+    public function save($pid = 0, $core = 0, $owner = NULL)
     {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
-            return false;
+            return FALSE;
         }
         // Make sure $pid is a non-negative integer.
         $pid = max(intval($pid), 0);
@@ -1025,7 +1025,7 @@ 
             $pid = $this->pid;
         } elseif (!$pid) {
             $this->logger->error('Invalid PID ' . $pid . ' for document saving');
-            return false;
+            return FALSE;
         }
         // Set PID for metadata definitions.
         $this->cPid = $pid;
@@ -1038,7 +1038,7 @@ 
         // Check for record identifier.
         if (empty($metadata['record_id'][0])) {
             $this->logger->error('No record identifier found to avoid duplication');
-            return false;
+            return FALSE;
         }
         // Load plugin configuration.
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -1062,7 +1062,7 @@ 
             $structure = $resArray['uid'];
         } else {
             $this->logger->error('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"');
-            return false;
+            return FALSE;
         }
         $metadata['type'][0] = $structure;
 
@@ -1122,9 +1122,9 @@ 
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
                         htmlspecialchars(sprintf(Helper::getMessage('flash.newCollection'), $collection, $substUid[$collNewUid])),
-                        Helper::getMessage('flash.attention', true),
+                        Helper::getMessage('flash.attention', TRUE),
                         \TYPO3\CMS\Core\Messaging\FlashMessage::INFO,
-                        true
+                        TRUE
                     );
                 }
             }
@@ -1175,9 +1175,9 @@ 
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
                         htmlspecialchars(sprintf(Helper::getMessage('flash.newLibrary'), $owner, $ownerUid)),
-                        Helper::getMessage('flash.attention', true),
+                        Helper::getMessage('flash.attention', TRUE),
                         \TYPO3\CMS\Core\Messaging\FlashMessage::INFO,
-                        true
+                        TRUE
                     );
                 }
             }
@@ -1265,7 +1265,7 @@ 
             'author' => implode('; ', $metadata['author']),
             'year' => implode('; ', $metadata['year']),
             'place' => implode('; ', $metadata['place']),
-            'thumbnail' => $this->_getThumbnail(true),
+            'thumbnail' => $this->_getThumbnail(TRUE),
             'metadata' => serialize($listed),
             'metadata_sorting' => serialize($sortable),
             'structure' => $metadata['type'][0],
@@ -1301,9 +1301,9 @@ 
         if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
             Helper::addMessage(
                 htmlspecialchars(sprintf(Helper::getMessage('flash.documentSaved'), $metadata['title'][0], $this->uid)),
-                Helper::getMessage('flash.done', true),
+                Helper::getMessage('flash.done', TRUE),
                 \TYPO3\CMS\Core\Messaging\FlashMessage::OK,
-                true
+                TRUE
             );
         }
         // Add document to index.
@@ -1311,7 +1311,7 @@ 
             return Indexer::add($this, $core);
         } else {
             $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
-            return false;
+            return FALSE;
         }
     }
 
@@ -1397,7 +1397,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1506,7 +1506,7 @@ 
                 $parent = self::getInstance($this->parentId, $this->pid);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1535,8 +1535,8 @@ 
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
-            $this->getLogicalStructure('', true);
-            $this->tableOfContentsLoaded = true;
+            $this->getLogicalStructure('', TRUE);
+            $this->tableOfContentsLoaded = TRUE;
         }
         return $this->tableOfContents;
     }
@@ -1552,7 +1552,7 @@ 
      *
      * @return string The document's thumbnail location
      */
-    protected abstract function _getThumbnail($forceReload = false);
+    protected abstract function _getThumbnail($forceReload = FALSE);
 
     /**
      * This returns the ID of the toplevel logical structure node
@@ -1634,7 +1634,7 @@ 
                 && $this->load($uid))) {
                 // Initialize core METS object.
                 $this->init();
-                if ($this->getDocument() !== null) {
+                if ($this->getDocument() !== NULL) {
                     // Cast to string for safety reasons.
                     $location = (string) $uid;
                     $this->establishRecordId($pid);
@@ -1692,30 +1692,30 @@ 
             $this->parentId = $resArray['partof'];
             $this->thumbnail = $resArray['thumbnail'];
             $this->location = $resArray['location'];
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
             // Load XML file if necessary...
             if (
-                $this->getDocument() === null
+                $this->getDocument() === NULL
                 && $this->load($this->location)
             ) {
                 // ...and set some basic properties.
                 $this->init();
             }
             // Do we have a METS / IIIF object now?
-            if ($this->getDocument() !== null) {
+            if ($this->getDocument() !== NULL) {
                 // Set new location if necessary.
                 if (!empty($location)) {
                     $this->location = $location;
                 }
                 // Document ready!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
-        } elseif ($this->getDocument() !== null) {
+        } elseif ($this->getDocument() !== NULL) {
             // Set location as UID for documents not in database.
             $this->uid = $location;
             $this->location = $location;
             // Document ready!
-            $this->ready = true;
+            $this->ready = TRUE;
         } else {
             $this->logger->error('No document with UID ' . $uid . ' found or document not accessible');
         }