Erikmitk / kitodo-presentation

Classes/Common/MetsDocument.php

Spacing +29 added lines, -29 removed lines

@@ -217,7 +217,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']);
@@ -227,9 +227,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;
     }
@@ -240,14 +240,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 '';
         }
     }
@@ -258,14 +258,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 '';
         }
     }
@@ -286,7 +286,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');
@@ -427,7 +427,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.
@@ -478,7 +478,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]];
             }
@@ -503,11 +503,11 @@ 
                     ) {
                         $obj->extractMetadata($this->mdSec[$dmdId]['xml'], $metadata);
                     } else {
-                        $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
+                        $this->logger->warning('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->mdSec[$dmdId]['type'].'"');
                     }
                 }
             } else {
-                $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
+                $this->logger->notice('Unsupported metadata format "'.$this->mdSec[$dmdId]['type'].'" in '.$mdSectionType.' with @ID "'.$dmdId.'"');
                 // Continue searching for supported metadata with next @DMDID.
                 continue;
             }
@@ -623,13 +623,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];
                     }
                 }
             }
@@ -645,7 +645,7 @@ 
         if (isset($this->fileInfos[$id]) || isset($hasMetadataSection['dmdSec'])) {
             return $metadata;
         } else {
-            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "' . $id . '"');
+            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "'.$id.'"');
             return [];
         }
     }
@@ -670,7 +670,7 @@ 
             $dmdIds = $this->logicalUnits[$id]['dmdId'] ?? '';
             $admIds = $this->logicalUnits[$id]['admId'] ?? '';
         } else {
-            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]')[0];
+            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]')[0];
             if ($mdSec) {
                 $dmdIds = (string) $mdSec->attributes()->DMDID;
                 $admIds = (string) $mdSec->attributes()->ADMID;
@@ -698,7 +698,7 @@ 
             }
         }
 
-        return array_filter($allMdIds, function ($element) {
+        return array_filter($allMdIds, function($element) {
             return !empty($element);
         });
     }
@@ -725,7 +725,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 {
@@ -749,9 +749,9 @@ 
             $this->registerNamespaces($this->mets);
         } else {
             if (!empty($location)) {
-                $this->logger->error('No METS part found in document with location "' . $location . '".');
+                $this->logger->error('No METS part found in document with location "'.$location.'".');
             } else if (!empty($this->recordId)) {
-                $this->logger->error('No METS part found in document with recordId "' . $this->recordId . '".');
+                $this->logger->error('No METS part found in document with recordId "'.$this->recordId.'".');
             } else {
                 $this->logger->error('No METS part found in current document.');
             }
@@ -773,7 +773,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;
     }
 
@@ -888,12 +888,12 @@ 
         if ($type = $element->xpath('./mets:mdWrap[not(@MDTYPE="OTHER")]/@MDTYPE')) {
             if (!empty($this->formats[(string) $type[0]])) {
                 $type = (string) $type[0];
-                $xml = $element->xpath('./mets:mdWrap[@MDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                $xml = $element->xpath('./mets:mdWrap[@MDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
             }
         } elseif ($type = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"]/@OTHERMDTYPE')) {
             if (!empty($this->formats[(string) $type[0]])) {
                 $type = (string) $type[0];
-                $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
             }
         }
 
@@ -1100,7 +1100,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;
             }
@@ -1137,7 +1137,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];
                     }
@@ -1160,7 +1160,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;
         }
@@ -1207,7 +1207,7 @@ 
             $this->parentHref = '';
 
             // Get the closest ancestor of the current document which has a MPTR child.
-            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $this->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
+            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$this->toplevelId.'"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
             if (!empty($parentMptr)) {
                 $this->parentHref = (string) $parentMptr[0]->attributes('http://www.w3.org/1999/xlink')->href;
             }

Braces +32 added lines, -64 removed lines

@@ -50,8 +50,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
  * @property-read string $parentHref URL of the parent document (determined via mptr element), or empty string if none is available
  */
-final class MetsDocument extends Doc
-{
+final class MetsDocument extends Doc {
     /**
      * Subsections / tags that may occur within `<mets:amdSec>`.
      *
@@ -176,8 +175,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'];
@@ -191,8 +189,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::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'];
@@ -212,8 +209,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
@@ -238,8 +234,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::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)
@@ -256,8 +251,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::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)
@@ -274,8 +268,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         // Is the requested logical unit already loaded?
         if (
@@ -315,8 +308,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;
@@ -415,8 +407,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::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.
@@ -659,8 +650,7 @@ 
      * @param string $id: The "@ID" attribute of the file node
      * @return void
      */
-    protected function getMetadataIds($id)
-    {
+    protected function getMetadataIds($id) {
         // ­Load amdSecChildIds concordance
         $this->_getMdSec();
         $this->_getFileInfos();
@@ -707,8 +697,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFullText()
      */
-    public function getFullText($id)
-    {
+    public function getFullText($id) {
         $fullText = '';
 
         // Load fileGrps and check for full text files.
@@ -723,8 +712,7 @@ 
      * {@inheritDoc}
      * @see Doc::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);
@@ -737,8 +725,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::init()
      */
-    protected function init($location)
-    {
+    protected function init($location) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_class($this));
         // Get METS node from XML file.
         $this->registerNamespaces($this->xml);
@@ -762,8 +749,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = Helper::getUrl($location);
         if ($fileResource !== false) {
             $xml = Helper::getXmlFileAsString($fileResource);
@@ -781,8 +767,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -793,8 +778,7 @@ 
      * {@inheritDoc}
      * @see Doc::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -807,8 +791,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -819,8 +802,7 @@ 
      *
      * @return array Array of metadata sections with their IDs as array key
      */
-    protected function _getMdSec()
-    {
+    protected function _getMdSec() {
         if (!$this->mdSecLoaded) {
             $this->loadFormats();
 
@@ -862,8 +844,7 @@ 
         return $this->mdSec;
     }
 
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         $this->_getMdSec();
         return $this->dmdSec;
     }
@@ -877,8 +858,7 @@ 
      *
      * @return array|null The processed metadata section
      */
-    protected function processMdSec($element)
-    {
+    protected function processMdSec($element) {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
             return null;
@@ -918,8 +898,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);
@@ -971,8 +950,7 @@ 
      * @access protected
      * @return array
      */
-    protected function _getFileInfos()
-    {
+    protected function _getFileInfos() {
         $this->_getFileGrps();
         return $this->fileInfos;
     }
@@ -981,8 +959,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::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)) {
@@ -1000,8 +977,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -1009,8 +985,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_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"?
@@ -1072,8 +1047,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded) {
             $smLinks = $this->mets->xpath('./mets:structLink/mets:smLink');
             if (!empty($smLinks)) {
@@ -1091,8 +1065,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1171,8 +1144,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_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)]');
@@ -1201,8 +1173,7 @@ 
      *
      * @return string|null
      */
-    public function _getParentHref()
-    {
+    public function _getParentHref() {
         if ($this->parentHref === null) {
             $this->parentHref = '';
 
@@ -1224,8 +1195,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'];
@@ -1238,8 +1208,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;
@@ -1254,8 +1223,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $xml = Helper::getXmlFileAsString($this->asXML);
         if ($xml !== false) {
             $this->asXML = '';

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

@@ -95,7 +95,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $mdSecLoaded = false;
+    protected $mdSecLoaded = FALSE;
 
     /**
      * Subset of $mdSec storing only the dmdSec entries; kept for compatibility.
@@ -129,7 +129,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $fileGrpsLoaded = false;
+    protected $fileGrpsLoaded = FALSE;
 
     /**
      * Additional information about files (e.g., ADMID), indexed by ID.
@@ -223,11 +223,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';
         }
@@ -274,7 +274,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
+    public function getLogicalStructure($id, $recursive = FALSE)
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -315,7 +315,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) {
@@ -361,7 +361,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])) {
@@ -405,7 +405,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;
@@ -634,7 +634,7 @@ 
                 }
             }
 
-            $hasMetadataSection[$mdSectionType] = true;
+            $hasMetadataSection[$mdSectionType] = TRUE;
         }
         // Set title to empty string if not present.
         if (empty($metadata['title'][0])) {
@@ -765,16 +765,16 @@ 
     protected function loadLocation($location)
     {
         $fileResource = Helper::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $xml = Helper::getXmlFileAsString($fileResource);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -798,9 +798,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -827,7 +827,7 @@ 
             foreach ($this->mets->xpath('./mets:dmdSec') as $dmdSecTag) {
                 $dmdSec = $this->processMdSec($dmdSecTag);
 
-                if ($dmdSec !== null) {
+                if ($dmdSec !== NULL) {
                     $this->mdSec[$dmdSec['id']] = $dmdSec;
                     $this->dmdSec[$dmdSec['id']] = $dmdSec;
                 }
@@ -844,7 +844,7 @@ 
                     // TODO: Should we check that the format may occur within this type (e.g., to ignore VIDEOMD within rightsMD)?
                     $mdSec = $this->processMdSec($mdSecTag);
 
-                    if ($mdSec !== null) {
+                    if ($mdSec !== NULL) {
                         $this->mdSec[$mdSec['id']] = $mdSec;
 
                         $childIds[] = $mdSec['id'];
@@ -857,7 +857,7 @@ 
                 }
             }
 
-            $this->mdSecLoaded = true;
+            $this->mdSecLoaded = TRUE;
         }
         return $this->mdSec;
     }
@@ -881,7 +881,7 @@ 
     {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($element);
@@ -898,7 +898,7 @@ 
         }
 
         if (empty($xml)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($xml[0]);
@@ -959,9 +959,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;
     }
@@ -1063,7 +1063,7 @@ 
                     $this->physicalStructure = array_merge($physSeq, $elements);
                 }
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -1082,7 +1082,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;
     }
@@ -1091,7 +1091,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
+    protected function _getThumbnail($forceReload = FALSE)
     {
         if (
             !$this->thumbnailLoaded
@@ -1101,14 +1101,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();
@@ -1162,7 +1162,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1203,7 +1203,7 @@ 
      */
     public function _getParentHref()
     {
-        if ($this->parentHref === null) {
+        if ($this->parentHref === NULL) {
             $this->parentHref = '';
 
             // Get the closest ancestor of the current document which has a MPTR child.
@@ -1241,8 +1241,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();
     }
 
@@ -1257,7 +1257,7 @@ 
     public function __wakeup()
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.

Classes/Common/SolrSearch.php

Spacing +21 added lines, -21 removed lines

@@ -97,7 +97,7 @@ 
             // in which case metadata of toplevel entry isn't yet filled.
             if (empty($document['metadata'])) {
                 $document['metadata'] = $this->fetchToplevelMetadataFromSolr([
-                    'query' => 'uid:' . $document['uid'],
+                    'query' => 'uid:'.$document['uid'],
                     'start' => 0,
                     'rows' => 1,
                     'sort' => ['score' => 'desc'],
@@ -108,7 +108,7 @@ 
             if (empty($document['title']) && $document['partOf'] > 0) {
                 $superiorTitle = Doc::getTitle($document['partOf'], true);
                 if (!empty($superiorTitle)) {
-                    $document['title'] = '[' . $superiorTitle . ']';
+                    $document['title'] = '['.$superiorTitle.']';
                 }
             }
         }
@@ -171,13 +171,13 @@ 
         // Set search query.
         if (
             (!empty($this->searchParams['fulltext']))
-            || preg_match('/' . $fields['fulltext'] . ':\((.*)\)/', trim($this->searchParams['query']), $matches)
+            || preg_match('/'.$fields['fulltext'].':\((.*)\)/', trim($this->searchParams['query']), $matches)
         ) {
             // If the query already is a fulltext query e.g using the facets
             $this->searchParams['query'] = empty($matches[1]) ? $this->searchParams['query'] : $matches[1];
             // Search in fulltext field if applicable. Query must not be empty!
             if (!empty($this->searchParams['query'])) {
-                $query = $fields['fulltext'] . ':(' . Solr::escapeQuery(trim($this->searchParams['query'])) . ')';
+                $query = $fields['fulltext'].':('.Solr::escapeQuery(trim($this->searchParams['query'])).')';
             }
             $params['fulltext'] = true;
         } else {
@@ -200,9 +200,9 @@ 
                         in_array($this->searchParams['extOperator'][$i], $allowedOperators)
                     ) {
                         if (!empty($query)) {
-                            $query .= ' ' . $this->searchParams['extOperator'][$i] . ' ';
+                            $query .= ' '.$this->searchParams['extOperator'][$i].' ';
                         }
-                        $query .= Indexer::getIndexFieldName($this->searchParams['extField'][$i], $this->settings['storagePid']) . ':(' . Solr::escapeQuery($this->searchParams['extQuery'][$i]) . ')';
+                        $query .= Indexer::getIndexFieldName($this->searchParams['extField'][$i], $this->settings['storagePid']).':('.Solr::escapeQuery($this->searchParams['extQuery'][$i]).')';
                     }
                 }
             }
@@ -222,22 +222,22 @@ 
         ) {
             // Search in document and all subordinates (valid for up to three levels of hierarchy).
             $params['filterquery'][]['query'] = '_query_:"{!join from='
-                . $fields['uid'] . ' to=' . $fields['partof'] . '}'
-                . $fields['uid'] . ':{!join from=' . $fields['uid'] . ' to=' . $fields['partof'] . '}'
-                . $fields['uid'] . ':' . $this->searchParams['documentId'] . '"' . ' OR {!join from='
-                . $fields['uid'] . ' to=' . $fields['partof'] . '}'
-                . $fields['uid'] . ':' . $this->searchParams['documentId'] . ' OR '
-                . $fields['uid'] . ':' . $this->searchParams['documentId'];
+                . $fields['uid'].' to='.$fields['partof'].'}'
+                . $fields['uid'].':{!join from='.$fields['uid'].' to='.$fields['partof'].'}'
+                . $fields['uid'].':'.$this->searchParams['documentId'].'"'.' OR {!join from='
+                . $fields['uid'].' to='.$fields['partof'].'}'
+                . $fields['uid'].':'.$this->searchParams['documentId'].' OR '
+                . $fields['uid'].':'.$this->searchParams['documentId'];
         }
 
         // if a collection is given, we prepare the collection query string
         if ($this->collection) {
             if ($this->collection instanceof Collection) {
-                $collectionsQueryString = '"' . $this->collection->getIndexName() . '"';
+                $collectionsQueryString = '"'.$this->collection->getIndexName().'"';
             } else {
                 $collectionsQueryString = '';
                 foreach ($this->collection as $index => $collectionEntry) {
-                    $collectionsQueryString .= ($index > 0 ? ' OR ' : '') . '"' . $collectionEntry->getIndexName() . '"';
+                    $collectionsQueryString .= ($index > 0 ? ' OR ' : '').'"'.$collectionEntry->getIndexName().'"';
                 }
             }
 
@@ -245,7 +245,7 @@ 
                 $params['filterquery'][]['query'] = 'toplevel:true';
                 $params['filterquery'][]['query'] = 'partof:0';
             }
-            $params['filterquery'][]['query'] = 'collection_faceting:(' . $collectionsQueryString . ')';
+            $params['filterquery'][]['query'] = 'collection_faceting:('.$collectionsQueryString.')';
         }
 
         // Set some query parameters.
@@ -272,8 +272,8 @@ 
         if ($this->listedMetadata) {
             foreach ($this->listedMetadata as $metadata) {
                 if ($metadata->getIndexStored() || $metadata->getIndexIndexed()) {
-                    $listMetadataRecord = $metadata->getIndexName() . '_' . ($metadata->getIndexTokenized() ? 't' : 'u') . ($metadata->getIndexStored() ? 's' : 'u') . ($metadata->getIndexIndexed() ? 'i' : 'u');
-                    $params['fields'] .= ',' . $listMetadataRecord;
+                    $listMetadataRecord = $metadata->getIndexName().'_'.($metadata->getIndexTokenized() ? 't' : 'u').($metadata->getIndexStored() ? 's' : 'u').($metadata->getIndexIndexed() ? 'i' : 'u');
+                    $params['fields'] .= ','.$listMetadataRecord;
                     $params['listMetadataRecords'][$metadata->getIndexName()] = $listMetadataRecord;
                 }
             }
@@ -351,7 +351,7 @@ 
                             $children = $childrenOf[$doc['uid']] ?? [];
                             if (!empty($children)) {
                                 $metadataOf = $this->fetchToplevelMetadataFromSolr([
-                                    'query' => 'partof:' . $doc['uid'],
+                                    'query' => 'partof:'.$doc['uid'],
                                     'start' => 0,
                                     'rows' => 100,
                                 ]);
@@ -398,8 +398,8 @@ 
         if ($this->listedMetadata) {
             foreach ($this->listedMetadata as $metadata) {
                 if ($metadata->getIndexStored() || $metadata->getIndexIndexed()) {
-                    $listMetadataRecord = $metadata->getIndexName() . '_' . ($metadata->getIndexTokenized() ? 't' : 'u') . ($metadata->getIndexStored() ? 's' : 'u') . ($metadata->getIndexIndexed() ? 'i' : 'u');
-                    $params['fields'] .= ',' . $listMetadataRecord;
+                    $listMetadataRecord = $metadata->getIndexName().'_'.($metadata->getIndexTokenized() ? 't' : 'u').($metadata->getIndexStored() ? 's' : 'u').($metadata->getIndexIndexed() ? 'i' : 'u');
+                    $params['fields'] .= ','.$listMetadataRecord;
                     $params['listMetadataRecords'][$metadata->getIndexName()] = $listMetadataRecord;
                 }
             }
@@ -449,7 +449,7 @@ 
         $cache = null;
         // Calculate cache identifier.
         if ($enableCache === true) {
-            $cacheIdentifier = Helper::digest($solr->core . print_r($parameters, true));
+            $cacheIdentifier = Helper::digest($solr->core.print_r($parameters, true));
             $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         }
         $resultSet = [

Braces +22 added lines, -44 removed lines

@@ -33,8 +33,7 @@ 
      * @param array $searchParams
      * @param QueryResult $listedMetadata
      */
-    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = null)
-    {
+    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = null) {
         $this->documentRepository = $documentRepository;
         $this->collection = $collection;
         $this->settings = $settings;
@@ -42,13 +41,11 @@ 
         $this->listedMetadata = $listedMetadata;
     }
 
-    public function getNumLoadedDocuments()
-    {
+    public function getNumLoadedDocuments() {
         return count($this->result['documents']);
     }
 
-    public function count()
-    {
+    public function count() {
         if ($this->result === null) {
             return 0;
         }
@@ -56,39 +53,32 @@ 
         return $this->result['numberOfToplevels'];
     }
 
-    public function current()
-    {
+    public function current() {
         return $this[$this->position];
     }
 
-    public function key()
-    {
+    public function key() {
         return $this->position;
     }
 
-    public function next()
-    {
+    public function next() {
         $this->position++;
     }
 
-    public function rewind()
-    {
+    public function rewind() {
         $this->position = 0;
     }
 
-    public function valid()
-    {
+    public function valid() {
         return isset($this[$this->position]);
     }
 
-    public function offsetExists($offset)
-    {
+    public function offsetExists($offset) {
         $idx = $this->result['document_keys'][$offset];
         return isset($this->result['documents'][$idx]);
     }
 
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         $idx = $this->result['document_keys'][$offset];
         $document = $this->result['documents'][$idx] ?? null;
 
@@ -116,38 +106,31 @@ 
         return $document;
     }
 
-    public function offsetSet($offset, $value)
-    {
+    public function offsetSet($offset, $value) {
         throw new \Exception("SolrSearch: Modifying result list is not supported");
     }
 
-    public function offsetUnset($offset)
-    {
+    public function offsetUnset($offset) {
         throw new \Exception("SolrSearch: Modifying result list is not supported");
     }
 
-    public function getSolrResults()
-    {
+    public function getSolrResults() {
         return $this->result['solrResults'];
     }
 
-    public function getByUid($uid)
-    {
+    public function getByUid($uid) {
         return $this->result['documents'][$uid];
     }
 
-    public function getQuery()
-    {
+    public function getQuery() {
         return new SolrSearchQuery($this);
     }
 
-    public function getFirst()
-    {
+    public function getFirst() {
         return $this[0];
     }
 
-    public function toArray()
-    {
+    public function toArray() {
         return array_values($this->result['documents']);
     }
 
@@ -156,13 +139,11 @@ 
      *
      * This can be accessed in Fluid template using `.numFound`.
      */
-    public function getNumFound()
-    {
+    public function getNumFound() {
         return $this->result['numFound'];
     }
 
-    public function prepare()
-    {
+    public function prepare() {
         // Prepare query parameters.
         $params = [];
         $matches = [];
@@ -285,8 +266,7 @@ 
         $this->submit(0, 1, false);
     }
 
-    public function submit($start, $rows, $processResults = true)
-    {
+    public function submit($start, $rows, $processResults = true) {
         $params = $this->params;
         $params['start'] = $start;
         $params['rows'] = $rows;
@@ -383,8 +363,7 @@ 
      * @param int $queryParams
      * @return array
      */
-    protected function fetchToplevelMetadataFromSolr($queryParams)
-    {
+    protected function fetchToplevelMetadataFromSolr($queryParams) {
         // Prepare query parameters.
         $params = $queryParams;
         $metadataArray = [];
@@ -427,8 +406,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    protected function searchSolr($parameters = [], $enableCache = true)
-    {
+    protected function searchSolr($parameters = [], $enableCache = true) {
         // Set query.
         $parameters['query'] = isset($parameters['query']) ? $parameters['query'] : '*';
         $parameters['filterquery'] = isset($parameters['filterquery']) ? $parameters['filterquery'] : [];

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

@@ -33,7 +33,7 @@ 
      * @param array $searchParams
      * @param QueryResult $listedMetadata
      */
-    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = null)
+    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = NULL)
     {
         $this->documentRepository = $documentRepository;
         $this->collection = $collection;
@@ -49,7 +49,7 @@ 
 
     public function count()
     {
-        if ($this->result === null) {
+        if ($this->result === NULL) {
             return 0;
         }
 
@@ -90,9 +90,9 @@ 
     public function offsetGet($offset)
     {
         $idx = $this->result['document_keys'][$offset];
-        $document = $this->result['documents'][$idx] ?? null;
+        $document = $this->result['documents'][$idx] ?? NULL;
 
-        if ($document !== null) {
+        if ($document !== NULL) {
             // It may happen that a Solr group only includes non-toplevel results,
             // in which case metadata of toplevel entry isn't yet filled.
             if (empty($document['metadata'])) {
@@ -106,7 +106,7 @@ 
 
             // get title of parent/grandparent/... if empty
             if (empty($document['title']) && $document['partOf'] > 0) {
-                $superiorTitle = Doc::getTitle($document['partOf'], true);
+                $superiorTitle = Doc::getTitle($document['partOf'], TRUE);
                 if (!empty($superiorTitle)) {
                     $document['title'] = '[' . $superiorTitle . ']';
                 }
@@ -179,7 +179,7 @@ 
             if (!empty($this->searchParams['query'])) {
                 $query = $fields['fulltext'] . ':(' . Solr::escapeQuery(trim($this->searchParams['query'])) . ')';
             }
-            $params['fulltext'] = true;
+            $params['fulltext'] = TRUE;
         } else {
             // Retain given search field if valid.
             if (!empty($this->searchParams['query'])) {
@@ -282,17 +282,17 @@ 
         $this->params = $params;
 
         // Send off query to get total number of search results in advance
-        $this->submit(0, 1, false);
+        $this->submit(0, 1, FALSE);
     }
 
-    public function submit($start, $rows, $processResults = true)
+    public function submit($start, $rows, $processResults = TRUE)
     {
         $params = $this->params;
         $params['start'] = $start;
         $params['rows'] = $rows;
 
         // Perform search.
-        $result = $this->searchSolr($params, true);
+        $result = $this->searchSolr($params, TRUE);
 
         // Initialize values
         $documents = [];
@@ -316,7 +316,7 @@ 
                     $documents[$doc['uid']] = $allDocuments[$doc['uid']];
                 }
                 if ($documents[$doc['uid']]) {
-                    if ($doc['toplevel'] === false) {
+                    if ($doc['toplevel'] === FALSE) {
                         // this maybe a chapter, article, ..., year
                         if ($doc['type'] === 'year') {
                             continue;
@@ -340,7 +340,7 @@ 
                             }
                             $documents[$doc['uid']]['searchResults'][] = $searchResult;
                         }
-                    } else if ($doc['toplevel'] === true) {
+                    } else if ($doc['toplevel'] === TRUE) {
                         foreach ($params['listMetadataRecords'] as $indexName => $solrField) {
                             if (isset($doc['metadata'][$indexName])) {
                                 $documents[$doc['uid']]['metadata'][$indexName] = $doc['metadata'][$indexName];
@@ -408,7 +408,7 @@ 
         $params['filterquery'][] = ['query' => 'toplevel:true'];
 
         // Perform search.
-        $result = $this->searchSolr($params, true);
+        $result = $this->searchSolr($params, TRUE);
 
         foreach ($result['documents'] as $doc) {
             $metadataArray[$doc['uid']] = $doc['metadata'];
@@ -427,7 +427,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    protected function searchSolr($parameters = [], $enableCache = true)
+    protected function searchSolr($parameters = [], $enableCache = TRUE)
     {
         // Set query.
         $parameters['query'] = isset($parameters['query']) ? $parameters['query'] : '*';
@@ -446,10 +446,10 @@ 
         }
 
         $cacheIdentifier = '';
-        $cache = null;
+        $cache = NULL;
         // Calculate cache identifier.
-        if ($enableCache === true) {
-            $cacheIdentifier = Helper::digest($solr->core . print_r($parameters, true));
+        if ($enableCache === TRUE) {
+            $cacheIdentifier = Helper::digest($solr->core . print_r($parameters, TRUE));
             $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         }
         $resultSet = [
@@ -457,22 +457,22 @@ 
             'numberOfToplevels' => 0,
             'numFound' => 0,
         ];
-        if ($enableCache === false || ($entry = $cache->get($cacheIdentifier)) === false) {
+        if ($enableCache === FALSE || ($entry = $cache->get($cacheIdentifier)) === FALSE) {
             $selectQuery = $solr->service->createSelect($parameters);
 
             $grouping = $selectQuery->getGrouping();
             $grouping->addField('uid');
             $grouping->setLimit(100); // Results in group (TODO: check)
-            $grouping->setNumberOfGroups(true);
+            $grouping->setNumberOfGroups(TRUE);
 
-            if ($parameters['fulltext'] === true) {
+            if ($parameters['fulltext'] === TRUE) {
                 // get highlighting component and apply settings
                 $selectQuery->getHighlighting();
             }
 
             $solrRequest = $solr->service->createRequest($selectQuery);
 
-            if ($parameters['fulltext'] === true) {
+            if ($parameters['fulltext'] === TRUE) {
                 // If it is a fulltext search, enable highlighting.
                 // field for which highlighting is going to be performed,
                 // is required if you want to have OCR highlighting
@@ -493,7 +493,7 @@ 
             $resultSet['numberOfToplevels'] = $uidGroup->getNumberOfGroups();
             $resultSet['numFound'] = $uidGroup->getMatches();
             $highlighting = [];
-            if ($parameters['fulltext'] === true) {
+            if ($parameters['fulltext'] === TRUE) {
                 $data = $result->getData();
                 $highlighting = $data['ocrHighlighting'];
             }
@@ -524,7 +524,7 @@ 
             }
 
             // Save value in cache.
-            if (!empty($resultSet) && $enableCache === true) {
+            if (!empty($resultSet) && $enableCache === TRUE) {
                 $cache->set($cacheIdentifier, $resultSet);
             }
         } else {

Classes/Common/Helper.php

Spacing +36 added lines, -36 removed lines

@@ -143,7 +143,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;
                 }
@@ -315,7 +315,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;
     }
@@ -369,8 +369,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);
             }
         }
@@ -397,12 +397,12 @@ 
             // NOTE: Only use tables that don't have too many entries!
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::log('Invalid UID "' . $uid . '" or table "' . $table . '"', LOG_SEVERITY_ERROR);
+            self::log('Invalid UID "'.$uid.'" or table "'.$table.'"', LOG_SEVERITY_ERROR);
             return '';
         }
 
-        $makeCacheKey = function ($pid, $uid) {
-            return $pid . '.' . $uid;
+        $makeCacheKey = function($pid, $uid) {
+            return $pid.'.'.$uid;
         };
 
         static $cache = [];
@@ -412,9 +412,9 @@ 
 
             $result = $queryBuilder
                 ->select(
-                    $table . '.index_name AS index_name',
-                    $table . '.uid AS uid',
-                    $table . '.pid AS pid',
+                    $table.'.index_name AS index_name',
+                    $table.'.uid AS uid',
+                    $table.'.pid AS pid',
                 )
                 ->from($table)
                 ->execute();
@@ -432,7 +432,7 @@ 
         $result = $cache[$table][$cacheKey] ?? '';
 
         if ($result === '') {
-            self::log('No "index_name" with UID ' . $uid . ' and PID ' . $pid . ' found in table "' . $table . '"', LOG_SEVERITY_WARNING);
+            self::log('No "index_name" with UID '.$uid.' and PID '.$pid.' found in table "'.$table.'"', LOG_SEVERITY_WARNING);
         }
 
         return $result;
@@ -459,11 +459,11 @@ 
             // No ISO code, return unchanged.
             return $code;
         }
-        $lang = LocalizationUtility::translate('LLL:' . $file . ':' . $code);
+        $lang = LocalizationUtility::translate('LLL:'.$file.':'.$code);
         if (!empty($lang)) {
             return $lang;
         } else {
-            self::log('Language code "' . $code . '" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
+            self::log('Language code "'.$code.'" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
             return $code;
         }
     }
@@ -560,7 +560,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 '';
@@ -574,7 +574,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;
     }
 
     /**
@@ -668,7 +668,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;
         }
         /** @var \TYPO3\CMS\Frontend\Page\PageRepository $pageRepository */
@@ -690,13 +690,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)
@@ -709,12 +709,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($languageAspect->getContentId())),
+                    $queryBuilder->expr()->eq($table.'.pid', $pid),
+                    $queryBuilder->expr()->eq($table.'.uid', $resArray['l18n_parent']),
+                    $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($languageAspect->getContentId())),
                     self::whereExpression($table, true)
                 )
                 ->setMaxResults(1)
@@ -732,14 +732,14 @@ 
         if (empty($labels[$table][$pid][$languageAspect->getContentId()][$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 ($languageAspect->getContentId() > 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($languageAspect->getContentId()))
+                            $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]),
+                            $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($languageAspect->getContentId()))
                         ),
-                        $queryBuilder->expr()->eq($table . '.l18n_parent', 0)
+                        $queryBuilder->expr()->eq($table.'.l18n_parent', 0)
                     );
                 }
 
@@ -748,7 +748,7 @@ 
                     ->select('*')
                     ->from($table)
                     ->where(
-                        $queryBuilder->expr()->eq($table . '.pid', $pid),
+                        $queryBuilder->expr()->eq($table.'.pid', $pid),
                         $additionalWhere,
                         self::whereExpression($table, true)
                     )
@@ -766,10 +766,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);
             }
         }
 
@@ -811,9 +811,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';
         }
     }
@@ -852,7 +852,7 @@ 
      */
     public static function polyfillExtbaseClassesForTYPO3v9()
     {
-        $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
+        $classes = require __DIR__.'/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
         $configurationManager = $objectManager->get(ConfigurationManager::class);
@@ -908,10 +908,10 @@ 
         try {
             $response = $requestFactory->request($url, 'GET', $configuration);
         } catch (\Exception $e) {
-            self::log('Could not fetch data from URL "' . $url . '". Error: ' . $e->getMessage() . '.', LOG_SEVERITY_WARNING);
+            self::log('Could not fetch data from URL "'.$url.'". Error: '.$e->getMessage().'.', LOG_SEVERITY_WARNING);
             return false;
         }
-        $content  = $response->getBody()->getContents();
+        $content = $response->getBody()->getContents();
 
         return $content;
     }

Braces +24 added lines, -48 removed lines

@@ -32,8 +32,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -81,8 +80,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(
@@ -107,8 +105,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++) {
@@ -172,8 +169,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))
@@ -212,8 +208,7 @@ 
      *
      * @return \SimpleXMLElement|false
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
@@ -244,8 +239,7 @@ 
      *
      * @return void
      */
-    public static function log($message, $severity = 0)
-    {
+    public static function log($message, $severity = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_called_class());
 
         switch ($severity) {
@@ -275,8 +269,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;
@@ -295,8 +288,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))
@@ -329,8 +321,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -344,8 +335,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.
@@ -366,8 +356,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) {
@@ -388,8 +377,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 (
@@ -447,8 +435,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)) {
@@ -475,8 +462,7 @@ 
      *
      * @return array
      */
-    public static function getDocumentStructures($pid = -1)
-    {
+    public static function getDocumentStructures($pid = -1) {
         // TODO: Against redundancy with getIndexNameFromUid
 
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
@@ -518,8 +504,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,
@@ -586,8 +571,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -598,8 +582,7 @@ 
      *
      * @return bool
      */
-    public static function isValidHttpUrl($url)
-    {
+    public static function isValidHttpUrl($url) {
         if (!GeneralUtility::isValidUrl($url)) {
             return false;
         }
@@ -625,8 +608,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;
     }
@@ -640,8 +622,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();
@@ -661,8 +642,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.
@@ -790,8 +770,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;
@@ -823,8 +802,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 
@@ -850,8 +828,7 @@ 
      *
      * @access public
      */
-    public static function polyfillExtbaseClassesForTYPO3v9()
-    {
+    public static function polyfillExtbaseClassesForTYPO3v9() {
         $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
@@ -888,8 +865,7 @@ 
      *
      * @return string|bool
      */
-    public static function getUrl(string $url)
-    {
+    public static function getUrl(string $url) {
         if (!Helper::isValidHttpUrl($url)) {
             return false;
         }

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

@@ -81,7 +81,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);
@@ -123,9 +123,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':
@@ -133,19 +133,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':
@@ -154,13 +154,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;
     }
 
     /**
@@ -175,28 +175,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;
@@ -217,13 +217,13 @@ 
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
-            return false;
+            return FALSE;
         }
 
         // Turn off libxml's error logging.
-        $libxmlErrors = libxml_use_internal_errors(true);
+        $libxmlErrors = libxml_use_internal_errors(TRUE);
         // 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
@@ -277,9 +277,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);
@@ -298,23 +298,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;
@@ -601,7 +601,7 @@ 
     public static function isValidHttpUrl($url)
     {
         if (!GeneralUtility::isValidUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         $parsed = parse_url($url);
@@ -625,7 +625,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;
@@ -697,7 +697,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();
@@ -715,7 +715,7 @@ 
                     $queryBuilder->expr()->eq($table . '.pid', $pid),
                     $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
                     $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($languageAspect->getContentId())),
-                    self::whereExpression($table, true)
+                    self::whereExpression($table, TRUE)
                 )
                 ->setMaxResults(1)
                 ->execute();
@@ -750,7 +750,7 @@ 
                     ->where(
                         $queryBuilder->expr()->eq($table . '.pid', $pid),
                         $additionalWhere,
-                        self::whereExpression($table, true)
+                        self::whereExpression($table, TRUE)
                     )
                     ->setMaxResults(10000)
                     ->execute();
@@ -790,7 +790,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?
@@ -859,13 +859,13 @@ 
         $frameworkConfiguration = $configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
 
         $extbaseClassmap = &$frameworkConfiguration['persistence']['classes'];
-        if ($extbaseClassmap === null) {
+        if ($extbaseClassmap === NULL) {
             $extbaseClassmap = [];
         }
 
         foreach ($classes as $className => $classConfig) {
             $extbaseClass = &$extbaseClassmap[$className];
-            if ($extbaseClass === null) {
+            if ($extbaseClass === NULL) {
                 $extbaseClass = [];
             }
             if (!isset($extbaseClass['mapping'])) {
@@ -891,7 +891,7 @@ 
     public static function getUrl(string $url)
     {
         if (!Helper::isValidHttpUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         // Get extension configuration.
@@ -909,7 +909,7 @@ 
             $response = $requestFactory->request($url, 'GET', $configuration);
         } catch (\Exception $e) {
             self::log('Could not fetch data from URL "' . $url . '". Error: ' . $e->getMessage() . '.', LOG_SEVERITY_WARNING);
-            return false;
+            return FALSE;
         }
         $content  = $response->getBody()->getContents();
 

Classes/Common/SolrSearchQuery.php

Braces +8 added lines, -16 removed lines

@@ -10,10 +10,8 @@ 
 /**
  * Targeted towards being used in ``PaginateController`` (``<f:widget.paginate>``).
  */
-class SolrSearchQuery implements QueryInterface
-{
-    public function __construct($solrSearch)
-    {
+class SolrSearchQuery implements QueryInterface {
+    public function __construct($solrSearch) {
         $this->solrSearch = $solrSearch;
 
         $this->offset = 0;
@@ -22,8 +20,7 @@ 
 
     public function getSource() {}
 
-    public function execute($returnRawQueryResult = false)
-    {
+    public function execute($returnRawQueryResult = false) {
         $this->solrSearch->submit($this->offset, $this->limit);
 
         // solrSearch now only contains the results in range, indexed in [0, n)
@@ -37,14 +34,12 @@ 
 
     public function setOrderings(array $orderings) {}
 
-    public function setLimit($limit)
-    {
+    public function setLimit($limit) {
         $this->limit = $limit;
         return $this;
     }
 
-    public function setOffset($offset)
-    {
+    public function setOffset($offset) {
         $this->offset = $offset;
         return $this;
     }
@@ -65,20 +60,17 @@ 
     public function setQuerySettings(QuerySettingsInterface $querySettings) {}
     public function getQuerySettings() {}
 
-    public function count()
-    {
+    public function count() {
         // TODO?
     }
 
     public function getOrderings() {}
 
-    public function getLimit()
-    {
+    public function getLimit() {
         return $this->limit;
     }
 
-    public function getOffset()
-    {
+    public function getOffset() {
         return $this->offset;
     }
 

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

@@ -22,7 +22,7 @@ 
 
     public function getSource() {}
 
-    public function execute($returnRawQueryResult = false)
+    public function execute($returnRawQueryResult = FALSE)
     {
         $this->solrSearch->submit($this->offset, $this->limit);
 
@@ -53,7 +53,7 @@ 
     public function logicalAnd($constraint1) {}
     public function logicalOr($constraint1) {}
     public function logicalNot(ConstraintInterface $constraint) {}
-    public function equals($propertyName, $operand, $caseSensitive = true) {}
+    public function equals($propertyName, $operand, $caseSensitive = TRUE) {}
     public function like($propertyName, $operand) {}
     public function contains($propertyName, $operand) {}
     public function in($propertyName, $operand) {}

Classes/Command/BaseCommand.php

Spacing +1 added lines, -1 removed lines

@@ -298,7 +298,7 @@
         if ($doc !== null) {
             // Same as MetsDocument::parentHref (TODO: Use it)
             // Get the closest ancestor of the current document which has a MPTR child.
-            $parentMptr = $doc->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $doc->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
+            $parentMptr = $doc->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$doc->toplevelId.'"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
             if (!empty($parentMptr)) {
                 $parentLocation = (string) $parentMptr[0]->attributes('http://www.w3.org/1999/xlink')->href;
 

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

@@ -107,11 +107,11 @@ 
             // Get extension configuration.
             $this->extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get('dlf');
         } else {
-            return false;
+            return FALSE;
         }
         $this->storagePid = MathUtility::forceIntegerInRange((int) $storagePid, 0);
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -172,10 +172,10 @@ 
      */
     protected function saveToDatabase(Document $document)
     {
-        $success = false;
+        $success = FALSE;
 
         $doc = $document->getDoc();
-        if ($doc === null) {
+        if ($doc === NULL) {
             return $success;
         }
         $doc->cPid = $this->storagePid;
@@ -267,7 +267,7 @@ 
             $document->setPartof($this->getParentDocumentUidForSaving($document));
         }
 
-        if ($document->getUid() === null) {
+        if ($document->getUid() === NULL) {
             // new document
             $this->documentRepository->add($document);
         } else {
@@ -278,7 +278,7 @@ 
         $persistenceManager = GeneralUtility::makeInstance(PersistenceManager::class);
         $persistenceManager->persistAll();
 
-        $success = true;
+        $success = TRUE;
 
         return $success;
     }
@@ -295,7 +295,7 @@ 
     {
         $doc = $document->getDoc();
 
-        if ($doc !== null) {
+        if ($doc !== NULL) {
             // Same as MetsDocument::parentHref (TODO: Use it)
             // Get the closest ancestor of the current document which has a MPTR child.
             $parentMptr = $doc->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $doc->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
@@ -308,7 +308,7 @@ 
                 if ($parentDoc->recordId) {
                     $parentDocument = $this->documentRepository->findOneByRecordId($parentDoc->recordId);
 
-                    if ($parentDocument === null) {
+                    if ($parentDocument === NULL) {
                         // create new Document object
                         $parentDocument = GeneralUtility::makeInstance(Document::class);
                     }
@@ -320,7 +320,7 @@ 
 
                     $success = $this->saveToDatabase($parentDocument);
 
-                    if ($success === true) {
+                    if ($success === TRUE) {
                         // add to index
                         Indexer::add($parentDocument);
                         return $parentDocument->getUid();

Classes/Domain/Repository/DocumentRepository.php

Spacing +14 added lines, -14 removed lines

@@ -356,7 +356,7 @@ 
 
         $excludeOtherWhere = '';
         if ($settings['excludeOther']) {
-            $excludeOtherWhere = 'tx_dlf_documents.pid=' . intval($settings['storagePid']);
+            $excludeOtherWhere = 'tx_dlf_documents.pid='.intval($settings['storagePid']);
         }
         // Check if there are any metadata to suggest.
         $result = $queryBuilder
@@ -408,12 +408,12 @@ 
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getConnectionForTable('tx_dlf_documents');
 
-        $sql = 'SELECT `tx_dlf_documents`.*, GROUP_CONCAT(DISTINCT `tx_dlf_collections`.`oai_name` ORDER BY `tx_dlf_collections`.`oai_name` SEPARATOR " ") AS `collections` ' .
-            'FROM `tx_dlf_documents` ' .
-            'INNER JOIN `tx_dlf_relations` ON `tx_dlf_relations`.`uid_local` = `tx_dlf_documents`.`uid` ' .
-            'INNER JOIN `tx_dlf_collections` ON `tx_dlf_collections`.`uid` = `tx_dlf_relations`.`uid_foreign` ' .
-            'WHERE `tx_dlf_documents`.`record_id` = ? ' .
-            'AND `tx_dlf_relations`.`ident`="docs_colls" ' .
+        $sql = 'SELECT `tx_dlf_documents`.*, GROUP_CONCAT(DISTINCT `tx_dlf_collections`.`oai_name` ORDER BY `tx_dlf_collections`.`oai_name` SEPARATOR " ") AS `collections` '.
+            'FROM `tx_dlf_documents` '.
+            'INNER JOIN `tx_dlf_relations` ON `tx_dlf_relations`.`uid_local` = `tx_dlf_documents`.`uid` '.
+            'INNER JOIN `tx_dlf_collections` ON `tx_dlf_collections`.`uid` = `tx_dlf_relations`.`uid_foreign` '.
+            'WHERE `tx_dlf_documents`.`record_id` = ? '.
+            'AND `tx_dlf_relations`.`ident`="docs_colls" '.
             $where;
 
         $values = [
@@ -443,13 +443,13 @@ 
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getConnectionForTable('tx_dlf_documents');
 
-        $sql = 'SELECT `tx_dlf_documents`.*, GROUP_CONCAT(DISTINCT `tx_dlf_collections`.`oai_name` ORDER BY `tx_dlf_collections`.`oai_name` SEPARATOR " ") AS `collections` ' .
-            'FROM `tx_dlf_documents` ' .
-            'INNER JOIN `tx_dlf_relations` ON `tx_dlf_relations`.`uid_local` = `tx_dlf_documents`.`uid` ' .
-            'INNER JOIN `tx_dlf_collections` ON `tx_dlf_collections`.`uid` = `tx_dlf_relations`.`uid_foreign` ' .
-            'WHERE `tx_dlf_documents`.`uid` IN ( ? ) ' .
-            'AND `tx_dlf_relations`.`ident`="docs_colls" ' .
-            'AND ' . Helper::whereExpression('tx_dlf_collections') . ' ' .
+        $sql = 'SELECT `tx_dlf_documents`.*, GROUP_CONCAT(DISTINCT `tx_dlf_collections`.`oai_name` ORDER BY `tx_dlf_collections`.`oai_name` SEPARATOR " ") AS `collections` '.
+            'FROM `tx_dlf_documents` '.
+            'INNER JOIN `tx_dlf_relations` ON `tx_dlf_relations`.`uid_local` = `tx_dlf_documents`.`uid` '.
+            'INNER JOIN `tx_dlf_collections` ON `tx_dlf_collections`.`uid` = `tx_dlf_relations`.`uid_foreign` '.
+            'WHERE `tx_dlf_documents`.`uid` IN ( ? ) '.
+            'AND `tx_dlf_relations`.`ident`="docs_colls" '.
+            'AND '.Helper::whereExpression('tx_dlf_collections').' '.
             'GROUP BY `tx_dlf_documents`.`uid` ';
 
         $values = [

Braces +13 added lines, -26 removed lines

@@ -48,8 +48,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOneByParameters($parameters)
-    {
+    public function findOneByParameters($parameters) {
         $doc = null;
         $document = null;
 
@@ -93,8 +92,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOldestDocument()
-    {
+    public function findOldestDocument() {
         $query = $this->createQuery();
 
         $query->setOrderings(['tstamp' => QueryInterface::ORDER_ASCENDING]);
@@ -108,8 +106,7 @@ 
      * @param  \Kitodo\Dlf\Domain\Model\Structure $structure
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function getChildrenOfYearAnchor($partOf, $structure)
-    {
+    public function getChildrenOfYearAnchor($partOf, $structure) {
         $query = $this->createQuery();
 
         $query->matching($query->equals('structure', $structure));
@@ -130,8 +127,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOneByIdAndSettings($uid, $settings = [])
-    {
+    public function findOneByIdAndSettings($uid, $settings = []) {
         $settings = ['documentSets' => $uid];
 
         return $this->findDocumentsBySettings($settings)->getFirst();
@@ -144,8 +140,7 @@ 
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findDocumentsBySettings($settings = [])
-    {
+    public function findDocumentsBySettings($settings = []) {
         $query = $this->createQuery();
 
         $constraints = [];
@@ -175,8 +170,7 @@ 
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findAllByCollectionsLimited($collections, $limit = 50)
-    {
+    public function findAllByCollectionsLimited($collections, $limit = 50) {
         $query = $this->createQuery();
 
         // order by start_date -> start_time...
@@ -213,8 +207,7 @@ 
      *
      * @return array
      */
-    public function getStatisticsForSelectedCollection($settings)
-    {
+    public function getStatisticsForSelectedCollection($settings) {
         if ($settings['collections']) {
             // Include only selected collections.
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -348,8 +341,7 @@ 
      *
      * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function getTableOfContentsFromDb($uid, $pid, $settings)
-    {
+    public function getTableOfContentsFromDb($uid, $pid, $settings) {
         // Build table of contents from database.
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
@@ -397,8 +389,7 @@ 
      *
      * @return array The found document object
      */
-    public function getOaiRecord($settings, $parameters)
-    {
+    public function getOaiRecord($settings, $parameters) {
         $where = '';
 
         if (!$settings['show_userdefined']) {
@@ -438,8 +429,7 @@ 
      *
      * @return array The found document objects
      */
-    public function getOaiDocumentList($settings, $documentsToProcess)
-    {
+    public function getOaiDocumentList($settings, $documentsToProcess) {
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getConnectionForTable('tx_dlf_documents');
 
@@ -474,8 +464,7 @@ 
      *
      * @return array
      */
-    public function findAllByUids($uids, $checkPartof = false)
-    {
+    public function findAllByUids($uids, $checkPartof = false) {
         // get all documents from db we are talking about
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
         $queryBuilder = $connectionPool->getQueryBuilderForTable('tx_dlf_documents');
@@ -524,8 +513,7 @@ 
      *
      * @return array
      */
-    public function findChildrenOfEach(array $uids)
-    {
+    public function findChildrenOfEach(array $uids) {
         $allDocuments = $this->findAllByUids($uids, true);
 
         $result = [];
@@ -546,8 +534,7 @@ 
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\QueryResult $listedMetadata
      * @return array
      */
-    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null)
-    {
+    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null) {
         // set settings global inside this repository
         // (may be necessary when SolrSearch calls back)
         $this->settings = $settings;

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

@@ -50,8 +50,8 @@ 
      */
     public function findOneByParameters($parameters)
     {
-        $doc = null;
-        $document = null;
+        $doc = NULL;
+        $document = NULL;
 
         if (isset($parameters['id']) && MathUtility::canBeInterpretedAsInteger($parameters['id'])) {
 
@@ -63,13 +63,13 @@ 
 
         } else if (isset($parameters['location']) && GeneralUtility::isValidUrl($parameters['location'])) {
 
-            $doc = Doc::getInstance($parameters['location'], [], true);
+            $doc = Doc::getInstance($parameters['location'], [], TRUE);
 
             if ($doc->recordId) {
                 $document = $this->findOneByRecordId($doc->recordId);
             }
 
-            if ($document === null) {
+            if ($document === NULL) {
                 // create new (dummy) Document object
                 $document = GeneralUtility::makeInstance(Document::class);
                 $document->setLocation($parameters['location']);
@@ -77,11 +77,11 @@ 
 
         }
 
-        if ($document !== null && $doc === null) {
-            $doc = Doc::getInstance($document->getLocation(), [], true);
+        if ($document !== NULL && $doc === NULL) {
+            $doc = Doc::getInstance($document->getLocation(), [], TRUE);
         }
 
-        if ($doc !== null) {
+        if ($doc !== NULL) {
             $document->setDoc($doc);
         }
 
@@ -155,7 +155,7 @@ 
         }
 
         if (isset($settings['excludeOther']) && (int) $settings['excludeOther'] === 0) {
-            $query->getQuerySettings()->setRespectStoragePage(false);
+            $query->getQuerySettings()->setRespectStoragePage(FALSE);
         }
 
         if (count($constraints)) {
@@ -474,7 +474,7 @@ 
      *
      * @return array
      */
-    public function findAllByUids($uids, $checkPartof = false)
+    public function findAllByUids($uids, $checkPartof = FALSE)
     {
         // get all documents from db we are talking about
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
@@ -526,7 +526,7 @@ 
      */
     public function findChildrenOfEach(array $uids)
     {
-        $allDocuments = $this->findAllByUids($uids, true);
+        $allDocuments = $this->findAllByUids($uids, TRUE);
 
         $result = [];
         foreach ($allDocuments as $doc) {
@@ -546,7 +546,7 @@ 
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\QueryResult $listedMetadata
      * @return array
      */
-    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null)
+    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = NULL)
     {
         // set settings global inside this repository
         // (may be necessary when SolrSearch calls back)

Build/Documentation/dbdocs/Generator.php

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

@@ -63,7 +63,7 @@ 
     public function collectTables(): array
     {
         $sqlReader = $this->objectManager->get(SqlReader::class);
-        $sqlCode = $sqlReader->getTablesDefinitionString(true);
+        $sqlCode = $sqlReader->getTablesDefinitionString(TRUE);
         $createTableStatements = $sqlReader->getCreateTableStatementArray($sqlCode);
 
         $tableToClassName = $this->getTableClassMap();
@@ -79,7 +79,7 @@ 
                 continue;
             }
 
-            $className = $tableToClassName[$tableName] ?? null;
+            $className = $tableToClassName[$tableName] ?? NULL;
 
             $result[] = $this->getTableInfo($table, $className);
         }
@@ -120,7 +120,7 @@ 
         $isPrimary = [];
         if (!is_null($primaryKey = $table->getPrimaryKey())) {
             foreach ($primaryKey->getUnquotedColumns() as $primaryColumn) {
-                $isPrimary[$primaryColumn] = true;
+                $isPrimary[$primaryColumn] = TRUE;
             }
         }
 
@@ -141,14 +141,14 @@ 
         $result = (object) [
             'name' => $tableName,
             'columns' => $columns,
-            'modelClass' => null,
+            'modelClass' => NULL,
             'sqlComment' => $table->getComment() ?? '',
             'classComment' => '',
             'feComment' => $this->languageService->sL($GLOBALS['TCA'][$tableName]['ctrl']['title'] ?? ''),
         ];
 
         // Integrate doc-comments from model class and its fields
-        if ($className !== null) {
+        if ($className !== NULL) {
             $reflection = new ReflectionClass($className);
 
             $dataMap = $this->dataMapper->getDataMap($className);
@@ -158,7 +158,7 @@ 
                 // In that case, try to guess the column name from the property name.
 
                 $column = $dataMap->getColumnMap($property->getName());
-                $columnName = $column === null
+                $columnName = $column === NULL
                     ? GeneralUtility::camelCaseToLowerCaseUnderscored($property->getName())
                     : $column->getColumnName();
 
@@ -184,7 +184,7 @@ 
         $lines = explode("\n", $docComment);
         foreach ($lines as $line) {
             // Stop parsing at first tag
-            if ($line !== '' && strpos($line, '@') !== false) {
+            if ($line !== '' && strpos($line, '@') !== FALSE) {
                 break;
             }
 
@@ -208,7 +208,7 @@ 
 This is a reference of all database tables defined by Kitodo.Presentation.
 
 .. tip:: This page is auto-generated. If you would like to edit it, please use doc-comments in the model class, COMMENT fields in ``ext_tables.sql`` if the table does not have one, or TCA labels. Then, you may re-generate the page by running ``composer docs:db`` inside the Kitodo.Presentation base folder.
-RST);
+rst);
 
         // Sort tables alphabetically
         usort($tables, function ($lhs, $rhs) {
@@ -243,11 +243,11 @@ 
                     'field' => (
                         $page->format($column->name, ['bold' => $column->isPrimary])
                         . "\u{00a0}\u{00a0}"
-                        . $page->format($column->type->getName(), ['italic' => true])
+                        . $page->format($column->type->getName(), ['italic' => TRUE])
                     ),
 
                     'description' => $page->paragraphs([
-                        $page->format($column->feComment, ['italic' => true]),
+                        $page->format($column->feComment, ['italic' => TRUE]),
                         $column->fieldComment,
                         $column->sqlComment,
                     ]),

Tests/Functional/Common/HelperTest.php

Spacing +2 added lines, -2 removed lines

@@ -12,8 +12,8 @@
     {
         parent::setUp();
 
-        $this->importDataSet(__DIR__ . '/../../Fixtures/Common/libraries.xml');
-        $this->importDataSet(__DIR__ . '/../../Fixtures/Common/metadata.xml');
+        $this->importDataSet(__DIR__.'/../../Fixtures/Common/libraries.xml');
+        $this->importDataSet(__DIR__.'/../../Fixtures/Common/metadata.xml');
     }
 
     /**

Braces +4 added lines, -8 removed lines

@@ -6,8 +6,7 @@ 
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Core\Localization\LanguageService;
 
-class HelperTest extends FunctionalTestCase
-{
+class HelperTest extends FunctionalTestCase {
     public function setUp(): void
     {
         parent::setUp();
@@ -19,8 +18,7 @@ 
     /**
      * @test
      */
-    public function canGetIndexNameFromUid()
-    {
+    public function canGetIndexNameFromUid() {
         // Repeat to make sure caching isn't broken
         for ($n = 0; $n < 2; $n++) {
             // Good UID, no PID
@@ -69,8 +67,7 @@ 
      * @test
      * @group getLanguageName
      */
-    public function canTranslateLanguageNameToEnglish()
-    {
+    public function canTranslateLanguageNameToEnglish() {
         // NOTE: This only tests in BE mode
 
         $this->initLanguageService('default');
@@ -84,8 +81,7 @@ 
      * @test
      * @group getLanguageName
      */
-    public function canTranslateLanguageNameToGerman()
-    {
+    public function canTranslateLanguageNameToGerman() {
         // NOTE: This only tests in BE mode
 
         $this->initLanguageService('de');

Tests/Functional/Common/SolrIndexingTest.php

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

@@ -86,17 +86,17 @@
             'storagePid' => $document->getPid(),
         ];
 
-        $solrSearch = $this->documentRepository->findSolrByCollection(null, $solrSettings, ['query' => '*']);
+        $solrSearch = $this->documentRepository->findSolrByCollection(NULL, $solrSettings, ['query' => '*']);
         $solrSearch->getQuery()->execute();
         $this->assertEquals(1, count($solrSearch));
         $this->assertEquals(15, $solrSearch->getNumFound());
 
         // Check that the title stored in Solr matches the title of database entry
-        $docTitleInSolr = false;
+        $docTitleInSolr = FALSE;
         foreach ($solrSearch->getSolrResults()['documents'] as $solrDoc) {
             if ($solrDoc['toplevel'] && $solrDoc['uid'] === $document->getUid()) {
                 $this->assertEquals($document->getTitle(), $solrDoc['title']);
-                $docTitleInSolr = true;
+                $docTitleInSolr = TRUE;
                 break;
             }
         }