Erikmitk / kitodo-presentation

Classes/Common/MetsDocument.php

Spacing +30 added lines, -30 removed lines

@@ -188,7 +188,7 @@ 
     {
         $file = $this->getFileInfo($id);
         if ($file['mimeType'] === 'application/vnd.kitodo.iiif') {
-            $file['location'] = (strrpos($file['location'], 'info.json') === strlen($file['location']) - 9) ? $file['location'] : (strrpos($file['location'], '/') === strlen($file['location']) ? $file['location'] . 'info.json' : $file['location'] . '/info.json');
+            $file['location'] = (strrpos($file['location'], 'info.json') === strlen($file['location']) - 9) ? $file['location'] : (strrpos($file['location'], '/') === strlen($file['location']) ? $file['location'].'info.json' : $file['location'].'/info.json');
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'iiif');
             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
             IiifHelper::setMaxThumbnailHeight($conf['thumbnailHeight']);
@@ -198,9 +198,9 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($file['mimeType'] === 'application/vnd.netfpx') {
-            $baseURL = $file['location'] . (strpos($file['location'], '?') === false ? '?' : '');
+            $baseURL = $file['location'].(strpos($file['location'], '?') === false ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
-            return $baseURL . '&CVT=jpeg';
+            return $baseURL.'&CVT=jpeg';
         }
         return $file['location'];
     }
@@ -229,14 +229,14 @@ 
      */
     public function getFileLocation(string $id): string
     {
-        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
+        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
             && !empty($location)
         ) {
             return (string) $location[0]->attributes('http://www.w3.org/1999/xlink')->href;
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '"');
+            $this->logger->warning('There is no file node with @ID "'.$id.'"');
             return '';
         }
     }
@@ -246,14 +246,14 @@ 
      */
     public function getFileMimeType(string $id): string
     {
-        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
+        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/@MIMETYPE');
         if (
             !empty($id)
             && !empty($mimetype)
         ) {
             return (string) $mimetype[0];
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '" or no MIME type specified');
+            $this->logger->warning('There is no file node with @ID "'.$id.'" or no MIME type specified');
             return '';
         }
     }
@@ -273,7 +273,7 @@ 
             return $this->logicalUnits[$id];
         } elseif (!empty($id)) {
             // Get specified logical unit.
-            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]');
+            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]');
         } else {
             // Get all logical units at top level.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div');
@@ -461,7 +461,7 @@ 
         $cPid = max($cPid, 0);
         if ($cPid == 0 && ($this->cPid || $this->pid)) {
             // Retain current PID.
-            $cPid = $this->cPid ?: $this->pid;
+            $cPid = $this->cPid ? : $this->pid;
         }
         return $cPid;
     }
@@ -528,7 +528,7 @@ 
         if (isset($this->fileInfos[$id]) || in_array('dmdSec', $metadataSections)) {
             return $metadata;
         } else {
-            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "' . $id . '"');
+            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "'.$id.'"');
             return [];
         }
     }
@@ -547,7 +547,7 @@ 
         if (!empty($this->logicalUnits[$id])) {
             return [$this->logicalUnits[$id]['type']];
         } else {
-            $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]/@TYPE');
+            $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]/@TYPE');
             if (!empty($struct)) {
                 return [(string) $struct[0]];
             }
@@ -690,13 +690,13 @@ 
             if ($resArray['format'] > 0 && !empty($resArray['xpath_sorting'])) {
                 $values = $domXPath->evaluate($resArray['xpath_sorting'], $domNode);
                 if ($values instanceof \DOMNodeList && $values->length > 0) {
-                    $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values->item(0)->nodeValue);
+                    $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values->item(0)->nodeValue);
                 } elseif (!($values instanceof \DOMNodeList)) {
-                    $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values);
+                    $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values);
                 }
             }
-            if (empty($metadata[$resArray['index_name'] . '_sorting'][0])) {
-                $metadata[$resArray['index_name'] . '_sorting'][0] = $metadata[$resArray['index_name']][0];
+            if (empty($metadata[$resArray['index_name'].'_sorting'][0])) {
+                $metadata[$resArray['index_name'].'_sorting'][0] = $metadata[$resArray['index_name']][0];
             }
         }
     }
@@ -756,11 +756,11 @@ 
                         return true;
                     }
                 } else {
-                    $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
+                    $this->logger->warning('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->mdSec[$dmdId]['type'].'"');
                 }
             }
         } else {
-            $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
+            $this->logger->notice('Unsupported metadata format "'.$this->mdSec[$dmdId]['type'].'" in '.$mdSectionType.' with @ID "'.$dmdId.'"');
         }
         return false;
     }
@@ -867,7 +867,7 @@ 
             $dmdIds = $this->logicalUnits[$id]['dmdId'] ?? '';
             $admIds = $this->logicalUnits[$id]['admId'] ?? '';
         } else {
-            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]')[0];
+            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]')[0];
             if ($mdSec) {
                 $dmdIds = (string) $mdSec->attributes()->DMDID;
                 $admIds = (string) $mdSec->attributes()->ADMID;
@@ -897,7 +897,7 @@ 
 
         return array_filter(
             $allMdIds,
-            function ($element) {
+            function($element) {
                 return !empty($element);
             }
         );
@@ -923,7 +923,7 @@ 
      */
     public function getStructureDepth(string $logId)
     {
-        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
+        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$logId.'"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
         } else {
@@ -947,9 +947,9 @@ 
             $this->registerNamespaces($this->mets);
         } else {
             if (!empty($location)) {
-                $this->logger->error('No METS part found in document with location "' . $location . '".');
+                $this->logger->error('No METS part found in document with location "'.$location.'".');
             } elseif (!empty($this->recordId)) {
-                $this->logger->error('No METS part found in document with recordId "' . $this->recordId . '".');
+                $this->logger->error('No METS part found in document with recordId "'.$this->recordId.'".');
             } else {
                 $this->logger->error('No METS part found in current document.');
             }
@@ -970,7 +970,7 @@ 
                 return true;
             }
         }
-        $this->logger->error('Could not load XML file from "' . $location . '"');
+        $this->logger->error('Could not load XML file from "'.$location.'"');
         return false;
     }
 
@@ -1093,10 +1093,10 @@ 
 
         if (!empty($mdType) && !empty($this->formats[(string) $mdType[0]])) {
             $type = (string) $mdType[0];
-            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
         } elseif (!empty($otherMdType) && !empty($this->formats[(string) $otherMdType[0]])) {
             $type = (string) $otherMdType[0];
-            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
         }
 
         if (empty($xml)) {
@@ -1289,9 +1289,9 @@ 
             || $forceReload
         ) {
             // Retain current PID.
-            $cPid = $this->cPid ?: $this->pid;
+            $cPid = $this->cPid ? : $this->pid;
             if (!$cPid) {
-                $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
+                $this->logger->error('Invalid PID '.$cPid.' for structure definitions');
                 $this->thumbnailLoaded = true;
                 return $this->thumbnail;
             }
@@ -1328,7 +1328,7 @@ 
                 if (!empty($resArray['thumbnail'])) {
                     $strctType = Helper::getIndexNameFromUid($resArray['thumbnail'], 'tx_dlf_structures', $cPid);
                     // Check if this document has a structure element of the desired type.
-                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="' . $strctType . '"]/@ID');
+                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="'.$strctType.'"]/@ID');
                     if (!empty($strctIds)) {
                         $strctId = (string) $strctIds[0];
                     }
@@ -1351,7 +1351,7 @@ 
                     }
                 }
             } else {
-                $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
+                $this->logger->error('No structure of type "'.$metadata['type'][0].'" found in database');
             }
             $this->thumbnailLoaded = true;
         }
@@ -1397,7 +1397,7 @@ 
     {
         if (empty($this->parentHref)) {
             // Get the closest ancestor of the current document which has a MPTR child.
-            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $this->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
+            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$this->toplevelId.'"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
             if (!empty($parentMptr)) {
                 $this->parentHref = (string) $parentMptr[0]->attributes('http://www.w3.org/1999/xlink')->href;
             }

Braces +5 added lines, -10 removed lines

@@ -66,8 +66,7 @@ 
  * @property-read SimpleXMLElement $mets this holds the XML file's METS part as SimpleXMLElement object
  * @property-read string $parentHref URL of the parent document (determined via mptr element), or empty string if none is available
  */
-final class MetsDocument extends AbstractDocument
-{
+final class MetsDocument extends AbstractDocument {
     /**
      * @access protected
      * @var string[] Subsections / tags that may occur within `<mets:amdSec>`
@@ -427,8 +426,7 @@ 
      *
      * @return ?string thumbnail or null if not found
      */
-    private function getThumbnail(string $id = '')
-    {
+    private function getThumbnail(string $id = '') {
         // Load plugin configuration.
         $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
         $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
@@ -772,8 +770,7 @@ 
      *
      * @return bool true if extraction successful, false otherwise
      */
-    private function extractMetadataIfTypeSupported(string $dmdId, string $mdSectionType, array &$metadata)
-    {
+    private function extractMetadataIfTypeSupported(string $dmdId, string $mdSectionType, array &$metadata) {
         // Is this metadata format supported?
         if (!empty($this->formats[$this->mdSec[$dmdId]['type']])) {
             if (!empty($this->formats[$this->mdSec[$dmdId]['type']]['class'])) {
@@ -805,8 +802,7 @@ 
      *
      * @return array additional metadata data queried from database
      */
-    private function getAdditionalMetadataFromDatabase(int $cPid, string $dmdId)
-    {
+    private function getAdditionalMetadataFromDatabase(int $cPid, string $dmdId) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_metadata');
         // Get hidden records, too.
@@ -951,8 +947,7 @@ 
     /**
      * @see AbstractDocument::getStructureDepth()
      */
-    public function getStructureDepth(string $logId)
-    {
+    public function getStructureDepth(string $logId) {
         $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);

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

@@ -103,7 +103,7 @@ 
      *
      * @see MetsDocument::$mdSec
      */
-    protected bool $mdSecLoaded = false;
+    protected bool $mdSecLoaded = FALSE;
 
     /**
      * @access protected
@@ -125,7 +125,7 @@ 
      *
      * @see $fileGrps
      */
-    protected bool $fileGrpsLoaded = false;
+    protected bool $fileGrpsLoaded = FALSE;
 
     /**
      * @access protected
@@ -201,7 +201,7 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($file['mimeType'] === 'application/vnd.netfpx') {
-            $baseURL = $file['location'] . (strpos($file['location'], '?') === false ? '?' : '');
+            $baseURL = $file['location'] . (strpos($file['location'], '?') === FALSE ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
             return $baseURL . '&CVT=jpeg';
         }
@@ -224,7 +224,7 @@ 
             $this->fileInfos[$id]['mimeType'] = $this->getFileMimeType($id);
         }
 
-        return $this->fileInfos[$id] ?? null;
+        return $this->fileInfos[$id] ?? NULL;
     }
 
     /**
@@ -264,7 +264,7 @@ 
     /**
      * @see AbstractDocument::getLogicalStructure()
      */
-    public function getLogicalStructure(string $id, bool $recursive = false): array
+    public function getLogicalStructure(string $id, bool $recursive = FALSE): array
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -305,7 +305,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(SimpleXMLElement $structure, bool $recursive = false): array
+    protected function getLogicalStructureInfo(SimpleXMLElement $structure, bool $recursive = FALSE): array
     {
         $attributes = $structure->attributes();
 
@@ -323,7 +323,7 @@ 
             'pagination' => '',
             'type' => isset($attributes['TYPE']) ? (string) $attributes['TYPE'] : '',
             'description' => '',
-            'thumbnailId' => null,
+            'thumbnailId' => NULL,
             'files' => [],
         ];
 
@@ -358,7 +358,7 @@ 
             $details['children'] = [];
             foreach ($structure->children('http://www.loc.gov/METS/')->div as $child) {
                 // Repeat for all children.
-                $details['children'][] = $this->getLogicalStructureInfo($child, true);
+                $details['children'][] = $this->getLogicalStructureInfo($child, TRUE);
             }
         }
         return $details;
@@ -404,7 +404,7 @@ 
             && array_key_exists($details['id'], $this->smLinks['l2p'])
         ) {
             // Link logical structure to the first corresponding physical page/track.
-            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, true), 1);
+            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE), 1);
             $details['thumbnailId'] = $this->getThumbnail();
             // Get page/track number of the first page/track related to this structure element.
             $details['pagination'] = $this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['orderlabel'];
@@ -413,7 +413,7 @@ 
             $details['points'] = 1;
             $details['thumbnailId'] = $this->getThumbnail();
         }
-        if ($details['thumbnailId'] === null) {
+        if ($details['thumbnailId'] === NULL) {
             unset($details['thumbnailId']);
         }
     }
@@ -433,14 +433,14 @@ 
         $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
         $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
 
-        $thumbnail = null;
+        $thumbnail = NULL;
 
         while ($fileGrpThumb = array_shift($fileGrpsThumb)) {
             if (empty($id)) {
-                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? null;
+                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? NULL;
             } else {
-                $parentId = $this->smLinks['l2p'][$id][0] ?? null;
-                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? null;
+                $parentId = $this->smLinks['l2p'][$id][0] ?? NULL;
+                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? NULL;
             }
 
             if (!empty($thumbnail)) {
@@ -601,13 +601,13 @@ 
     private function extractAndProcessMetadata(string $dmdId, string $mdSectionType, array &$metadata, int $cPid, array $metadataSections): bool
     {
         if ($this->hasMetadataSection($metadataSections, $mdSectionType, 'dmdSec')) {
-            return true;
+            return TRUE;
         }
 
         $metadataExtracted = $this->extractMetadataIfTypeSupported($dmdId, $mdSectionType, $metadata);
 
         if (!$metadataExtracted) {
-            return false;
+            return FALSE;
         }
 
         $additionalMetadata = $this->getAdditionalMetadataFromDatabase($cPid, $dmdId);
@@ -618,7 +618,7 @@ 
 
         $this->processAdditionalMetadata($additionalMetadata, $domXPath, $domNode, $metadata);
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -783,7 +783,7 @@ 
                     $obj = GeneralUtility::makeInstance($class);
                     if ($obj instanceof MetadataInterface) {
                         $obj->extractMetadata($this->mdSec[$dmdId]['xml'], $metadata, GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'general')['useExternalApisForMetadata']);
-                        return true;
+                        return TRUE;
                     }
                 } else {
                     $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
@@ -792,7 +792,7 @@ 
         } else {
             $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -992,16 +992,16 @@ 
     protected function loadLocation(string $location): bool
     {
         $fileResource = Helper::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $xml = Helper::getXmlFileAsString($fileResource);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -1023,9 +1023,9 @@ 
 
         if ($preloadedDocument instanceof SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -1051,7 +1051,7 @@ 
             foreach ($this->mets->xpath('./mets:dmdSec') as $dmdSecTag) {
                 $dmdSec = $this->processMdSec($dmdSecTag);
 
-                if ($dmdSec !== null) {
+                if ($dmdSec !== NULL) {
                     $this->mdSec[$dmdSec['id']] = $dmdSec;
                     $this->dmdSec[$dmdSec['id']] = $dmdSec;
                 }
@@ -1068,7 +1068,7 @@ 
                     // TODO: Should we check that the format may occur within this type (e.g., to ignore VIDEOMD within rightsMD)?
                     $mdSec = $this->processMdSec($mdSecTag);
 
-                    if ($mdSec !== null) {
+                    if ($mdSec !== NULL) {
                         $this->mdSec[$mdSec['id']] = $mdSec;
 
                         $childIds[] = $mdSec['id'];
@@ -1081,7 +1081,7 @@ 
                 }
             }
 
-            $this->mdSecLoaded = true;
+            $this->mdSecLoaded = TRUE;
         }
         return $this->mdSec;
     }
@@ -1112,7 +1112,7 @@ 
     {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($element);
@@ -1130,7 +1130,7 @@ 
         }
 
         if (empty($xml)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($xml[0]);
@@ -1191,9 +1191,9 @@ 
                 !empty($extConf['fileGrpFulltext'])
                 && array_intersect(GeneralUtility::trimExplode(',', $extConf['fileGrpFulltext']), $this->fileGrps) !== []
             ) {
-                $this->hasFulltext = true;
+                $this->hasFulltext = TRUE;
             }
-            $this->fileGrpsLoaded = true;
+            $this->fileGrpsLoaded = TRUE;
         }
         return $this->fileGrps;
     }
@@ -1254,7 +1254,7 @@ 
 
                 $this->physicalStructure = $this->getPhysicalElements($elementNodes, $fileUse);
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -1342,7 +1342,7 @@ 
                     $this->smLinks['p2l'][(string) $smLink->attributes('http://www.w3.org/1999/xlink')->to][] = (string) $smLink->attributes('http://www.w3.org/1999/xlink')->from;
                 }
             }
-            $this->smLinksLoaded = true;
+            $this->smLinksLoaded = TRUE;
         }
         return $this->smLinks;
     }
@@ -1350,7 +1350,7 @@ 
     /**
      * @see AbstractDocument::magicGetThumbnail()
      */
-    protected function magicGetThumbnail(bool $forceReload = false): string
+    protected function magicGetThumbnail(bool $forceReload = FALSE): string
     {
         if (
             !$this->thumbnailLoaded
@@ -1360,14 +1360,14 @@ 
             $cPid = $this->cPid ?: $this->pid;
             if (!$cPid) {
                 $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             // Load extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
             if (empty($extConf['fileGrpThumbs'])) {
                 $this->logger->warning('No fileGrp for thumbnails specified');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->magicGetToplevelId();
@@ -1421,7 +1421,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1499,8 +1499,8 @@ 
     public function __toString(): string
     {
         $xml = new \DOMDocument('1.0', 'utf-8');
-        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
-        $xml->formatOutput = true;
+        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), TRUE));
+        $xml->formatOutput = TRUE;
         return $xml->saveXML();
     }
 
@@ -1515,7 +1515,7 @@ 
     public function __wakeup(): void
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.

Classes/Common/Helper.php

Braces +9 added lines, -18 removed lines

@@ -38,8 +38,7 @@ 
  *
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * @access public
      * @static
@@ -199,8 +198,7 @@ 
      *
      * @return mixed The decrypted value or false on error
      */
-    public static function decrypt(string $encrypted)
-    {
+    public static function decrypt(string $encrypted) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -240,8 +238,7 @@ 
      *
      * @return \SimpleXMLElement|false
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
@@ -313,8 +310,7 @@ 
      *
      * @return mixed Hashed string or false on error
      */
-    public static function digest(string $string)
-    {
+    public static function digest(string $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;
@@ -334,8 +330,7 @@ 
      *
      * @return mixed Encrypted string or false on error
      */
-    public static function encrypt(string $string)
-    {
+    public static function encrypt(string $string) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -705,8 +700,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
-    {
+    public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false) {
         $context = GeneralUtility::makeInstance(Context::class);
 
         if (
@@ -945,8 +939,7 @@ 
      *
      * @return void
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 
@@ -977,8 +970,7 @@ 
      *
      * @return string|bool
      */
-    public static function getUrl(string $url)
-    {
+    public static function getUrl(string $url) {
         if (!Helper::isValidHttpUrl($url)) {
             return false;
         }
@@ -1059,8 +1051,7 @@ 
      *
      * @return mixed
      */
-    private static function getLocalConfigurationByPath(string $path)
-    {
+    private static function getLocalConfigurationByPath(string $path) {
         $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
         return $configurationManager->getLocalConfigurationValueByPath($path);
     }

Spacing +31 added lines, -31 removed lines

@@ -148,7 +148,7 @@ 
                 } elseif ($checksum == 10) {
                     //TODO: Binary operation "+" between string and 1 results in an error.
                     // @phpstan-ignore-next-line
-                    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;
                 }
@@ -354,7 +354,7 @@ 
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialization vector and encrypted data.
         if ($encrypted !== false) {
-            $encrypted = base64_encode($iv . $encrypted);
+            $encrypted = base64_encode($iv.$encrypted);
         }
         return $encrypted;
     }
@@ -396,8 +396,8 @@ 
     public static function getHookObjects(string $scriptRelPath): array
     {
         $hookObjects = [];
-        if (is_array(self::getOptions()[self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
-            foreach (self::getOptions()[self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
+        if (is_array(self::getOptions()[self::$extKey.'/'.$scriptRelPath]['hookClass'])) {
+            foreach (self::getOptions()[self::$extKey.'/'.$scriptRelPath]['hookClass'] as $classRef) {
                 $hookObjects[] = GeneralUtility::makeInstance($classRef);
             }
         }
@@ -426,12 +426,12 @@ 
             // NOTE: Only use tables that don't have too many entries!
             || !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 '';
         }
 
-        $makeCacheKey = function ($pid, $uid) {
-            return $pid . '.' . $uid;
+        $makeCacheKey = function($pid, $uid) {
+            return $pid.'.'.$uid;
         };
 
         static $cache = [];
@@ -441,9 +441,9 @@ 
 
             $result = $queryBuilder
                 ->select(
-                    $table . '.index_name AS index_name',
-                    $table . '.uid AS uid',
-                    $table . '.pid AS pid',
+                    $table.'.index_name AS index_name',
+                    $table.'.uid AS uid',
+                    $table.'.pid AS pid',
                 )
                 ->from($table)
                 ->execute();
@@ -461,7 +461,7 @@ 
         $result = $cache[$table][$cacheKey] ?? '';
 
         if ($result === '') {
-            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 $result;
@@ -490,11 +490,11 @@ 
             // No ISO code, return unchanged.
             return $code;
         }
-        $lang = LocalizationUtility::translate('LLL:' . $file . ':' . $code);
+        $lang = LocalizationUtility::translate('LLL:'.$file.':'.$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;
         }
     }
@@ -658,7 +658,7 @@ 
         // Sanitize input.
         $pid = max((int) $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 $indexName;
         }
         /** @var PageRepository $pageRepository */
@@ -681,13 +681,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($indexName)),
+                $queryBuilder->expr()->eq($table.'.pid', $pid),
+                $queryBuilder->expr()->eq($table.'.index_name', $queryBuilder->expr()->literal($indexName)),
                 self::whereExpression($table, true)
             )
             ->setMaxResults(1)
@@ -698,12 +698,12 @@ 
         if ($row) {
             // Now we use the uid of the l18_parent to fetch the index_name of the translated content element.
             $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', $row['l18n_parent']),
-                    $queryBuilder->expr()->eq($table . '.sys_language_uid', (int) $languageContentId),
+                    $queryBuilder->expr()->eq($table.'.pid', $pid),
+                    $queryBuilder->expr()->eq($table.'.uid', $row['l18n_parent']),
+                    $queryBuilder->expr()->eq($table.'.sys_language_uid', (int) $languageContentId),
                     self::whereExpression($table, true)
                 )
                 ->setMaxResults(1)
@@ -721,14 +721,14 @@ 
         if (empty($labels[$table][$pid][$languageContentId][$indexName])) {
             // 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 ($languageContentId > 0) {
                     $additionalWhere = $queryBuilder->expr()->andX(
                         $queryBuilder->expr()->orX(
-                            $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]),
-                            $queryBuilder->expr()->eq($table . '.sys_language_uid', (int) $languageContentId)
+                            $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]),
+                            $queryBuilder->expr()->eq($table.'.sys_language_uid', (int) $languageContentId)
                         ),
-                        $queryBuilder->expr()->eq($table . '.l18n_parent', 0)
+                        $queryBuilder->expr()->eq($table.'.l18n_parent', 0)
                     );
                 }
 
@@ -737,7 +737,7 @@ 
                     ->select('*')
                     ->from($table)
                     ->where(
-                        $queryBuilder->expr()->eq($table . '.pid', $pid),
+                        $queryBuilder->expr()->eq($table.'.pid', $pid),
                         $additionalWhere,
                         self::whereExpression($table, true)
                     )
@@ -755,10 +755,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);
             }
         }
 
@@ -804,7 +804,7 @@ 
             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', LOG_SEVERITY_ERROR);
             return '1=-1';
@@ -870,7 +870,7 @@ 
         try {
             $response = $requestFactory->request($url, 'GET', $configuration);
         } catch (\Exception $e) {
-            self::log('Could not fetch data from URL "' . $url . '". Error: ' . $e->getMessage() . '.', LOG_SEVERITY_WARNING);
+            self::log('Could not fetch data from URL "'.$url.'". Error: '.$e->getMessage().'.', LOG_SEVERITY_WARNING);
             return false;
         }
         return $response->getBody()->getContents();

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

@@ -87,7 +87,7 @@ 
      *
      * @return FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage(string $message, string $title, int $severity, bool $session = false, string $queue = 'kitodo.default.flashMessages'): FlashMessageQueue
+    public static function addMessage(string $message, string $title, int $severity, bool $session = FALSE, string $queue = 'kitodo.default.flashMessages'): FlashMessageQueue
     {
         $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
@@ -126,9 +126,9 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/\d{8}[\dX]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'ZDB':
@@ -136,21 +136,21 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/\d{8}-[\dX]{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('/\d{8}-\d{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif ($checksum == 10) {
                     //TODO: Binary operation "+" between string and 1 results in an error.
                     // @phpstan-ignore-next-line
                     return self::checkIdentifier(($digits + 1) . substr($id, -2, 2), 'SWD');
                 } elseif (substr($id, -1, 1) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'GKD':
@@ -159,13 +159,13 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/\d{8}-[\dX]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -202,28 +202,28 @@ 
     public static function decrypt(string $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(self::getEncryptionKey())) {
             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(self::getEncryptionKey(), self::$hashAlgorithm, true);
+        $key = openssl_digest(self::getEncryptionKey(), self::$hashAlgorithm, TRUE);
         // Decrypt data.
         return openssl_decrypt($data, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
     }
@@ -245,15 +245,15 @@ 
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
-            return false;
+            return FALSE;
         }
 
         // Turn off libxml's error logging.
-        $libxmlErrors = libxml_use_internal_errors(true);
+        $libxmlErrors = libxml_use_internal_errors(TRUE);
 
         if (\PHP_VERSION_ID < 80000) {
             // 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.
@@ -315,9 +315,9 @@ 
      */
     public static function digest(string $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.
         return openssl_digest($string, self::$hashAlgorithm);
@@ -337,23 +337,23 @@ 
     public static function encrypt(string $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(self::getEncryptionKey())) {
             self::log('No encryption key set in TYPO3 configuration', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Generate random initialization vector.
         $iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length(self::$cipherAlgorithm));
-        $key = openssl_digest(self::getEncryptionKey(), self::$hashAlgorithm, true);
+        $key = openssl_digest(self::getEncryptionKey(), self::$hashAlgorithm, TRUE);
         // Encrypt data.
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialization vector and encrypted data.
-        if ($encrypted !== false) {
+        if ($encrypted !== FALSE) {
             $encrypted = base64_encode($iv . $encrypted);
         }
         return $encrypted;
@@ -554,7 +554,7 @@ 
     public static function isValidHttpUrl(string $url): bool
     {
         if (!GeneralUtility::isValidUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         try {
@@ -562,7 +562,7 @@ 
             return !empty($uri->getScheme());
         } catch (\InvalidArgumentException $e) {
             self::log($e->getMessage(), LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -578,7 +578,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
+    public static function processDatabaseAsAdmin(array $data = [], array $cmd = [], $reverseOrder = FALSE, $cmdFirst = FALSE)
     {
         $context = GeneralUtility::makeInstance(Context::class);
 
@@ -589,7 +589,7 @@ 
             // Instantiate TYPO3 core engine.
             $dataHandler = GeneralUtility::makeInstance(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.
@@ -688,7 +688,7 @@ 
             ->where(
                 $queryBuilder->expr()->eq($table . '.pid', $pid),
                 $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($indexName)),
-                self::whereExpression($table, true)
+                self::whereExpression($table, TRUE)
             )
             ->setMaxResults(1)
             ->execute();
@@ -704,7 +704,7 @@ 
                     $queryBuilder->expr()->eq($table . '.pid', $pid),
                     $queryBuilder->expr()->eq($table . '.uid', $row['l18n_parent']),
                     $queryBuilder->expr()->eq($table . '.sys_language_uid', (int) $languageContentId),
-                    self::whereExpression($table, true)
+                    self::whereExpression($table, TRUE)
                 )
                 ->setMaxResults(1)
                 ->execute();
@@ -739,7 +739,7 @@ 
                     ->where(
                         $queryBuilder->expr()->eq($table . '.pid', $pid),
                         $additionalWhere,
-                        self::whereExpression($table, true)
+                        self::whereExpression($table, TRUE)
                     )
                     ->setMaxResults(10000)
                     ->execute();
@@ -781,7 +781,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression(string $table, bool $showHidden = false): string
+    public static function whereExpression(string $table, bool $showHidden = FALSE): string
     {
         // TODO: Check with applicationType; TYPO3_MODE is removed in v12
         if (\TYPO3_MODE === 'FE') {
@@ -853,7 +853,7 @@ 
     public static function getUrl(string $url)
     {
         if (!Helper::isValidHttpUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         // Get extension configuration.
@@ -871,7 +871,7 @@ 
             $response = $requestFactory->request($url, 'GET', $configuration);
         } catch (\Exception $e) {
             self::log('Could not fetch data from URL "' . $url . '". Error: ' . $e->getMessage() . '.', LOG_SEVERITY_WARNING);
-            return false;
+            return FALSE;
         }
         return $response->getBody()->getContents();
     }