Erikmitk / kitodo-presentation

Classes/Common/MetsDocument.php

Spacing +29 added lines, -29 removed lines

@@ -169,7 +169,7 @@ 
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
-            $fileLocation = (strrpos($fileLocation, 'info.json') === strlen($fileLocation) - 9) ? $fileLocation : (strrpos($fileLocation, '/') === strlen($fileLocation) ? $fileLocation . 'info.json' : $fileLocation . '/info.json');
+            $fileLocation = (strrpos($fileLocation, 'info.json') === strlen($fileLocation) - 9) ? $fileLocation : (strrpos($fileLocation, '/') === strlen($fileLocation) ? $fileLocation.'info.json' : $fileLocation.'/info.json');
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
             IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
@@ -179,9 +179,9 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($fileMimeType === 'application/vnd.netfpx') {
-            $baseURL = $fileLocation . (strpos($fileLocation, '?') === false ? '?' : '');
+            $baseURL = $fileLocation.(strpos($fileLocation, '?') === 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 $fileLocation;
     }
@@ -192,14 +192,14 @@ 
      */
     public function getFileLocation($id)
     {
-        $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 {
-            Helper::devLog('There is no file node with @ID "' . $id . '"', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('There is no file node with @ID "'.$id.'"', DEVLOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -210,14 +210,14 @@ 
      */
     public function getFileMimeType($id)
     {
-        $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 {
-            Helper::devLog('There is no file node with @ID "' . $id . '" or no MIME type specified', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('There is no file node with @ID "'.$id.'" or no MIME type specified', DEVLOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -238,7 +238,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');
@@ -378,7 +378,7 @@ 
             // Retain current PID.
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
         } elseif (!$cPid) {
-            Helper::devLog('Invalid PID ' . $cPid . ' for metadata definitions', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('Invalid PID '.$cPid.' for metadata definitions', DEVLOG_SEVERITY_WARNING);
             return [];
         }
         // Get metadata from parsed metadata array if available.
@@ -419,7 +419,7 @@ 
         if (!empty($this->logicalUnits[$id])) {
             $dmdIds = $this->logicalUnits[$id]['dmdId'];
         } else {
-            $dmdIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]/@DMDID');
+            $dmdIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]/@DMDID');
             $dmdIds = (string) $dmdIds[0];
         }
         if (!empty($dmdIds)) {
@@ -445,11 +445,11 @@ 
                     ) {
                         $obj->extractMetadata($this->dmdSec[$dmdId]['xml'], $metadata);
                     } else {
-                        Helper::devLog('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->dmdSec[$dmdId]['type'] . '"', DEVLOG_SEVERITY_WARNING);
+                        Helper::devLog('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->dmdSec[$dmdId]['type'].'"', DEVLOG_SEVERITY_WARNING);
                     }
                 }
             } else {
-                Helper::devLog('Unsupported metadata format "' . $this->dmdSec[$dmdId]['type'] . '" in dmdSec with @ID "' . $dmdId . '"', DEVLOG_SEVERITY_NOTICE);
+                Helper::devLog('Unsupported metadata format "'.$this->dmdSec[$dmdId]['type'].'" in dmdSec with @ID "'.$dmdId.'"', DEVLOG_SEVERITY_NOTICE);
                 // Continue searching for supported metadata with next @DMDID.
                 continue;
             }
@@ -457,7 +457,7 @@ 
             if (!empty($this->logicalUnits[$id])) {
                 $metadata['type'] = [$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)) {
                     $metadata['type'] = [(string) $struct[0]];
                 }
@@ -574,13 +574,13 @@ 
                             $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];
                     }
                 }
             }
@@ -642,7 +642,7 @@ 
         if ($hasSupportedMetadata) {
             return $metadata;
         } else {
-            Helper::devLog('No supported metadata found for logical structure with @ID "' . $id . '"', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('No supported metadata found for logical structure with @ID "'.$id.'"', DEVLOG_SEVERITY_WARNING);
             return [];
         }
     }
@@ -672,7 +672,7 @@ 
      */
     public function getStructureDepth($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 {
@@ -694,7 +694,7 @@ 
             // Register namespaces.
             $this->registerNamespaces($this->mets);
         } else {
-            Helper::devLog('No METS part found in document with UID ' . $this->uid, DEVLOG_SEVERITY_ERROR);
+            Helper::devLog('No METS part found in document with UID '.$this->uid, DEVLOG_SEVERITY_ERROR);
         }
     }
 
@@ -722,7 +722,7 @@ 
                 return true;
             }
         }
-        Helper::devLog('Could not load XML file from "' . $location . '"', DEVLOG_SEVERITY_ERROR);
+        Helper::devLog('Could not load XML file from "'.$location.'"', DEVLOG_SEVERITY_ERROR);
         return false;
     }
 
@@ -746,7 +746,7 @@ 
     {
         $partof = 0;
         // 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->_getToplevelId() . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
+        $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$this->_getToplevelId().'"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
         if (!empty($parentMptr)) {
             $parentLocation = (string) $parentMptr[0]->attributes('http://www.w3.org/1999/xlink')->href;
             if ($parentLocation != $this->location) {
@@ -813,15 +813,15 @@ 
             $dmdIds = $this->mets->xpath('./mets:dmdSec/@ID');
             if (!empty($dmdIds)) {
                 foreach ($dmdIds as $dmdId) {
-                    if ($type = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[not(@MDTYPE="OTHER")]/@MDTYPE')) {
+                    if ($type = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[not(@MDTYPE="OTHER")]/@MDTYPE')) {
                         if (!empty($this->formats[(string) $type[0]])) {
                             $type = (string) $type[0];
-                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
                         }
-                    } elseif ($type = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="OTHER"]/@OTHERMDTYPE')) {
+                    } elseif ($type = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="OTHER"]/@OTHERMDTYPE')) {
                         if (!empty($this->formats[(string) $type[0]])) {
                             $type = (string) $type[0];
-                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
                         }
                     }
                     if (!empty($xml)) {
@@ -1006,7 +1006,7 @@ 
             // Retain current PID.
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
             if (!$cPid) {
-                Helper::devLog('Invalid PID ' . $cPid . ' for structure definitions', DEVLOG_SEVERITY_ERROR);
+                Helper::devLog('Invalid PID '.$cPid.' for structure definitions', DEVLOG_SEVERITY_ERROR);
                 $this->thumbnailLoaded = true;
                 return $this->thumbnail;
             }
@@ -1043,7 +1043,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];
                     }
@@ -1066,7 +1066,7 @@ 
                     }
                 }
             } else {
-                Helper::devLog('No structure of type "' . $metadata['type'][0] . '" found in database', DEVLOG_SEVERITY_ERROR);
+                Helper::devLog('No structure of type "'.$metadata['type'][0].'" found in database', DEVLOG_SEVERITY_ERROR);
             }
             $this->thumbnailLoaded = true;
         }

Braces +29 added lines, -58 removed lines

@@ -48,8 +48,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
  * @property-read mixed $uid This holds the UID or the URL of the document
  */
-final class MetsDocument extends Document
-{
+final class MetsDocument extends Document {
     /**
      * This holds the whole XML file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -128,8 +127,7 @@ 
      *
      * @return  void
      */
-    public function addMetadataFromMets(&$metadata, $id)
-    {
+    public function addMetadataFromMets(&$metadata, $id) {
         $details = $this->getLogicalStructure($id);
         if (!empty($details)) {
             $metadata['mets_order'][0] = $details['order'];
@@ -143,8 +141,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::establishRecordId()
      */
-    protected function establishRecordId($pid)
-    {
+    protected function establishRecordId($pid) {
         // Check for METS object @ID.
         if (!empty($this->mets['OBJID'])) {
             $this->recordId = (string) $this->mets['OBJID'];
@@ -164,8 +161,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
@@ -190,8 +186,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
@@ -208,8 +203,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
         if (
             !empty($id)
@@ -226,8 +220,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         // Is the requested logical unit already loaded?
         if (
@@ -267,8 +260,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false)
-    {
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false) {
         // Get attributes.
         foreach ($structure->attributes() as $attribute => $value) {
             $attributes[$attribute] = (string) $value;
@@ -366,8 +358,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getMetadata()
      */
-    public function getMetadata($id, $cPid = 0)
-    {
+    public function getMetadata($id, $cPid = 0) {
         // Make sure $cPid is a non-negative integer.
         $cPid = max(intval($cPid), 0);
         // If $cPid is not given, try to get it elsewhere.
@@ -651,8 +642,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getRawText()
      */
-    public function getRawText($id)
-    {
+    public function getRawText($id) {
         $rawText = '';
         // Get text from raw text array if available.
         if (!empty($this->rawTextArray[$id])) {
@@ -670,8 +660,7 @@ 
      * {@inheritDoc}
      * @see Document::getStructureDepth()
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
@@ -684,8 +673,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::init()
      */
-    protected function init()
-    {
+    protected function init() {
         // Get METS node from XML file.
         $this->registerNamespaces($this->xml);
         $mets = $this->xml->xpath('//mets:mets');
@@ -702,8 +690,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = GeneralUtility::getUrl($location);
         if ($fileResource !== false) {
             // Turn off libxml's error logging.
@@ -730,8 +717,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -742,8 +728,7 @@ 
      * {@inheritDoc}
      * @see Document::getParentDocumentUid()
      */
-    protected function getParentDocumentUidForSaving($pid, $core)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core) {
         $partof = 0;
         // 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->_getToplevelId() . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
@@ -766,8 +751,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -780,8 +764,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -792,8 +775,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -804,8 +786,7 @@ 
      *
      * @return array Array of dmdSecs with their IDs as array key
      */
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         if (!$this->dmdSecLoaded) {
             // Get available data formats.
             $this->loadFormats();
@@ -843,8 +824,7 @@ 
      *
      * @return array Array of file use groups with file IDs
      */
-    protected function _getFileGrps()
-    {
+    protected function _getFileGrps() {
         if (!$this->fileGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -889,8 +869,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $ids = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID]/@ID');
         // Get all logical structure nodes with metadata.
         if (!empty($ids)) {
@@ -908,8 +887,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -917,8 +895,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getPhysicalStructure()
      */
-    protected function _getPhysicalStructure()
-    {
+    protected function _getPhysicalStructure() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Does the document have a structMap node of type "PHYSICAL"?
@@ -978,8 +955,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded) {
             $smLinks = $this->mets->xpath('./mets:structLink/mets:smLink');
             if (!empty($smLinks)) {
@@ -997,8 +973,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1077,8 +1052,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             // Get all logical structure nodes with metadata, but without associated METS-Pointers.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID and not(./mets:mptr)]');
@@ -1110,8 +1084,7 @@ 
      *
      * @return array Properties to be serialized
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // \SimpleXMLElement objects can't be serialized, thus save the XML as string for serialization
         $this->asXML = $this->xml->asXML();
         return ['uid', 'pid', 'recordId', 'parentId', 'asXML'];
@@ -1124,8 +1097,7 @@ 
      *
      * @return string String representing the METS object
      */
-    public function __toString()
-    {
+    public function __toString() {
         $xml = new \DOMDocument('1.0', 'utf-8');
         $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
         $xml->formatOutput = true;
@@ -1140,8 +1112,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         // Turn off libxml's error logging.
         $libxmlErrors = libxml_use_internal_errors(true);
         // Reload XML from string.

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

@@ -74,7 +74,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $dmdSecLoaded = false;
+    protected $dmdSecLoaded = FALSE;
 
     /**
      * The extension key
@@ -100,7 +100,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $fileGrpsLoaded = false;
+    protected $fileGrpsLoaded = FALSE;
 
     /**
      * This holds the XML file's METS part as \SimpleXMLElement object
@@ -175,11 +175,11 @@ 
             IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
             IiifHelper::setMaxThumbnailWidth($conf['iiifThumbnailWidth']);
             $service = IiifHelper::loadIiifResource($fileLocation);
-            if ($service !== null && $service instanceof AbstractImageService) {
+            if ($service !== NULL && $service instanceof AbstractImageService) {
                 return $service->getImageUrl();
             }
         } elseif ($fileMimeType === 'application/vnd.netfpx') {
-            $baseURL = $fileLocation . (strpos($fileLocation, '?') === false ? '?' : '');
+            $baseURL = $fileLocation . (strpos($fileLocation, '?') === 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';
         }
@@ -226,7 +226,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
+    public function getLogicalStructure($id, $recursive = FALSE)
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -267,7 +267,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false)
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = FALSE)
     {
         // Get attributes.
         foreach ($structure->attributes() as $attribute => $value) {
@@ -312,7 +312,7 @@ 
             && array_key_exists($details['id'], $this->smLinks['l2p'])
         ) {
             // Link logical structure to the first corresponding physical page/track.
-            $details['points'] = max(intval(array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, true)), 1);
+            $details['points'] = max(intval(array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE)), 1);
             $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
             while ($fileGrpThumb = array_shift($fileGrpsThumb)) {
                 if (!empty($this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['files'][$fileGrpThumb])) {
@@ -356,7 +356,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;
@@ -425,7 +425,7 @@ 
         if (!empty($dmdIds)) {
             // Handle multiple DMDIDs separately.
             $dmdIds = explode(' ', $dmdIds);
-            $hasSupportedMetadata = false;
+            $hasSupportedMetadata = FALSE;
         } else {
             // There is no dmdSec for this structure node.
             return [];
@@ -636,7 +636,7 @@ 
                 }
             }
             // Extract metadata only from first supported dmdSec.
-            $hasSupportedMetadata = true;
+            $hasSupportedMetadata = TRUE;
             break;
         }
         if ($hasSupportedMetadata) {
@@ -705,11 +705,11 @@ 
     protected function loadLocation($location)
     {
         $fileResource = GeneralUtility::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             // 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);
             // Load XML from file.
             $xml = simplexml_load_string($fileResource);
             // reset entity loader setting
@@ -717,13 +717,13 @@ 
             // Reset libxml's error logging.
             libxml_use_internal_errors($libxmlErrors);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         Helper::devLog('Could not load XML file from "' . $location . '"', DEVLOG_SEVERITY_ERROR);
-        return false;
+        return FALSE;
     }
 
     /**
@@ -771,9 +771,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -831,7 +831,7 @@ 
                     }
                 }
             }
-            $this->dmdSecLoaded = true;
+            $this->dmdSecLoaded = TRUE;
         }
         return $this->dmdSec;
     }
@@ -878,9 +878,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;
     }
@@ -969,7 +969,7 @@ 
                     $this->physicalStructure = array_merge($physSeq, $elements);
                 }
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -988,7 +988,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;
     }
@@ -997,7 +997,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
+    protected function _getThumbnail($forceReload = FALSE)
     {
         if (
             !$this->thumbnailLoaded
@@ -1007,14 +1007,14 @@ 
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
             if (!$cPid) {
                 Helper::devLog('Invalid PID ' . $cPid . ' for structure definitions', DEVLOG_SEVERITY_ERROR);
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             // Load extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             if (empty($extConf['fileGrpThumbs'])) {
                 Helper::devLog('No fileGrp for thumbnails specified', DEVLOG_SEVERITY_WARNING);
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->_getToplevelId();
@@ -1068,7 +1068,7 @@ 
             } else {
                 Helper::devLog('No structure of type "' . $metadata['type'][0] . '" found in database', DEVLOG_SEVERITY_ERROR);
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1127,8 +1127,8 @@ 
     public function __toString()
     {
         $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();
     }
 
@@ -1143,12 +1143,12 @@ 
     public function __wakeup()
     {
         // Turn off libxml's error logging.
-        $libxmlErrors = libxml_use_internal_errors(true);
+        $libxmlErrors = libxml_use_internal_errors(TRUE);
         // Reload XML from string.
         $xml = @simplexml_load_string($this->asXML);
         // Reset libxml's error logging.
         libxml_use_internal_errors($libxmlErrors);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.

Classes/Common/AbstractModule.php

Spacing +4 added lines, -4 removed lines

@@ -100,9 +100,9 @@ 
     protected function printContent()
     {
         $this->doc = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Template\DocumentTemplate::class);
-        $this->doc->setModuleTemplate('EXT:' . $this->extKey . '/Resources/Private/Templates/' . Helper::getUnqualifiedClassName(get_class($this)) . '.tmpl');
+        $this->doc->setModuleTemplate('EXT:'.$this->extKey.'/Resources/Private/Templates/'.Helper::getUnqualifiedClassName(get_class($this)).'.tmpl');
         $this->doc->backPath = $GLOBALS['BACK_PATH'];
-        $this->doc->bodyTagAdditions = 'class="ext-' . $this->extKey . '-modules"';
+        $this->doc->bodyTagAdditions = 'class="ext-'.$this->extKey.'-modules"';
         $this->doc->form = '<form action="" method="post" enctype="multipart/form-data">';
         // Add Javascript for function menu.
         $this->doc->JScode .= '<script type="text/javascript">script_ended = 0;function jumpToUrl(URL) { document.location = URL; }</script>';
@@ -112,7 +112,7 @@ 
         $this->content .= $this->doc->startPage($GLOBALS['LANG']->getLL('title'));
         // Set defaults for menu.
         if (empty($this->markerArray['CSH'])) {
-            $this->markerArray['CSH'] = \TYPO3\CMS\Backend\Utility\BackendUtility::cshItem('_MOD_' . $GLOBALS['MCONF']['name'], 'csh');
+            $this->markerArray['CSH'] = \TYPO3\CMS\Backend\Utility\BackendUtility::cshItem('_MOD_'.$GLOBALS['MCONF']['name'], 'csh');
         }
         if (empty($this->markerArray['MOD_MENU'])) {
             $this->markerArray['MOD_MENU'] = \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncMenu($this->id, 'SET[function]', $this->MOD_SETTINGS['function'], $this->MOD_MENU['function']);
@@ -131,7 +131,7 @@ 
      */
     public function __construct()
     {
-        $GLOBALS['LANG']->includeLLFile('EXT:' . $this->extKey . '/Resources/Private/Language/' . Helper::getUnqualifiedClassName(get_class($this)) . '.xml');
+        $GLOBALS['LANG']->includeLLFile('EXT:'.$this->extKey.'/Resources/Private/Language/'.Helper::getUnqualifiedClassName(get_class($this)).'.xml');
         $this->conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get($this->extKey);
         $this->data = GeneralUtility::_GPmerged($this->prefixId);
     }

Braces +3 added lines, -6 removed lines

@@ -24,8 +24,7 @@ 
  * @access public
  * @abstract
  */
-abstract class AbstractModule extends \TYPO3\CMS\Backend\Module\BaseScriptClass
-{
+abstract class AbstractModule extends \TYPO3\CMS\Backend\Module\BaseScriptClass {
     public $extKey = 'dlf';
     public $prefixId = 'tx_dlf';
 
@@ -97,8 +96,7 @@ 
      *
      * @return string
      */
-    protected function printContent()
-    {
+    protected function printContent() {
         $this->doc = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Template\DocumentTemplate::class);
         $this->doc->setModuleTemplate('EXT:' . $this->extKey . '/Resources/Private/Templates/' . Helper::getUnqualifiedClassName(get_class($this)) . '.tmpl');
         $this->doc->backPath = $GLOBALS['BACK_PATH'];
@@ -129,8 +127,7 @@ 
      *
      * @return void
      */
-    public function __construct()
-    {
+    public function __construct() {
         $GLOBALS['LANG']->includeLLFile('EXT:' . $this->extKey . '/Resources/Private/Language/' . Helper::getUnqualifiedClassName(get_class($this)) . '.xml');
         $this->conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get($this->extKey);
         $this->data = GeneralUtility::_GPmerged($this->prefixId);

Classes/Common/Document.php

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

@@ -93,7 +93,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $formatsLoaded = false;
+    protected $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -103,7 +103,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltext = false;
+    protected $hasFulltext = FALSE;
 
     /**
      * Last searched logical and physical page
@@ -111,7 +111,7 @@ 
      * @var array
      * @access protected
      */
-    protected $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * This holds the documents location
@@ -145,7 +145,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $metadataArrayLoaded = false;
+    protected $metadataArrayLoaded = FALSE;
 
     /**
      * The holds the total number of pages
@@ -186,7 +186,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $physicalStructureLoaded = false;
+    protected $physicalStructureLoaded = FALSE;
 
     /**
      * This holds the PID of the document or zero if not in database
@@ -211,7 +211,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * The METS file's / IIIF manifest's record identifier
@@ -245,7 +245,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $rootIdLoaded = false;
+    protected $rootIdLoaded = FALSE;
 
     /**
      * This holds the smLinks between logical and physical structMap
@@ -262,7 +262,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $smLinksLoaded = false;
+    protected $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -279,7 +279,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $tableOfContentsLoaded = false;
+    protected $tableOfContentsLoaded = FALSE;
 
     /**
      * This holds the document's thumbnail location
@@ -296,7 +296,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)
@@ -413,7 +413,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);
@@ -453,10 +453,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)
@@ -505,27 +505,27 @@ 
                     @ini_set('user_agent', $extConf['useragent']);
                 }
                 $content = GeneralUtility::getUrl($location);
-                if ($content !== false) {
+                if ($content !== FALSE) {
                     // TODO use single place to load xml
                     // 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
                     libxml_disable_entity_loader($previousValueOfEntityLoader);
                     // Reset libxml's error logging.
                     libxml_use_internal_errors($libxmlErrors);
-                    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());
@@ -579,7 +579,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
@@ -616,7 +616,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;
@@ -669,11 +669,11 @@ 
                 if (!empty($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext])) {
                     // Get fulltext file.
                     $file = GeneralUtility::getUrl($this->getFileLocation($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext]));
-                    if ($file !== false) {
+                    if ($file !== FALSE) {
                         // 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);
                         // Load XML from file.
                         $rawTextXml = simplexml_load_string($file);
                         // Reset entity loader setting.
@@ -729,7 +729,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.
@@ -762,7 +762,7 @@ 
                     && intval($partof)
                     && $partof != $uid
                 ) {
-                    $title = self::getTitle($partof, true);
+                    $title = self::getTitle($partof, TRUE);
                 }
             } else {
                 Helper::devLog('No document with UID ' . $uid . ' found or document not accessible', DEVLOG_SEVERITY_WARNING);
@@ -823,12 +823,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;
     }
 
     /**
@@ -905,7 +905,7 @@ 
         } else {
             Helper::devLog('Invalid file location "' . $location . '" for document loading', DEVLOG_SEVERITY_ERROR);
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -952,7 +952,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -998,7 +998,7 @@ 
     {
         if (\TYPO3_MODE !== 'BE') {
             Helper::devLog('Saving a document is only allowed in the backend', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Make sure $pid is a non-negative integer.
         $pid = max(intval($pid), 0);
@@ -1013,7 +1013,7 @@ 
             $pid = $this->pid;
         } elseif (!$pid) {
             Helper::devLog('Invalid PID ' . $pid . ' for document saving', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Set PID for metadata definitions.
         $this->cPid = $pid;
@@ -1026,7 +1026,7 @@ 
         // Check for record identifier.
         if (empty($metadata['record_id'][0])) {
             Helper::devLog('No record identifier found to avoid duplication', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Load plugin configuration.
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -1050,7 +1050,7 @@ 
             $structure = $resArray['uid'];
         } else {
             Helper::devLog('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         $metadata['type'][0] = $structure;
 
@@ -1107,9 +1107,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
                     );
                 }
             }
@@ -1158,9 +1158,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
                 );
             }
         }
@@ -1246,7 +1246,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],
@@ -1282,9 +1282,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.
@@ -1293,7 +1293,7 @@ 
         } else {
             Helper::devLog('Invalid UID "' . $core . '" for Solr core', DEVLOG_SEVERITY_NOTICE);
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -1366,7 +1366,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1475,7 +1475,7 @@ 
                 $parent = self::getInstance($this->parentId, $this->pid);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1504,8 +1504,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;
     }
@@ -1521,7 +1521,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
@@ -1602,7 +1602,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);
@@ -1660,30 +1660,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 {
             Helper::devLog('No document with UID ' . $uid . ' found or document not accessible', DEVLOG_SEVERITY_ERROR);
         }

Classes/Common/IiifManifest.php

Braces +28 added lines, -56 removed lines

@@ -56,8 +56,7 @@ 
  * @property-read string $toplevelId This holds the toplevel manifest's @id
  * @property-read mixed $uid This holds the UID or the URL of the document
  */
-final class IiifManifest extends Document
-{
+final class IiifManifest extends Document {
     /**
      * This holds the manifest file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -118,8 +117,7 @@ 
      * {@inheritDoc}
      * @see Document::establishRecordId()
      */
-    protected function establishRecordId($pid)
-    {
+    protected function establishRecordId($pid) {
         if ($this->iiif !== null) {
             /*
              *  FIXME This will not consistently work because we can not be sure to have the pid at hand. It may miss
@@ -170,8 +168,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->iiif;
     }
 
@@ -184,8 +181,7 @@ 
      * @return string 'IIIF1' if the resource is a Metadata API 1 resource, 'IIIF2' / 'IIIF3' if
      * the resource is a Presentation API 2 / 3 resource
      */
-    public function getIiifVersion()
-    {
+    public function getIiifVersion() {
         if (!isset($this->iiifVersion)) {
             if ($this->iiif instanceof AbstractIiifResource1) {
                 $this->iiifVersion = 'IIIF1';
@@ -226,8 +222,7 @@ 
      *
      * @return array|string
      */
-    protected function getUseGroups($use)
-    {
+    protected function getUseGroups($use) {
         if (!$this->useGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -255,8 +250,7 @@ 
      * {@inheritDoc}
      * @see Document::_getPhysicalStructure()
      */
-    protected function _getPhysicalStructure()
-    {
+    protected function _getPhysicalStructure() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             if ($this->iiif == null || !($this->iiif instanceof ManifestInterface)) {
@@ -369,8 +363,7 @@ 
      * {@inheritDoc}
      * @see Document::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileLocation = $this->getFileLocation($id);
         $resource = $this->iiif->getContainedResourceById($fileLocation);
         if ($resource instanceof AbstractImageService) {
@@ -383,8 +376,7 @@ 
      * {@inheritDoc}
      * @see Document::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         if ($id == null) {
             return null;
         }
@@ -408,8 +400,7 @@ 
      * {@inheritDoc}
      * @see Document::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $fileResource = $this->iiif->getContainedResourceById($id);
         if ($fileResource instanceof CanvasInterface) {
             $format = "application/vnd.kitodo.iiif";
@@ -434,8 +425,7 @@ 
      * {@inheritDoc}
      * @see Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         if (!$recursive && !empty($this->logicalUnits[$id])) {
             return $this->logicalUnits[$id];
@@ -470,8 +460,7 @@ 
      * @param array $processedStructures: IIIF resources that already have been processed
      * @return array Logical structure array
      */
-    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = false, &$processedStructures = [])
-    {
+    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = false, &$processedStructures = []) {
         $details = [];
         $details['id'] = $resource->getId();
         $details['dmdId'] = '';
@@ -563,8 +552,7 @@ 
      *
      * @todo This method is still in experimental; the method signature may change.
      */
-    public function getManifestMetadata($id, $cPid = 0, $withDescription = true, $withRights = true, $withRelated = true)
-    {
+    public function getManifestMetadata($id, $cPid = 0, $withDescription = true, $withRights = true, $withRelated = true) {
         if (!empty($this->originalMetadataArray[$id])) {
             return $this->originalMetadataArray[$id];
         }
@@ -606,8 +594,7 @@ 
      * {@inheritDoc}
      * @see Document::getMetadata()
      */
-    public function getMetadata($id, $cPid = 0)
-    {
+    public function getMetadata($id, $cPid = 0) {
         if (!empty($this->metadataArray[$id]) && $this->metadataArray[0] == $cPid) {
             return $this->metadataArray[$id];
         }
@@ -714,8 +701,7 @@ 
      * {@inheritDoc}
      * @see Document::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded && isset($this->iiif) && $this->iiif instanceof ManifestInterface) {
             if (!empty($this->iiif->getDefaultCanvases())) {
                 foreach ($this->iiif->getDefaultCanvases() as $canvas) {
@@ -739,8 +725,7 @@ 
      *
      * @param RangeInterface $range: Current range whose canvases shall be linked
      */
-    private function smLinkRangeCanvasesRecursively(RangeInterface $range)
-    {
+    private function smLinkRangeCanvasesRecursively(RangeInterface $range) {
         // map range's canvases including all child ranges' canvases
         if (!$range->isTopRange()) {
             foreach ($range->getAllCanvasesRecursively() as $canvas) {
@@ -763,8 +748,7 @@ 
      * @param CanvasInterface $canvas
      * @param IiifResourceInterface $resource
      */
-    private function smLinkCanvasToResource(CanvasInterface $canvas, IiifResourceInterface $resource)
-    {
+    private function smLinkCanvasToResource(CanvasInterface $canvas, IiifResourceInterface $resource) {
         $this->smLinks['l2p'][$resource->getId()][] = $canvas->getId();
         if (!is_array($this->smLinks['p2l'][$canvas->getId()]) || !in_array($resource->getId(), $this->smLinks['p2l'][$canvas->getId()])) {
             $this->smLinks['p2l'][$canvas->getId()][] = $resource->getId();
@@ -779,8 +763,7 @@ 
      *
      * @see Document::getParentDocumentUidForSaving()
      */
-    protected function getParentDocumentUidForSaving($pid, $core)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core) {
         // Do nothing.
     }
 
@@ -788,8 +771,7 @@ 
      * {@inheritDoc}
      * @see Document::getRawText()
      */
-    public function getRawText($id)
-    {
+    public function getRawText($id) {
         $rawText = '';
         // Get text from raw text array if available.
         if (!empty($this->rawTextArray[$id])) {
@@ -846,8 +828,7 @@ 
      *
      * @return IiifResourceInterface
      */
-    public function getIiif()
-    {
+    public function getIiif() {
         return $this->iiif;
     }
 
@@ -855,8 +836,7 @@ 
      * {@inheritDoc}
      * @see Document::init()
      */
-    protected function init()
-    {
+    protected function init() {
         // Nothing to do here, at the moment
     }
 
@@ -864,8 +844,7 @@ 
      * {@inheritDoc}
      * @see Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = GeneralUtility::getUrl($location);
         if ($fileResource !== false) {
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -888,8 +867,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $id = $this->iiif->getId();
         $this->metadataArray[(string) $id] = $this->getMetadata((string) $id, $cPid);
     }
@@ -898,8 +876,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
         if ($preloadedDocument instanceof ManifestInterface) {
             $this->iiif = $preloadedDocument;
             return true;
@@ -911,8 +888,7 @@ 
      * {@inheritDoc}
      * @see Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         /*
          *  TODO Check annotations and annotation lists of canvas for ALTO documents.
          *  Example:
@@ -958,8 +934,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         return $this->iiif->getThumbnailUrl();
     }
 
@@ -967,8 +942,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             if (isset($this->iiif)) {
                 $this->toplevelId = $this->iiif->getId();
@@ -985,8 +959,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
         IiifHelper::setUrlReader(IiifUrlReader::getInstance());
         IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
@@ -1005,8 +978,7 @@ 
      *
      * @return string[]
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // TODO implement serializiation in IIIF library
         $jsonArray = $this->iiif->getOriginalJsonArray();
         $this->asJson = json_encode($jsonArray);

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

@@ -87,7 +87,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltextSet = false;
+    protected $hasFulltextSet = FALSE;
 
     /**
      * This holds the original manifest's parsed metadata array with their corresponding
@@ -120,7 +120,7 @@ 
      */
     protected function establishRecordId($pid)
     {
-        if ($this->iiif !== null) {
+        if ($this->iiif !== NULL) {
             /*
              *  FIXME This will not consistently work because we can not be sure to have the pid at hand. It may miss
              *  if the plugin that actually loads the manifest allows content from other pages.
@@ -204,7 +204,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $useGrpsLoaded = false;
+    protected $useGrpsLoaded = FALSE;
 
     /**
      * Holds the configured useGrps as array.
@@ -246,7 +246,7 @@ 
             if (!empty($extConf['fileGrpAudio'])) {
                 $this->useGrps['fileGrpAudio'] = GeneralUtility::trimExplode(',', $extConf['fileGrpAudio']);
             }
-            $this->useGrpsLoaded = true;
+            $this->useGrpsLoaded = TRUE;
         }
         return array_key_exists($use, $this->useGrps) ? $this->useGrps[$use] : [];
     }
@@ -259,8 +259,8 @@ 
     {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
-            if ($this->iiif == null || !($this->iiif instanceof ManifestInterface)) {
-                return null;
+            if ($this->iiif == NULL || !($this->iiif instanceof ManifestInterface)) {
+                return NULL;
             }
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             $iiifId = $this->iiif->getId();
@@ -270,7 +270,7 @@ 
             $this->physicalStructureInfo[$physSeq[0]]['label'] = $this->iiif->getLabelForDisplay();
             $this->physicalStructureInfo[$physSeq[0]]['orderlabel'] = $this->iiif->getLabelForDisplay();
             $this->physicalStructureInfo[$physSeq[0]]['type'] = 'physSequence';
-            $this->physicalStructureInfo[$physSeq[0]]['contentIds'] = null;
+            $this->physicalStructureInfo[$physSeq[0]]['contentIds'] = NULL;
             $fileUseDownload = $this->getUseGroups('fileGrpDownload');
             $fileUseFulltext = $this->getUseGroups('fileGrpFulltext');
             $fileUseThumbs = $this->getUseGroups('fileGrpThumbs');
@@ -284,13 +284,13 @@ 
             if (!empty($fileUseFulltext)) {
                 $iiifAlto = $this->iiif->getSeeAlsoUrlsForFormat('application/alto+xml');
                 if (empty($iiifAlto)) {
-                    $iiifAlto = $this->iiif->getSeeAlsoUrlsForProfile('http://www.loc.gov/standards/alto/', true);
+                    $iiifAlto = $this->iiif->getSeeAlsoUrlsForProfile('http://www.loc.gov/standards/alto/', TRUE);
                 }
                 if (!empty($iiifAlto)) {
                     $this->mimeTypes[$iiifAlto[0]] = 'application/alto+xml';
                     $this->physicalStructureInfo[$physSeq[0]]['files'][$fileUseFulltext[0]] = $iiifAlto[0];
-                    $this->hasFulltext = true;
-                    $this->hasFulltextSet = true;
+                    $this->hasFulltext = TRUE;
+                    $this->hasFulltextSet = TRUE;
                 }
             }
             if (!empty($this->iiif->getDefaultCanvases())) {
@@ -309,39 +309,39 @@ 
                     // populate structural metadata info
                     $elements[$canvasOrder] = $canvas->getId();
                     $this->physicalStructureInfo[$elements[$canvasOrder]]['id'] = $canvas->getId();
-                    $this->physicalStructureInfo[$elements[$canvasOrder]]['dmdId'] = null;
+                    $this->physicalStructureInfo[$elements[$canvasOrder]]['dmdId'] = NULL;
                     $this->physicalStructureInfo[$elements[$canvasOrder]]['label'] = $canvas->getLabelForDisplay();
                     $this->physicalStructureInfo[$elements[$canvasOrder]]['orderlabel'] = $canvas->getLabelForDisplay();
                     // assume that a canvas always represents a page
                     $this->physicalStructureInfo[$elements[$canvasOrder]]['type'] = 'page';
-                    $this->physicalStructureInfo[$elements[$canvasOrder]]['contentIds'] = null;
-                    $this->physicalStructureInfo[$elements[$canvasOrder]]['annotationContainers'] = null;
+                    $this->physicalStructureInfo[$elements[$canvasOrder]]['contentIds'] = NULL;
+                    $this->physicalStructureInfo[$elements[$canvasOrder]]['annotationContainers'] = NULL;
                     if (!empty($canvas->getPossibleTextAnnotationContainers(Motivation::PAINTING))) {
                         $this->physicalStructureInfo[$elements[$canvasOrder]]['annotationContainers'] = [];
                         foreach ($canvas->getPossibleTextAnnotationContainers(Motivation::PAINTING) as $annotationContainer) {
                             $this->physicalStructureInfo[$elements[$canvasOrder]]['annotationContainers'][] = $annotationContainer->getId();
                             if ($extConf['indexAnnotations']) {
-                                $this->hasFulltext = true;
-                                $this->hasFulltextSet = true;
+                                $this->hasFulltext = TRUE;
+                                $this->hasFulltextSet = TRUE;
                             }
                         }
                     }
                     if (!empty($fileUseFulltext)) {
                         $alto = $canvas->getSeeAlsoUrlsForFormat('application/alto+xml');
                         if (empty($alto)) {
-                            $alto = $canvas->getSeeAlsoUrlsForProfile('http://www.loc.gov/standards/alto/', true);
+                            $alto = $canvas->getSeeAlsoUrlsForProfile('http://www.loc.gov/standards/alto/', TRUE);
                         }
                         if (!empty($alto)) {
                             $this->mimeTypes[$alto[0]] = 'application/alto+xml';
                             $this->physicalStructureInfo[$elements[$canvasOrder]]['files'][$fileUseFulltext[0]] = $alto[0];
-                            $this->hasFulltext = true;
-                            $this->hasFulltextSet = true;
+                            $this->hasFulltext = TRUE;
+                            $this->hasFulltextSet = TRUE;
                         }
                     }
                     if (!empty($fileUses)) {
                         $image = $canvas->getImageAnnotations()[0];
                         foreach ($fileUses as $fileUse) {
-                            if ($image->getBody() !== null && $image->getBody() instanceof ContentResourceInterface) {
+                            if ($image->getBody() !== NULL && $image->getBody() instanceof ContentResourceInterface) {
                                 $this->physicalStructureInfo[$elements[$canvasOrder]]['files'][$fileUse] = $image->getBody()->getId();
                             }
                         }
@@ -360,7 +360,7 @@ 
                 // Merge and re-index the array to get nice numeric indexes.
                 $this->physicalStructure = array_merge($physSeq, $elements);
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -385,15 +385,15 @@ 
      */
     public function getFileLocation($id)
     {
-        if ($id == null) {
-            return null;
+        if ($id == NULL) {
+            return NULL;
         }
         $resource = $this->iiif->getContainedResourceById($id);
         if (isset($resource)) {
             if ($resource instanceof CanvasInterface) {
-                return (!empty($resource->getImageAnnotations()) && $resource->getImageAnnotations()->getSingleService() != null) ? $resource->getImageAnnotations()[0]->getSingleService()->getId() : $id;
+                return (!empty($resource->getImageAnnotations()) && $resource->getImageAnnotations()->getSingleService() != NULL) ? $resource->getImageAnnotations()[0]->getSingleService()->getId() : $id;
             } elseif ($resource instanceof ContentResourceInterface) {
-                return $resource->getSingleService() != null && $resource->getSingleService() instanceof Service ? $resource->getSingleService()->getId() : $id;
+                return $resource->getSingleService() != NULL && $resource->getSingleService() instanceof Service ? $resource->getSingleService()->getId() : $id;
             } elseif ($resource instanceof AbstractImageService) {
                 return $resource->getId();
             } elseif ($resource instanceof AnnotationContainerInterface) {
@@ -416,7 +416,7 @@ 
         } elseif ($fileResource instanceof AnnotationInterface) {
             $format = "application/vnd.kitodo.iiif";
         } elseif ($fileResource instanceof ContentResourceInterface) {
-            if ($fileResource->isText() || $fileResource->isImage() && ($fileResource->getSingleService() == null || !($fileResource->getSingleService() instanceof AbstractImageService))) {
+            if ($fileResource->isText() || $fileResource->isImage() && ($fileResource->getSingleService() == NULL || !($fileResource->getSingleService() instanceof AbstractImageService))) {
                 // Support static images without an image service
                 return $fileResource->getFormat();
             }
@@ -434,7 +434,7 @@ 
      * {@inheritDoc}
      * @see Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
+    public function getLogicalStructure($id, $recursive = FALSE)
     {
         $details = [];
         if (!$recursive && !empty($this->logicalUnits[$id])) {
@@ -451,8 +451,8 @@ 
                 // cache the ranges - they might occure multiple times in the structures "tree" - with full data as well as referenced as id
                 $processedStructures = [];
                 foreach ($logUnits as $logUnit) {
-                    if (array_search($logUnit->getId(), $processedStructures) == false) {
-                        $this->tableOfContents[] = $this->getLogicalStructureInfo($logUnit, true, $processedStructures);
+                    if (array_search($logUnit->getId(), $processedStructures) == FALSE) {
+                        $this->tableOfContents[] = $this->getLogicalStructureInfo($logUnit, TRUE, $processedStructures);
                     }
                 }
             }
@@ -470,13 +470,13 @@ 
      * @param array $processedStructures: IIIF resources that already have been processed
      * @return array Logical structure array
      */
-    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = false, &$processedStructures = [])
+    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = FALSE, &$processedStructures = [])
     {
         $details = [];
         $details['id'] = $resource->getId();
         $details['dmdId'] = '';
-        $details['label'] = $resource->getLabelForDisplay() !== null ? $resource->getLabelForDisplay() : '';
-        $details['orderlabel'] = $resource->getLabelForDisplay() !== null ? $resource->getLabelForDisplay() : '';
+        $details['label'] = $resource->getLabelForDisplay() !== NULL ? $resource->getLabelForDisplay() : '';
+        $details['orderlabel'] = $resource->getLabelForDisplay() !== NULL ? $resource->getLabelForDisplay() : '';
         $details['contentIds'] = '';
         $details['volume'] = '';
         $details['pagination'] = '';
@@ -501,10 +501,10 @@ 
             $startCanvas = $resource->getStartCanvasOrFirstCanvas();
             $canvases = $resource->getAllCanvases();
         }
-        if ($startCanvas != null) {
+        if ($startCanvas != NULL) {
             $details['pagination'] = $startCanvas->getLabel();
             $startCanvasIndex = array_search($startCanvas, $this->iiif->getDefaultCanvases());
-            if ($startCanvasIndex !== false) {
+            if ($startCanvasIndex !== FALSE) {
                 $details['points'] = $startCanvasIndex + 1;
             }
         }
@@ -518,7 +518,7 @@ 
         if ($recursive) {
             $processedStructures[] = $resource->getId();
             $details['children'] = [];
-            if ($resource instanceof ManifestInterface && $resource->getRootRanges() != null) {
+            if ($resource instanceof ManifestInterface && $resource->getRootRanges() != NULL) {
                 $rangesToAdd = [];
                 $rootRanges = [];
                 if (sizeof($this->iiif->getRootRanges()) == 1 && $this->iiif->getRootRanges()[0]->isTopRange()) {
@@ -530,15 +530,15 @@ 
                     $rootRanges[] = $range;
                 }
                 foreach ($rootRanges as $range) {
-                    if ((array_search($range->getId(), $processedStructures) == false)) {
-                        $details['children'][] = $this->getLogicalStructureInfo($range, true, $processedStructures);
+                    if ((array_search($range->getId(), $processedStructures) == FALSE)) {
+                        $details['children'][] = $this->getLogicalStructureInfo($range, TRUE, $processedStructures);
                     }
                 }
             } elseif ($resource instanceof RangeInterface) {
                 if (!empty($resource->getAllRanges())) {
                     foreach ($resource->getAllRanges() as $range) {
-                        if ((array_search($range->getId(), $processedStructures) == false)) {
-                            $details['children'][] = $this->getLogicalStructureInfo($range, true, $processedStructures);
+                        if ((array_search($range->getId(), $processedStructures) == FALSE)) {
+                            $details['children'][] = $this->getLogicalStructureInfo($range, TRUE, $processedStructures);
                         }
                     }
                 }
@@ -563,15 +563,15 @@ 
      *
      * @todo This method is still in experimental; the method signature may change.
      */
-    public function getManifestMetadata($id, $cPid = 0, $withDescription = true, $withRights = true, $withRelated = true)
+    public function getManifestMetadata($id, $cPid = 0, $withDescription = TRUE, $withRights = TRUE, $withRelated = TRUE)
     {
         if (!empty($this->originalMetadataArray[$id])) {
             return $this->originalMetadataArray[$id];
         }
         $iiifResource = $this->iiif->getContainedResourceById($id);
         $result = [];
-        if ($iiifResource != null) {
-            if ($iiifResource->getLabel() != null && $iiifResource->getLabel() != "") {
+        if ($iiifResource != NULL) {
+            if ($iiifResource->getLabel() != NULL && $iiifResource->getLabel() != "") {
                 $result['label'] = $iiifResource->getLabel();
             }
             if (!empty($iiifResource->getMetadata())) {
@@ -673,7 +673,7 @@ 
         $iiifResource = $this->iiif->getContainedResourceById($id);
         while ($resArray = $result->fetch()) {
             // Set metadata field's value(s).
-            if ($resArray['format'] > 0 && !empty($resArray['xpath']) && ($values = $iiifResource->jsonPath($resArray['xpath'])) != null) {
+            if ($resArray['format'] > 0 && !empty($resArray['xpath']) && ($values = $iiifResource->jsonPath($resArray['xpath'])) != NULL) {
                 if (is_string($values)) {
                     $metadata[$resArray['index_name']] = [trim((string) $values)];
                 } elseif ($values instanceof JSONPath && is_array($values->data()) && count($values->data()) > 1) {
@@ -691,7 +691,7 @@ 
             if (!empty($metadata[$resArray['index_name']]) && $resArray['is_sortable']) {
                 if (
                     $resArray['format'] > 0 && !empty($resArray['xpath_sorting'])
-                    && ($values = $iiifResource->jsonPath($resArray['xpath_sorting']) != null)
+                    && ($values = $iiifResource->jsonPath($resArray['xpath_sorting']) != NULL)
                 ) {
                     if (is_string($values)) {
                         $metadata[$resArray['index_name'] . '_sorting'][0] = [trim((string) $values)];
@@ -727,7 +727,7 @@ 
                     $this->smLinkRangeCanvasesRecursively($range);
                 }
             }
-            $this->smLinksLoaded = true;
+            $this->smLinksLoaded = TRUE;
         }
         return $this->smLinks;
     }
@@ -821,7 +821,7 @@ 
                             foreach ($annotationContainer->getTextAnnotations(Motivation::PAINTING) as $annotation) {
                                 if (
                                     $annotation->getTargetResourceId() == $iiifResource->getId() &&
-                                    $annotation->getBody() != null && $annotation->getBody()->getChars() != null
+                                    $annotation->getBody() != NULL && $annotation->getBody()->getChars() != NULL
                                 ) {
                                     $annotationTexts[] = $annotation->getBody()->getChars();
                                 }
@@ -867,21 +867,21 @@ 
     protected function loadLocation($location)
     {
         $fileResource = GeneralUtility::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
             IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
             IiifHelper::setMaxThumbnailWidth($conf['iiifThumbnailWidth']);
             $resource = IiifHelper::loadIiifResource($fileResource);
-            if ($resource != null) {
+            if ($resource != NULL) {
                 if ($resource instanceof ManifestInterface) {
                     $this->iiif = $resource;
-                    return true;
+                    return TRUE;
                 }
             }
         }
         Helper::devLog('Could not load IIIF manifest from "' . $location . '"', DEVLOG_SEVERITY_ERROR);
-        return false;
+        return FALSE;
     }
 
     /**
@@ -902,9 +902,9 @@ 
     {
         if ($preloadedDocument instanceof ManifestInterface) {
             $this->iiif = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -927,22 +927,22 @@ 
                     !empty($canvas->getSeeAlsoUrlsForFormat("application/alto+xml")) ||
                     !empty($canvas->getSeeAlsoUrlsForProfile("http://www.loc.gov/standards/alto/"))
                 ) {
-                    $this->hasFulltextSet = true;
-                    $this->hasFulltext = true;
+                    $this->hasFulltextSet = TRUE;
+                    $this->hasFulltext = TRUE;
                     return;
                 }
                 $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
                 if ($extConf['indexAnnotations'] == 1 && !empty($canvas->getPossibleTextAnnotationContainers(Motivation::PAINTING))) {
                     foreach ($canvas->getPossibleTextAnnotationContainers(Motivation::PAINTING) as $annotationContainer) {
-                        if (($textAnnotations = $annotationContainer->getTextAnnotations(Motivation::PAINTING)) != null) {
+                        if (($textAnnotations = $annotationContainer->getTextAnnotations(Motivation::PAINTING)) != NULL) {
                             foreach ($textAnnotations as $annotation) {
                                 if (
-                                    $annotation->getBody() != null &&
+                                    $annotation->getBody() != NULL &&
                                     $annotation->getBody()->getFormat() == "text/plain" &&
-                                    $annotation->getBody()->getChars() != null
+                                    $annotation->getBody()->getChars() != NULL
                                 ) {
-                                    $this->hasFulltextSet = true;
-                                    $this->hasFulltext = true;
+                                    $this->hasFulltextSet = TRUE;
+                                    $this->hasFulltext = TRUE;
                                     return;
                                 }
                             }
@@ -950,7 +950,7 @@ 
                     }
                 }
             }
-            $this->hasFulltextSet = true;
+            $this->hasFulltextSet = TRUE;
         }
     }
 
@@ -958,7 +958,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
+    protected function _getThumbnail($forceReload = FALSE)
     {
         return $this->iiif->getThumbnailUrl();
     }
@@ -992,7 +992,7 @@ 
         IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
         IiifHelper::setMaxThumbnailWidth($conf['iiifThumbnailWidth']);
         $resource = IiifHelper::loadIiifResource($this->asJson);
-        if ($resource != null && $resource instanceof ManifestInterface) {
+        if ($resource != NULL && $resource instanceof ManifestInterface) {
             $this->asJson = '';
             $this->iiif = $resource;
             $this->init();