Erikmitk / kitodo-presentation

Classes/Common/Document.php

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

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

Classes/Common/MetsDocument.php

Upper-Lower-Casing +28 added lines, -28 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 [];
@@ -660,7 +660,7 @@ 
                 }
             }
             // Extract metadata only from first supported dmdSec.
-            $hasSupportedMetadata = true;
+            $hasSupportedMetadata = TRUE;
             break;
         }
         if ($hasSupportedMetadata) {
@@ -726,16 +726,16 @@ 
     protected function loadLocation($location)
     {
         $fileResource = GeneralUtility::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;
     }
 
     /**
@@ -783,9 +783,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) {
                 $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);
             if (empty($extConf['fileGrpThumbs'])) {
                 $this->logger->warning('No fileGrp for thumbnails specified');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->_getToplevelId();
@@ -1068,7 +1068,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $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,7 +1143,7 @@ 
     public function __wakeup()
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.