Erikmitk / kitodo-presentation

Classes/Common/Document.php

Spacing +16 added lines, -16 removed lines

@@ -693,14 +693,14 @@ 
                         // Get the root element's name as text format.
                         $textFormat = strtoupper($rawTextXml->getName());
                     } else {
-                        $this->logger->warning('Couldn\'t load fulltext file for structure node @ID "' . $id . '"');
+                        $this->logger->warning('Couldn\'t load fulltext file for structure node @ID "'.$id.'"');
                         return $rawText;
                     }
                     break;
                 }
             }
         } else {
-            $this->logger->warning('Invalid structure node @ID "' . $id . '"');
+            $this->logger->warning('Invalid structure node @ID "'.$id.'"');
             return $rawText;
         }
         // Is this text format supported?
@@ -718,11 +718,11 @@ 
                     $rawText = $obj->getRawText($rawTextXml);
                     $this->rawTextArray[$id] = $rawText;
                 } else {
-                    $this->logger->warning('Invalid class/method "' . $class . '->getRawText()" for text format "' . $textFormat . '"');
+                    $this->logger->warning('Invalid class/method "'.$class.'->getRawText()" for text format "'.$textFormat.'"');
                 }
             }
         } else {
-            $this->logger->warning('Unsupported text format "' . $textFormat . '" in physical node with @ID "' . $id . '"');
+            $this->logger->warning('Unsupported text format "'.$textFormat.'" in physical node with @ID "'.$id.'"');
         }
         return $rawText;
     }
@@ -777,10 +777,10 @@ 
                     $title = self::getTitle($partof, true);
                 }
             } else {
-                $logger->warning('No document with UID ' . $uid . ' found or document not accessible');
+                $logger->warning('No document with UID '.$uid.' found or document not accessible');
             }
         } else {
-            $logger->error('Invalid UID ' . $uid . ' for document');
+            $logger->error('Invalid UID '.$uid.' for document');
         }
         return $title;
     }
@@ -915,7 +915,7 @@ 
             // the actual loading is format specific
             return $this->loadLocation($location);
         } else {
-            $this->logger->error('Invalid file location "' . $location . '" for document loading');
+            $this->logger->error('Invalid file location "'.$location.'" for document loading');
         }
         return false;
     }
@@ -1024,7 +1024,7 @@ 
             // Retain current PID.
             $pid = $this->pid;
         } elseif (!$pid) {
-            $this->logger->error('Invalid PID ' . $pid . ' for document saving');
+            $this->logger->error('Invalid PID '.$pid.' for document saving');
             return false;
         }
         // Set PID for metadata definitions.
@@ -1061,7 +1061,7 @@ 
         if ($resArray = $result->fetch()) {
             $structure = $resArray['uid'];
         } else {
-            $this->logger->error('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"');
+            $this->logger->error('Could not identify document/structure type "'.$queryBuilder->expr()->literal($metadata['type'][0]).'"');
             return false;
         }
         $metadata['type'][0] = $structure;
@@ -1303,7 +1303,7 @@ 
         if ($core) {
             Indexer::add($this, $core);
         } else {
-            $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
+            $this->logger->notice('Invalid UID "'.$core.'" for Solr core');
         }
         return true;
     }
@@ -1369,7 +1369,7 @@ 
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
-            $this->logger->error('Invalid PID ' . $cPid . ' for metadata definitions');
+            $this->logger->error('Invalid PID '.$cPid.' for metadata definitions');
             return [];
         }
         if (
@@ -1697,7 +1697,7 @@ 
             // Document ready!
             $this->ready = true;
         } else {
-            $this->logger->error('No document with UID ' . $uid . ' found or document not accessible');
+            $this->logger->error('No document with UID '.$uid.' found or document not accessible');
         }
     }
 
@@ -1712,12 +1712,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -1750,12 +1750,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }

Braces +31 added lines, -62 removed lines

@@ -47,8 +47,7 @@ 
  * @property-read mixed $uid This holds the UID or the URL of the document
  * @abstract
  */
-abstract class Document
-{
+abstract class Document {
     /**
      * This holds the logger
      *
@@ -340,8 +339,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -616,8 +614,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -664,8 +661,7 @@ 
      *
      * @return string The physical structure node's / IIIF resource's raw text from XML
      */
-    protected function getRawTextFromXml($id)
-    {
+    protected function getRawTextFromXml($id) {
         $rawText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -739,8 +735,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
-    {
+    public static function getTitle($uid, $recursive = false) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         $title = '';
@@ -794,8 +789,7 @@ 
      *
      * @return array The logical structure node's / resource's parsed metadata array
      */
-    public function getTitledata($cPid = 0)
-    {
+    public function getTitledata($cPid = 0) {
         $titledata = $this->getMetadata($this->_getToplevelId(), $cPid);
         // Add information from METS structural map to titledata array.
         if ($this instanceof MetsDocument) {
@@ -828,8 +822,7 @@ 
      * @return int|bool: false if structure with $logId is not a child of this substructure,
      * or the actual depth.
      */
-    protected function getTreeDepth($structure, $depth, $logId)
-    {
+    protected function getTreeDepth($structure, $depth, $logId) {
         foreach ($structure as $element) {
             if ($element['id'] == $logId) {
                 return $depth;
@@ -851,8 +844,7 @@ 
      * @param string $logId: The id of the logical structure element whose depth is requested
      * @return int|bool tree depth as integer or false if no element with $logId exists within the TOC.
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         return $this->getTreeDepth($this->_getTableOfContents(), 1, $logId);
     }
 
@@ -902,8 +894,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function load($location)
-    {
+    protected function load($location) {
         // Load XML / JSON-LD file.
         if (GeneralUtility::isValidUrl($location)) {
             // Load extension configuration
@@ -936,8 +927,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -977,8 +967,7 @@ 
      *
      * @return void
      */
-    public function registerNamespaces(&$obj)
-    {
+    public function registerNamespaces(&$obj) {
         // TODO Check usage. XML specific method does not seem to be used anywhere outside this class within the project, but it is public and may be used by extensions.
         $this->loadFormats();
         // Do we have a \SimpleXMLElement or \DOMXPath object?
@@ -1007,8 +996,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
-    {
+    public function save($pid = 0, $core = 0, $owner = null) {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
             return false;
@@ -1333,8 +1321,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -1345,8 +1332,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -1358,8 +1344,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -1381,8 +1366,7 @@ 
      *
      * @return array Array of metadata with their corresponding logical structure node ID as key
      */
-    protected function _getMetadataArray()
-    {
+    protected function _getMetadataArray() {
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
@@ -1407,8 +1391,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -1420,8 +1403,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1444,8 +1426,7 @@ 
      *
      * @return array Array of elements' type, label and file representations ordered by @ID attribute / Canvas order
      */
-    protected function _getPhysicalStructureInfo()
-    {
+    protected function _getPhysicalStructureInfo() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Build physical structure array.
@@ -1461,8 +1442,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1473,8 +1453,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1485,8 +1464,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1497,8 +1475,7 @@ 
      *
      * @return int The UID of the root document or zero if not applicable
      */
-    protected function _getRootId()
-    {
+    protected function _getRootId() {
         if (!$this->rootIdLoaded) {
             if ($this->parentId) {
                 $parent = self::getInstance($this->parentId, $this->pid);
@@ -1528,8 +1505,7 @@ 
      *
      * @return array Array of structure nodes' id, label, type and physical page indexes/mptr / Canvas link with original hierarchy preserved
      */
-    protected function _getTableOfContents()
-    {
+    protected function _getTableOfContents() {
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
@@ -1570,8 +1546,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1584,8 +1559,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1596,8 +1570,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -1614,8 +1587,7 @@ 
      *
      * @return void
      */
-    protected function __construct($uid, $pid, $preloadedDocument)
-    {
+    protected function __construct($uid, $pid, $preloadedDocument) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
         $location = '';
@@ -1727,8 +1699,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1750,8 +1721,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -1765,8 +1735,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)

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

@@ -102,7 +102,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $formatsLoaded = false;
+    protected $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -112,7 +112,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltext = false;
+    protected $hasFulltext = FALSE;
 
     /**
      * Last searched logical and physical page
@@ -120,7 +120,7 @@ 
      * @var array
      * @access protected
      */
-    protected $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * This holds the documents location
@@ -154,7 +154,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $metadataArrayLoaded = false;
+    protected $metadataArrayLoaded = FALSE;
 
     /**
      * The holds the total number of pages
@@ -195,7 +195,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $physicalStructureLoaded = false;
+    protected $physicalStructureLoaded = FALSE;
 
     /**
      * This holds the PID of the document or zero if not in database
@@ -220,7 +220,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * The METS file's / IIIF manifest's record identifier
@@ -254,7 +254,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $rootIdLoaded = false;
+    protected $rootIdLoaded = FALSE;
 
     /**
      * This holds the smLinks between logical and physical structMap
@@ -271,7 +271,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $smLinksLoaded = false;
+    protected $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -288,7 +288,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $tableOfContentsLoaded = false;
+    protected $tableOfContentsLoaded = FALSE;
 
     /**
      * This holds the document's thumbnail location
@@ -305,7 +305,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)
@@ -422,7 +422,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);
@@ -462,10 +462,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)
@@ -514,27 +514,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());
@@ -589,7 +589,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
@@ -626,7 +626,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;
@@ -679,11 +679,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.
@@ -739,7 +739,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)
     {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
@@ -774,7 +774,7 @@ 
                     && intval($partof)
                     && $partof != $uid
                 ) {
-                    $title = self::getTitle($partof, true);
+                    $title = self::getTitle($partof, TRUE);
                 }
             } else {
                 $logger->warning('No document with UID ' . $uid . ' found or document not accessible');
@@ -835,12 +835,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;
     }
 
     /**
@@ -917,7 +917,7 @@ 
         } else {
             $this->logger->error('Invalid file location "' . $location . '" for document loading');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -964,7 +964,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -1007,11 +1007,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);
@@ -1026,7 +1026,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;
@@ -1039,7 +1039,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);
@@ -1063,7 +1063,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;
 
@@ -1120,9 +1120,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
                     );
                 }
             }
@@ -1173,9 +1173,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
                     );
                 }
             }
@@ -1263,7 +1263,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],
@@ -1299,9 +1299,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.
@@ -1310,7 +1310,7 @@ 
         } else {
             $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -1395,7 +1395,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1504,7 +1504,7 @@ 
                 $parent = self::getInstance($this->parentId, $this->pid);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1533,8 +1533,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;
     }
@@ -1550,7 +1550,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
@@ -1631,7 +1631,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);
@@ -1689,30 +1689,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/Solr.php

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

@@ -55,7 +55,7 @@ 
      * @var string|null
      * @access protected
      */
-    protected $core = null;
+    protected $core = NULL;
 
     /**
      * This holds the PID for the configuration
@@ -103,7 +103,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * This holds the singleton search objects with their core as array key
@@ -255,7 +255,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Solr Instance of this class
      */
-    public static function getInstance($core = null)
+    public static function getInstance($core = NULL)
     {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
@@ -266,7 +266,7 @@ 
         // Check if core is set or null.
         if (
             empty($core)
-            && $core !== null
+            && $core !== NULL
         ) {
             $logger->error('Invalid core UID or name given for Apache Solr');
         }
@@ -408,7 +408,7 @@ 
                 'core' => $this->core,
                 'pid' => $this->cPid,
                 'order' => 'score',
-                'order.asc' => true,
+                'order.asc' => TRUE,
                 'numberOfHits' => $this->numberOfHits,
                 'numberOfToplevelHits' => $numberOfToplevelHits
             ]
@@ -434,10 +434,10 @@ 
         // Set query.
         $parameters['query'] = $query;
         // Calculate cache identifier.
-        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), true));
+        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), TRUE));
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         $resultSet = [];
-        if (($entry = $cache->get($cacheIdentifier)) === false) {
+        if (($entry = $cache->get($cacheIdentifier)) === FALSE) {
             $selectQuery = $this->service->createSelect(array_merge($this->params, $parameters));
             $result = $this->service->select($selectQuery);
             foreach ($result as $doc) {
@@ -663,7 +663,7 @@ 
         // Check if connection is established.
         $query = $this->service->createCoreAdmin();
         $action = $query->createStatus();
-        if ($core !== null) {
+        if ($core !== NULL) {
             $action->setCore($core);
         }
         $query->setAction($action);
@@ -671,7 +671,7 @@ 
             $response = $this->service->coreAdmin($query);
             if ($response->getWasSuccessful()) {
                 // Solr is reachable, but is the core as well?
-                if ($core !== null) {
+                if ($core !== NULL) {
                     $result = $response->getStatusResult();
                     if (
                         $result instanceof \Solarium\QueryType\Server\CoreAdmin\Result\StatusResult
@@ -685,7 +685,7 @@ 
                     }
                 }
                 // Instantiation successful!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
         } catch (\Exception $e) {
             // Nothing to do here.

Spacing +11 added lines, -11 removed lines

@@ -136,7 +136,7 @@ 
 
         // Get next available core name if none given.
         if (empty($core)) {
-            $core = 'dlfCore' . self::getNextCoreNumber();
+            $core = 'dlfCore'.self::getNextCoreNumber();
         }
         // Get Solr service instance.
         $solr = self::getInstance($core);
@@ -232,13 +232,13 @@ 
                 ->execute();
 
             while ($resArray = $result->fetch()) {
-                $fields[] = $resArray['index_name'] . '_' . ($resArray['index_tokenized'] ? 't' : 'u') . ($resArray['index_stored'] ? 's' : 'u') . 'i';
+                $fields[] = $resArray['index_name'].'_'.($resArray['index_tokenized'] ? 't' : 'u').($resArray['index_stored'] ? 's' : 'u').'i';
             }
 
             // Check if queried field is valid.
             $splitQuery = explode(':', $query, 2);
             if (in_array($splitQuery[0], $fields)) {
-                $query = $splitQuery[0] . ':(' . self::escapeQuery(trim($splitQuery[1], '()')) . ')';
+                $query = $splitQuery[0].':('.self::escapeQuery(trim($splitQuery[1], '()')).')';
             } else {
                 $query = self::escapeQuery($query);
             }
@@ -345,7 +345,7 @@ 
     {
         $number = max(intval($number), 0);
         // Check if core already exists.
-        $solr = self::getInstance('dlfCore' . $number);
+        $solr = self::getInstance('dlfCore'.$number);
         if (!$solr->ready) {
             return $number;
         } else {
@@ -420,7 +420,7 @@ 
         // Set filter query to just get toplevel documents.
         $params['filterquery'][] = ['query' => 'toplevel:true'];
         // Set join query to get all documents with the same uids.
-        $params['query'] = '{!join from=uid to=uid}' . $params['query'];
+        $params['query'] = '{!join from=uid to=uid}'.$params['query'];
         // Perform search to determine the total number of toplevel hits and fetch the required rows.
         $selectQuery = $this->service->createSelect($params);
         $results = $this->service->select($selectQuery);
@@ -477,7 +477,7 @@ 
         // Set query.
         $parameters['query'] = $query;
         // Calculate cache identifier.
-        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), true));
+        $cacheIdentifier = Helper::digest($this->core.print_r(array_merge($this->params, $parameters), true));
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         $resultSet = [];
         if (($entry = $cache->get($cacheIdentifier)) === false) {
@@ -608,12 +608,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -646,12 +646,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }
@@ -688,7 +688,7 @@ 
                     'scheme' => $this->config['scheme'],
                     'host' => $this->config['host'],
                     'port' => $this->config['port'],
-                    'path' => '/' . $this->config['path'],
+                    'path' => '/'.$this->config['path'],
                     'core' => $core,
                     'username' => $this->config['username'],
                     'password' => $this->config['password'],

Braces +22 added lines, -44 removed lines

@@ -37,8 +37,7 @@ 
  * @property-read bool $ready Is the Solr service instantiated successfully?
  * @property-read \Solarium\Client $service This holds the Solr service object
  */
-class Solr implements LoggerAwareInterface
-{
+class Solr implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     /**
@@ -130,8 +129,7 @@ 
      *
      * @return string The name of the new core
      */
-    public static function createCore($core = '')
-    {
+    public static function createCore($core = '') {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         // Get next available core name if none given.
@@ -180,8 +178,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQuery($query)
-    {
+    public static function escapeQuery($query) {
         $helper = GeneralUtility::makeInstance(\Solarium\Core\Query\Helper::class);
         // Escape query phrase or term.
         if (preg_match('/^".*"$/', $query)) {
@@ -204,8 +201,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQueryKeepField($query, $pid)
-    {
+    public static function escapeQueryKeepField($query, $pid) {
         // Is there a field query?
         if (preg_match('/^[[:alnum:]]+_[tu][su]i:\(?.*\)?$/', $query)) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -255,8 +251,7 @@ 
      *
      * @return array fields
      */
-    public static function getFields()
-    {
+    public static function getFields() {
         $conf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
 
         $fields = [];
@@ -298,8 +293,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Solr Instance of this class
      */
-    public static function getInstance($core = null)
-    {
+    public static function getInstance($core = null) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         // Get core name if UID is given.
@@ -341,8 +335,7 @@ 
      *
      * @return int First unused core number found
      */
-    public static function getNextCoreNumber($number = 0)
-    {
+    public static function getNextCoreNumber($number = 0) {
         $number = max(intval($number), 0);
         // Check if core already exists.
         $solr = self::getInstance('dlfCore' . $number);
@@ -360,8 +353,7 @@ 
      *
      * @return void
      */
-    protected function loadSolrConnectionInfo()
-    {
+    protected function loadSolrConnectionInfo() {
         if (empty($this->config)) {
             $config = [];
             // Extract extension configuration.
@@ -399,8 +391,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\DocumentList The result list
      */
-    public function search()
-    {
+    public function search() {
         $toplevel = [];
         // Take over query parameters.
         $params = $this->params;
@@ -469,8 +460,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    public function search_raw($query = '', $parameters = [])
-    {
+    public function search_raw($query = '', $parameters = []) {
         // Set additional query parameters.
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
@@ -502,8 +492,7 @@ 
      *
      * @return string|null The core name of the current query endpoint or null if core admin endpoint
      */
-    protected function _getCore()
-    {
+    protected function _getCore() {
         return $this->core;
     }
 
@@ -514,8 +503,7 @@ 
      *
      * @return int The max number of results
      */
-    protected function _getLimit()
-    {
+    protected function _getLimit() {
         return $this->limit;
     }
 
@@ -526,8 +514,7 @@ 
      *
      * @return int Total number of hits for last search
      */
-    protected function _getNumberOfHits()
-    {
+    protected function _getNumberOfHits() {
         return $this->numberOfHits;
     }
 
@@ -538,8 +525,7 @@ 
      *
      * @return bool Is the search instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -550,8 +536,7 @@ 
      *
      * @return \Solarium\Client Apache Solr service object
      */
-    protected function _getService()
-    {
+    protected function _getService() {
         return $this->service;
     }
 
@@ -564,8 +549,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -578,8 +562,7 @@ 
      *
      * @return void
      */
-    protected function _setLimit($value)
-    {
+    protected function _setLimit($value) {
         $this->limit = max(intval($value), 0);
     }
 
@@ -592,8 +575,7 @@ 
      *
      * @return void
      */
-    protected function _setParams(array $value)
-    {
+    protected function _setParams(array $value) {
         $this->params = $value;
     }
 
@@ -606,8 +588,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -629,8 +610,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -644,8 +624,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -666,8 +645,7 @@ 
      *
      * @return void
      */
-    protected function __construct($core)
-    {
+    protected function __construct($core) {
         // Get Solr connection parameters from configuration.
         $this->loadSolrConnectionInfo();
         // Configure connection adapter.

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 {
-            $this->logger->warning('There is no file node with @ID "' . $id . '"');
+            $this->logger->warning('There is no file node with @ID "'.$id.'"');
             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 {
-            $this->logger->warning('There is no file node with @ID "' . $id . '" or no MIME type specified');
+            $this->logger->warning('There is no file node with @ID "'.$id.'" or no MIME type specified');
             return '';
         }
     }
@@ -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) {
-            $this->logger->warning('Invalid PID ' . $cPid . ' for metadata definitions');
+            $this->logger->warning('Invalid PID '.$cPid.' for metadata definitions');
             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 {
-                        $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->dmdSec[$dmdId]['type'] . '"');
+                        $this->logger->warning('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->dmdSec[$dmdId]['type'].'"');
                     }
                 }
             } else {
-                $this->logger->notice('Unsupported metadata format "' . $this->dmdSec[$dmdId]['type'] . '" in dmdSec with @ID "' . $dmdId . '"');
+                $this->logger->notice('Unsupported metadata format "'.$this->dmdSec[$dmdId]['type'].'" in dmdSec with @ID "'.$dmdId.'"');
                 // 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 {
-            $this->logger->warning('No supported metadata found for logical structure with @ID "' . $id . '"');
+            $this->logger->warning('No supported metadata found for logical structure with @ID "'.$id.'"');
             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 {
-            $this->logger->error('No METS part found in document with UID ' . $this->uid);
+            $this->logger->error('No METS part found in document with UID '.$this->uid);
         }
     }
 
@@ -722,7 +722,7 @@ 
                 return true;
             }
         }
-        $this->logger->error('Could not load XML file from "' . $location . '"');
+        $this->logger->error('Could not load XML file from "'.$location.'"');
         return false;
     }
 
@@ -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) {
-                $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
+                $this->logger->error('Invalid PID '.$cPid.' for structure definitions');
                 $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 {
-                $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
+                $this->logger->error('No structure of type "'.$metadata['type'][0].'" found in database');
             }
             $this->thumbnailLoaded = true;
         }

Braces +28 added lines, -56 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.
@@ -669,8 +660,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])) {
@@ -688,8 +678,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);
@@ -702,8 +691,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');
@@ -720,8 +708,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.
@@ -748,8 +735,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -760,8 +746,7 @@ 
      * {@inheritDoc}
      * @see Document::getParentDocumentUid()
      */
-    protected function getParentDocumentUidForSaving($pid, $core, $owner)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core, $owner) {
         $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');
@@ -784,8 +769,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -798,8 +782,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -810,8 +793,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();
@@ -849,8 +831,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);
@@ -895,8 +876,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)) {
@@ -914,8 +894,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -923,8 +902,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"?
@@ -984,8 +962,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)) {
@@ -1003,8 +980,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1083,8 +1059,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)]');
@@ -1116,8 +1091,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'];
@@ -1130,8 +1104,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;
@@ -1146,8 +1119,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 [];
@@ -654,7 +654,7 @@ 
                 $metadata['owner'][0] = $resArray['owner'];
             }
             // Extract metadata only from first supported dmdSec.
-            $hasSupportedMetadata = true;
+            $hasSupportedMetadata = TRUE;
             break;
         }
         if ($hasSupportedMetadata) {
@@ -723,11 +723,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
@@ -735,13 +735,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;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -789,9 +789,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -837,7 +837,7 @@ 
                     }
                 }
             }
-            $this->dmdSecLoaded = true;
+            $this->dmdSecLoaded = TRUE;
         }
         return $this->dmdSec;
     }
@@ -884,9 +884,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;
     }
@@ -975,7 +975,7 @@ 
                     $this->physicalStructure = array_merge($physSeq, $elements);
                 }
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -994,7 +994,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;
     }
@@ -1003,7 +1003,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
+    protected function _getThumbnail($forceReload = FALSE)
     {
         if (
             !$this->thumbnailLoaded
@@ -1013,14 +1013,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();
@@ -1074,7 +1074,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1133,8 +1133,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();
     }
 
@@ -1149,12 +1149,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/Helper.php

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

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

Spacing +49 added lines, -49 removed lines

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

Braces +25 added lines, -50 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -74,8 +73,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
-    {
+    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = GeneralUtility::makeInstance(
@@ -100,8 +98,7 @@ 
      *
      * @return bool Is $id a valid GNL identifier of the given $type?
      */
-    public static function checkIdentifier($id, $type)
-    {
+    public static function checkIdentifier($id, $type) {
         $digits = substr($id, 0, 8);
         $checksum = 0;
         for ($i = 0, $j = strlen($digits); $i < $j; $i++) {
@@ -165,8 +162,7 @@ 
      *
      * @return mixed The decrypted value or false on error
      */
-    public static function decrypt($encrypted)
-    {
+    public static function decrypt($encrypted) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -207,8 +203,7 @@ 
      * @return void
      */
     //TODO: find better way to handle logger in static class
-    public static function log($message, $severity = 0)
-    {
+    public static function log($message, $severity = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         switch ($severity) {
@@ -238,8 +233,7 @@ 
      *
      * @return mixed Hashed string or false on error
      */
-    public static function digest($string)
-    {
+    public static function digest($string) {
         if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
             return false;
@@ -258,8 +252,7 @@ 
      *
      * @return mixed Encrypted string or false on error
      */
-    public static function encrypt($string)
-    {
+    public static function encrypt($string) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -292,8 +285,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -307,8 +299,7 @@ 
      *
      * @return string The cleaned up string
      */
-    public static function getCleanString($string)
-    {
+    public static function getCleanString($string) {
         // Convert to lowercase.
         $string = strtolower($string);
         // Remove non-alphanumeric characters.
@@ -329,8 +320,7 @@ 
      *
      * @return array Array of hook objects for the class
      */
-    public static function getHookObjects($scriptRelPath)
-    {
+    public static function getHookObjects($scriptRelPath) {
         $hookObjects = [];
         if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
             foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
@@ -351,8 +341,7 @@ 
      *
      * @return string "index_name" for the given UID
      */
-    public static function getIndexNameFromUid($uid, $table, $pid = -1)
-    {
+    public static function getIndexNameFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -404,8 +393,7 @@ 
      *
      * @return string "label" for the given UID
      */
-    public static function getLabelFromUid($uid, $table, $pid = -1)
-    {
+    public static function getLabelFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -455,8 +443,7 @@ 
      *
      * @return string Localized full name of language or unchanged input
      */
-    public static function getLanguageName($code)
-    {
+    public static function getLanguageName($code) {
         // Analyze code and set appropriate ISO table.
         $isoCode = strtolower(trim($code));
         if (preg_match('/^[a-z]{3}$/', $isoCode)) {
@@ -501,8 +488,7 @@ 
      *
      * @return string The translated string or the given key on failure
      */
-    public static function getMessage($key, $hsc = false, $default = '')
-    {
+    public static function getMessage($key, $hsc = false, $default = '') {
         // Set initial output to default value.
         $translated = (string) $default;
         // Load common messages file.
@@ -544,8 +530,7 @@ 
      *
      * @return string "uid" for the given index_name
      */
-    public static function getUidFromIndexName($index_name, $table, $pid = -1)
-    {
+    public static function getUidFromIndexName($index_name, $table, $pid = -1) {
         if (
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
@@ -596,8 +581,7 @@ 
      *
      * @return string Uniform Resource Name as string
      */
-    public static function getURN($base, $id)
-    {
+    public static function getURN($base, $id) {
         $concordance = [
             '0' => 1,
             '1' => 2,
@@ -664,8 +648,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -678,8 +661,7 @@ 
      *
      * @return mixed Session value for given key or null on failure
      */
-    public static function loadFromSession($key)
-    {
+    public static function loadFromSession($key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -711,8 +693,7 @@ 
      *
      * @return array Merged array
      */
-    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
-    {
+    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true) {
         \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($original, $overrule, $addKeys, $includeEmptyValues, $enableUnsetFeature);
         return $original;
     }
@@ -729,8 +710,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
-    {
+    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false) {
         if (
             \TYPO3_MODE === 'BE'
             && $GLOBALS['BE_USER']->isAdmin()
@@ -776,8 +756,7 @@ 
      *
      * @return string All flash messages in the queue rendered as HTML.
      */
-    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages')
-    {
+    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessages = $flashMessageQueue->getAllMessagesAndFlush();
@@ -796,8 +775,7 @@ 
      *
      * @return bool true on success, false on failure
      */
-    public static function saveToSession($value, $key)
-    {
+    public static function saveToSession($value, $key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -829,8 +807,7 @@ 
      *
      * @return string Localized label for $index_name
      */
-    public static function translate($index_name, $table, $pid)
-    {
+    public static function translate($index_name, $table, $pid) {
         // Load labels into static variable for future use.
         static $labels = [];
         // Sanitize input.
@@ -953,8 +930,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = false)
-    {
+    public static function whereExpression($table, $showHidden = false) {
         if (\TYPO3_MODE === 'FE') {
             // Should we ignore the record's hidden flag?
             $ignoreHide = 0;
@@ -983,8 +959,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

Classes/Common/IiifManifest.php

Spacing +6 added lines, -6 removed lines

@@ -694,16 +694,16 @@ 
                     && ($values = $iiifResource->jsonPath($resArray['xpath_sorting']) != null)
                 ) {
                     if (is_string($values)) {
-                        $metadata[$resArray['index_name'] . '_sorting'][0] = [trim((string) $values)];
+                        $metadata[$resArray['index_name'].'_sorting'][0] = [trim((string) $values)];
                     } elseif ($values instanceof JSONPath && is_array($values->data()) && count($values->data()) > 1) {
                         $metadata[$resArray['index_name']] = [];
                         foreach ($values->data() as $value) {
-                            $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $value);
+                            $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $value);
                         }
                     }
                 }
-                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];
                 }
             }
         }
@@ -831,7 +831,7 @@ 
                     }
                 }
             } else {
-                $this->logger->warning('Invalid structure resource @id "' . $id . '"');
+                $this->logger->warning('Invalid structure resource @id "'.$id.'"');
                 return $rawText;
             }
             $this->rawTextArray[$id] = $rawText;
@@ -880,7 +880,7 @@ 
                 }
             }
         }
-        $this->logger->error('Could not load IIIF manifest from "' . $location . '"');
+        $this->logger->error('Could not load IIIF manifest from "'.$location.'"');
         return false;
     }
 

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;
                 }
             }
         }
         $this->logger->error('Could not load IIIF manifest from "' . $location . '"');
-        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();

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, $owner)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core, $owner) {
         // 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);

Classes/ExpressionLanguage/DocumentTypeFunctionProvider.php

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

@@ -74,7 +74,7 @@ 
 
                 // Load document with current plugin parameters.
                 $doc = $this->loadDocument($queryParams[$this->prefixId]);
-                if ($doc === null) {
+                if ($doc === NULL) {
                     return $type;
                 }
                 // Set PID for metadata definitions.
@@ -85,7 +85,7 @@ 
                     // Calendar plugin does not support IIIF (yet). Abort for all newspaper related types.
                     if (
                         $doc instanceof IiifManifest
-                        && array_search($metadata['type'][0], ['newspaper', 'ephemera', 'year', 'issue']) !== false
+                        && array_search($metadata['type'][0], ['newspaper', 'ephemera', 'year', 'issue']) !== FALSE
                     ) {
                         return $type;
                     }

Spacing +2 added lines, -2 removed lines

@@ -116,7 +116,7 @@ 
             if ($doc->ready) {
                 return $doc;
             } else {
-                $this->logger->warning('Failed to load document with UID ' . $piVars['id']);
+                $this->logger->warning('Failed to load document with UID '.$piVars['id']);
             }
         } elseif (!empty($piVars['recordId'])) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -137,7 +137,7 @@ 
                 // Try to load document.
                 return $this->loadDocument(['id' => $resArray['uid']]);
             } else {
-                $this->logger->warning('Failed to load document with record ID "' . $piVars['recordId'] . '"');
+                $this->logger->warning('Failed to load document with record ID "'.$piVars['recordId'].'"');
             }
         }
     }

Braces +4 added lines, -8 removed lines

@@ -46,8 +46,7 @@ 
     /**
      * @return ExpressionFunction[] An array of Function instances
      */
-    public function getFunctions()
-    {
+    public function getFunctions() {
         return [
             $this->getDocumentTypeFunction(),
         ];
@@ -62,12 +61,10 @@ 
     {
         return new ExpressionFunction(
             'getDocumentType',
-            function()
-            {
+            function() {
                 // Not implemented, we only use the evaluator
             },
-            function($arguments, $cPid)
-            {
+            function($arguments, $cPid) {
                 /** @var RequestWrapper $requestWrapper */
                 $requestWrapper = $arguments['request'];
                 $queryParams = $requestWrapper->getQueryParams();
@@ -107,8 +104,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Document Instance of the current document
      */
-    protected function loadDocument(array $piVars)
-    {
+    protected function loadDocument(array $piVars) {
         // Check for required variable.
         if (!empty($piVars['id'])) {
             // Get instance of document.

Classes/Hooks/UserFunc.php

Spacing +2 added lines, -2 removed lines

@@ -56,9 +56,9 @@
     public function displayThumbnail(&$params)
     {
         // Simulate TCA field type "passthrough".
-        $output = '<input type="hidden" name="' . $params['itemFormElName'] . '" value="' . $params['itemFormElValue'] . '" />';
+        $output = '<input type="hidden" name="'.$params['itemFormElName'].'" value="'.$params['itemFormElValue'].'" />';
         if (!empty($params['itemFormElValue'])) {
-            $output .= '<img alt="Thumbnail" title="' . $params['itemFormElValue'] . '" src="' . $params['itemFormElValue'] . '" />';
+            $output .= '<img alt="Thumbnail" title="'.$params['itemFormElValue'].'" src="'.$params['itemFormElValue'].'" />';
         }
         return $output;
     }

Braces +2 added lines, -4 removed lines

@@ -30,8 +30,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class UserFunc implements LoggerAwareInterface
-{
+class UserFunc implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     /**
@@ -53,8 +52,7 @@ 
      *
      * @return string HTML <img> tag for thumbnail
      */
-    public function displayThumbnail(&$params)
-    {
+    public function displayThumbnail(&$params) {
         // Simulate TCA field type "passthrough".
         $output = '<input type="hidden" name="' . $params['itemFormElName'] . '" value="' . $params['itemFormElValue'] . '" />';
         if (!empty($params['itemFormElValue'])) {

Classes/Hooks/ConfigurationForm.php

Braces +4 added lines, -8 removed lines

@@ -28,8 +28,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class ConfigurationForm
-{
+class ConfigurationForm {
     /**
      * This holds the current configuration
      *
@@ -45,8 +44,7 @@ 
      *
      * @return string Message informing the user of success or failure
      */
-    public function checkSolrConnection()
-    {
+    public function checkSolrConnection() {
         $solr = Solr::getInstance();
         if ($solr->ready) {
             Helper::addMessage(
@@ -71,8 +69,7 @@ 
      *
      * @return string Message informing the user of success or failure
      */
-    public function checkMetadataFormats()
-    {
+    public function checkMetadataFormats() {
         // We need to do some bootstrapping manually as of TYPO3 9.
         // Load table configuration array into $GLOBALS['TCA'].
         ExtensionManagementUtility::loadBaseTca(false);
@@ -201,8 +198,7 @@ 
      *
      * @return void
      */
-    public function __construct()
-    {
+    public function __construct() {
         // Load localization file.
         $GLOBALS['LANG']->includeLLFile('EXT:dlf/Resources/Private/Language/FlashMessages.xml');
         // Get current configuration.

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

@@ -75,21 +75,21 @@ 
     {
         // We need to do some bootstrapping manually as of TYPO3 9.
         // Load table configuration array into $GLOBALS['TCA'].
-        ExtensionManagementUtility::loadBaseTca(false);
+        ExtensionManagementUtility::loadBaseTca(FALSE);
         // Get extension configuration from dlf/ext_localconf.php.
-        ExtensionManagementUtility::loadExtLocalconf(false);
+        ExtensionManagementUtility::loadExtLocalconf(FALSE);
         // Initialize backend user into $GLOBALS['BE_USER'].
         Bootstrap::initializeBackendUser();
         // Initialize backend and ensure authenticated access.
         Bootstrap::initializeBackendAuthentication();
 
         $nsDefined = [
-            'MODS' => false,
-            'TEIHDR' => false,
-            'ALTO' => false,
-            'IIIF1' => false,
-            'IIIF2' => false,
-            'IIIF3' => false
+            'MODS' => FALSE,
+            'TEIHDR' => FALSE,
+            'ALTO' => FALSE,
+            'IIIF1' => FALSE,
+            'IIIF2' => FALSE,
+            'IIIF3' => FALSE
         ];
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_formats');
@@ -104,7 +104,7 @@ 
             ->execute();
 
         while ($resArray = $result->fetch()) {
-            $nsDefined[$resArray['type']] = true;
+            $nsDefined[$resArray['type']] = TRUE;
         }
         // Build data array.
         $data = [];

Classes/Common/AbstractPlugin.php

Braces +8 added lines, -16 removed lines

@@ -29,8 +29,7 @@ 
  * @access public
  * @abstract
  */
-abstract class AbstractPlugin extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin implements LoggerAwareInterface
-{
+abstract class AbstractPlugin extends \TYPO3\CMS\Frontend\Plugin\AbstractPlugin implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     public $extKey = 'dlf';
@@ -73,8 +72,7 @@ 
      *
      * @return void
      */
-    protected function getTemplate($part = '###TEMPLATE###')
-    {
+    protected function getTemplate($part = '###TEMPLATE###') {
         $this->templateService = GeneralUtility::makeInstance(MarkerBasedTemplateService::class);
         if (!empty($this->conf['templateFile'])) {
             // Load template file from configuration.
@@ -98,8 +96,7 @@ 
      *
      * @return void
      */
-    protected function init(array $conf)
-    {
+    protected function init(array $conf) {
         // Read FlexForm configuration.
         $flexFormConf = [];
         $this->cObj->readFlexformIntoConf($this->cObj->data['pi_flexform'], $flexFormConf);
@@ -137,8 +134,7 @@ 
      *
      * @return void
      */
-    protected function loadDocument()
-    {
+    protected function loadDocument() {
         // Check for required variable.
         if (
             !empty($this->piVars['id'])
@@ -209,8 +205,7 @@ 
      *
      * @return array The resulting typoscript array
      */
-    protected function parseTS($string = '')
-    {
+    protected function parseTS($string = '') {
         $parser = GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::class);
         $parser->parse($string);
         return $parser->setup;
@@ -229,8 +224,7 @@ 
      *
      * @return string The input string wrapped in <a> tags
      */
-    public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0)
-    {
+    public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0) {
         $conf = [];
         if (!$cache) {
             $conf['no_cache'] = true;
@@ -253,8 +247,7 @@ 
      *
      * @return string HTML content wrapped, ready to return to the parent object.
      */
-    public function pi_wrapInBaseClass($content)
-    {
+    public function pi_wrapInBaseClass($content) {
         if (!$this->frontendController->config['config']['disableWrapInBaseClass']) {
             // Use class name instead of $this->prefixId for content wrapping because $this->prefixId is the same for all plugins.
             $content = '<div class="tx-dlf-' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '">' . $content . '</div>';
@@ -274,8 +267,7 @@ 
      *
      * @return void
      */
-    protected function setCache($cache = true)
-    {
+    protected function setCache($cache = true) {
         if ($cache) {
             // Set cObject type to "USER" (default).
             $this->pi_USER_INT_obj = false;

Spacing +10 added lines, -10 removed lines

@@ -81,7 +81,7 @@ 
             $templateFile = $this->conf['templateFile'];
         } else {
             // Load default template from extension.
-            $templateFile = 'EXT:' . $this->extKey . '/Resources/Private/Templates/' . Helper::getUnqualifiedClassName(get_class($this)) . '.tmpl';
+            $templateFile = 'EXT:'.$this->extKey.'/Resources/Private/Templates/'.Helper::getUnqualifiedClassName(get_class($this)).'.tmpl';
         }
         // Substitute strings like "EXT:" in given template file location.
         $fileResource = $GLOBALS['TSFE']->tmpl->getFileName($templateFile);
@@ -107,12 +107,12 @@ 
             $conf = Helper::mergeRecursiveWithOverrule($flexFormConf, $conf);
         }
         // Read plugin TS configuration.
-        $pluginConf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_dlf_' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '.'];
+        $pluginConf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_dlf_'.strtolower(Helper::getUnqualifiedClassName(get_class($this))).'.'];
         if (is_array($pluginConf)) {
             $conf = Helper::mergeRecursiveWithOverrule($pluginConf, $conf);
         }
         // Read general TS configuration.
-        $generalConf = $GLOBALS['TSFE']->tmpl->setup['plugin.'][$this->prefixId . '.'];
+        $generalConf = $GLOBALS['TSFE']->tmpl->setup['plugin.'][$this->prefixId.'.'];
         if (is_array($generalConf)) {
             $conf = Helper::mergeRecursiveWithOverrule($generalConf, $conf);
         }
@@ -127,7 +127,7 @@ 
         // Set default plugin variables.
         $this->pi_setPiVarDefaults();
         // Load translation files.
-        $this->pi_loadLL('EXT:' . $this->extKey . '/Resources/Private/Language/' . Helper::getUnqualifiedClassName(get_class($this)) . '.xml');
+        $this->pi_loadLL('EXT:'.$this->extKey.'/Resources/Private/Language/'.Helper::getUnqualifiedClassName(get_class($this)).'.xml');
     }
 
     /**
@@ -151,7 +151,7 @@ 
             if (!$this->doc->ready) {
                 // Destroy the incomplete object.
                 $this->doc = null;
-                $this->logger->error('Failed to load document with UID ' . $this->piVars['id']);
+                $this->logger->error('Failed to load document with UID '.$this->piVars['id']);
             } else {
                 // Set configuration PID.
                 $this->doc->cPid = $this->conf['pages'];
@@ -179,10 +179,10 @@ 
                 // Try to load document.
                 $this->loadDocument();
             } else {
-                $this->logger->error('Failed to load document with record ID "' . $this->piVars['recordId'] . '"');
+                $this->logger->error('Failed to load document with record ID "'.$this->piVars['recordId'].'"');
             }
         } else {
-            $this->logger->error('Invalid UID ' . $this->piVars['id'] . ' or PID ' . $this->conf['pages'] . ' for document loading');
+            $this->logger->error('Invalid UID '.$this->piVars['id'].' or PID '.$this->conf['pages'].' for document loading');
         }
     }
 
@@ -236,7 +236,7 @@ 
             $conf['no_cache'] = true;
         }
         $conf['parameter'] = $altPageId ? : ($this->pi_tmpPageId ? : 'current');
-        $conf['additionalParams'] = $this->conf['parent.']['addParams'] . HttpUtility::buildQueryString($urlParameters, '&', true) . $this->pi_moreParams;
+        $conf['additionalParams'] = $this->conf['parent.']['addParams'].HttpUtility::buildQueryString($urlParameters, '&', true).$this->pi_moreParams;
         // Add additional configuration for absolute URLs.
         $conf['forceAbsoluteUrl'] = !empty($this->conf['forceAbsoluteUrl']) ? 1 : 0;
         $conf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
@@ -257,9 +257,9 @@ 
     {
         if (!$this->frontendController->config['config']['disableWrapInBaseClass']) {
             // Use class name instead of $this->prefixId for content wrapping because $this->prefixId is the same for all plugins.
-            $content = '<div class="tx-dlf-' . strtolower(Helper::getUnqualifiedClassName(get_class($this))) . '">' . $content . '</div>';
+            $content = '<div class="tx-dlf-'.strtolower(Helper::getUnqualifiedClassName(get_class($this))).'">'.$content.'</div>';
             if (!$this->frontendController->config['config']['disablePrefixComment']) {
-                $content = "\n\n<!-- BEGIN: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n" . $content . "\n\n<!-- END: Content of extension '" . $this->extKey . "', plugin '" . Helper::getUnqualifiedClassName(get_class($this)) . "' -->\n\n";
+                $content = "\n\n<!-- BEGIN: Content of extension '".$this->extKey."', plugin '".Helper::getUnqualifiedClassName(get_class($this))."' -->\n\n".$content."\n\n<!-- END: Content of extension '".$this->extKey."', plugin '".Helper::getUnqualifiedClassName(get_class($this))."' -->\n\n";
             }
         }
         return $content;

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

@@ -37,8 +37,8 @@ 
     public $prefixId = 'tx_dlf';
     public $scriptRelPath = 'Classes/Common/AbstractPlugin.php';
     // Plugins are cached by default (@see setCache()).
-    public $pi_USER_INT_obj = false;
-    public $pi_checkCHash = true;
+    public $pi_USER_INT_obj = FALSE;
+    public $pi_checkCHash = TRUE;
 
     /**
      * This holds the current document
@@ -150,7 +150,7 @@ 
             $this->doc = Document::getInstance($this->piVars['id'], $pid);
             if (!$this->doc->ready) {
                 // Destroy the incomplete object.
-                $this->doc = null;
+                $this->doc = NULL;
                 $this->logger->error('Failed to load document with UID ' . $this->piVars['id']);
             } else {
                 // Set configuration PID.
@@ -229,14 +229,14 @@ 
      *
      * @return string The input string wrapped in <a> tags
      */
-    public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0)
+    public function pi_linkTP($str, $urlParameters = [], $cache = FALSE, $altPageId = 0)
     {
         $conf = [];
         if (!$cache) {
-            $conf['no_cache'] = true;
+            $conf['no_cache'] = TRUE;
         }
         $conf['parameter'] = $altPageId ? : ($this->pi_tmpPageId ? : 'current');
-        $conf['additionalParams'] = $this->conf['parent.']['addParams'] . HttpUtility::buildQueryString($urlParameters, '&', true) . $this->pi_moreParams;
+        $conf['additionalParams'] = $this->conf['parent.']['addParams'] . HttpUtility::buildQueryString($urlParameters, '&', TRUE) . $this->pi_moreParams;
         // Add additional configuration for absolute URLs.
         $conf['forceAbsoluteUrl'] = !empty($this->conf['forceAbsoluteUrl']) ? 1 : 0;
         $conf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
@@ -274,20 +274,20 @@ 
      *
      * @return void
      */
-    protected function setCache($cache = true)
+    protected function setCache($cache = TRUE)
     {
         if ($cache) {
             // Set cObject type to "USER" (default).
-            $this->pi_USER_INT_obj = false;
-            $this->pi_checkCHash = true;
+            $this->pi_USER_INT_obj = FALSE;
+            $this->pi_checkCHash = TRUE;
             if (count($this->piVars)) {
                 // Check cHash or disable caching.
                 $GLOBALS['TSFE']->reqCHash();
             }
         } else {
             // Set cObject type to "USER_INT".
-            $this->pi_USER_INT_obj = true;
-            $this->pi_checkCHash = false;
+            $this->pi_USER_INT_obj = TRUE;
+            $this->pi_checkCHash = FALSE;
             // Plugins are of type "USER" by default, so convert it to "USER_INT".
             $this->cObj->convertToUserIntObject();
         }