Erikmitk / kitodo-presentation

Classes/Common/Solr/SearchResult/Highlight.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
         $this->xEndPosition = $highlight['lrx'];
         $this->yBeginPosition = $highlight['uly'];
         $this->yEndPosition = $highlight['lry'];
-        $this->id = $this->xBeginPosition . '_' . $this->yBeginPosition;
+        $this->id = $this->xBeginPosition.'_'.$this->yBeginPosition;
     }
 
     /**

Braces +2 added lines, -4 removed lines

@@ -20,8 +20,7 @@ 
  *
  * @access public
  */
-class Highlight
-{
+class Highlight {
 
     /**
      * @access private
@@ -62,8 +61,7 @@ 
      *
      * @return void
      */
-    public function __construct(array $highlight)
-    {
+    public function __construct(array $highlight) {
         // there is also possibility to access parentRegionIdx
         // $this->parentRegionId = $highlight['parentRegionIdx'];
         $this->xBeginPosition = $highlight['ulx'];

Classes/Common/Solr/SearchResult/Region.php

Braces +2 added lines, -4 removed lines

@@ -20,8 +20,7 @@ 
  *
  * @access public
  */
-class Region
-{
+class Region {
 
     /**
      * @access private
@@ -87,8 +86,7 @@ 
      *
      * @return void
      */
-    public function __construct(int $id, array $region)
-    {
+    public function __construct(int $id, array $region) {
         $this->id = $id;
         $this->pageId = $region['pageIdx'];
         $this->xBeginPosition = $region['ulx'];

Classes/Common/Solr/SearchResult/ResultDocument.php

Braces +2 added lines, -4 removed lines

@@ -22,8 +22,7 @@ 
  *
  * @access public
  */
-class ResultDocument
-{
+class ResultDocument {
 
     /**
      * @access private
@@ -108,8 +107,7 @@ 
      *
      * @return void
      */
-    public function __construct(Document $record, array $highlighting, array $fields)
-    {
+    public function __construct(Document $record, array $highlighting, array $fields) {
         $this->id = $record[$fields['id']];
         $this->uid = $record[$fields['uid']];
         $this->page = $record[$fields['page']];

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

@@ -65,7 +65,7 @@
      * @access private
      * @var bool It's a toplevel element?
      */
-    private bool $toplevel = false;
+    private bool $toplevel = FALSE;
 
     /**
      * @access private

Classes/Common/Solr/Solr.php

Spacing +10 added lines, -10 removed lines

@@ -127,7 +127,7 @@ 
     {
         // Get next available core name if none given.
         if (empty($core)) {
-            $core = 'dlfCore' . self::getNextCoreNumber();
+            $core = 'dlfCore'.self::getNextCoreNumber();
         }
         // Get Solr service instance.
         $solr = self::getInstance($core);
@@ -217,13 +217,13 @@ 
                 ->execute();
 
             while ($resArray = $result->fetchAssociative()) {
-                $fields[] = $resArray['index_name'] . '_' . ($resArray['index_tokenized'] ? 't' : 'u') . ($resArray['index_stored'] ? 's' : 'u') . 'i';
+                $fields[] = $resArray['index_name'].'_'.($resArray['index_tokenized'] ? 't' : 'u').($resArray['index_stored'] ? 's' : 'u').'i';
             }
 
             // Check if queried field is valid.
             $splitQuery = explode(':', $query, 2);
             if (in_array($splitQuery[0], $fields)) {
-                $query = $splitQuery[0] . ':(' . self::escapeQuery(trim($splitQuery[1], '()')) . ')';
+                $query = $splitQuery[0].':('.self::escapeQuery(trim($splitQuery[1], '()')).')';
             } else {
                 $query = self::escapeQuery($query);
             }
@@ -330,7 +330,7 @@ 
     {
         $number = max($number, 0);
         // Check if core already exists.
-        $solr = self::getInstance('dlfCore' . $number);
+        $solr = self::getInstance('dlfCore'.$number);
         if (!$solr->ready) {
             return $number;
         } else {
@@ -388,7 +388,7 @@ 
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
         // Calculate cache identifier.
-        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), true));
+        $cacheIdentifier = Helper::digest($this->core.print_r(array_merge($this->params, $parameters), true));
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         $resultSet = [];
         $entry = $cache->get($cacheIdentifier);
@@ -520,12 +520,12 @@ 
      */
     public function __get(string $var)
     {
-        $method = 'magicGet' . ucfirst($var);
+        $method = 'magicGet'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return null;
         } else {
             return $this->$method();
@@ -558,12 +558,12 @@ 
      */
     public function __set(string $var, $value): void
     {
-        $method = 'magicSet' . ucfirst($var);
+        $method = 'magicSet'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }
@@ -603,7 +603,7 @@ 
                     'scheme' => $this->config['scheme'],
                     'host' => $this->config['host'],
                     'port' => $this->config['port'],
-                    'path' => '/' . $this->config['path'],
+                    'path' => '/'.$this->config['path'],
                     'core' => $core,
                     'username' => $this->config['username'],
                     'password' => $this->config['password']

Braces +3 added lines, -6 removed lines

@@ -42,8 +42,7 @@ 
  * @property-read bool $ready flag if the Solr service is instantiated successfully
  * @property-read Client $service this holds the Solr service object
  */
-class Solr implements LoggerAwareInterface
-{
+class Solr implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     /**
@@ -518,8 +517,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get(string $var)
-    {
+    public function __get(string $var) {
         $method = 'magicGet' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -578,8 +576,7 @@ 
      *
      * @return void
      */
-    protected function __construct(?string $core)
-    {
+    protected function __construct(?string $core) {
         // Solarium requires different code for version 5 and 6.
         $isSolarium5 = Client::checkExact('5');
         // Get Solr connection parameters from configuration.

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

@@ -56,7 +56,7 @@ 
      * @access protected
      * @var string|null This holds the core name
      */
-    protected ?string $core = null;
+    protected ?string $core = NULL;
 
     /**
      * @access protected
@@ -100,7 +100,7 @@ 
      * @access protected
      * @var bool Is the search instantiated successfully?
      */
-    protected bool $ready = false;
+    protected bool $ready = FALSE;
 
     /**
      * @access protected
@@ -285,7 +285,7 @@ 
      *
      * @return Solr Instance of this class
      */
-    public static function getInstance($core = null): Solr
+    public static function getInstance($core = NULL): Solr
     {
         // Get core name if UID is given.
         if (MathUtility::canBeInterpretedAsInteger($core)) {
@@ -294,7 +294,7 @@ 
         // Check if core is set or null.
         if (
             empty($core)
-            && $core !== null
+            && $core !== NULL
         ) {
             Helper::log('Invalid core UID or name given for Apache Solr', LOG_SEVERITY_ERROR);
         }
@@ -388,11 +388,11 @@ 
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
         // Calculate cache identifier.
-        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), true));
+        $cacheIdentifier = Helper::digest($this->core . print_r(array_merge($this->params, $parameters), TRUE));
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_solr');
         $resultSet = [];
         $entry = $cache->get($cacheIdentifier);
-        if ($entry === false) {
+        if ($entry === FALSE) {
             $selectQuery = $this->service->createSelect(array_merge($this->params, $parameters));
             $result = $this->service->select($selectQuery);
             foreach ($result as $doc) {
@@ -526,7 +526,7 @@ 
             || !method_exists($this, $method)
         ) {
             $this->logger->warning('There is no getter function for property "' . $var . '"');
-            return null;
+            return NULL;
         } else {
             return $this->$method();
         }
@@ -589,7 +589,7 @@ 
         $adapter->setTimeout($this->config['timeout']);
         // Configure event dispatcher.
         if ($isSolarium5) {
-            $eventDispatcher = null;
+            $eventDispatcher = NULL;
         } else {
             // When updating to TYPO3 >=10.x and Solarium >=6.x
             // we have to provide an PSR-14 Event Dispatcher instead of
@@ -623,7 +623,7 @@ 
         // Check if connection is established.
         $query = $this->service->createCoreAdmin();
         $action = $query->createStatus();
-        if ($core !== null) {
+        if ($core !== NULL) {
             $action->setCore($core);
         }
         $query->setAction($action);
@@ -631,7 +631,7 @@ 
             $response = $this->service->coreAdmin($query);
             if ($response->getWasSuccessful()) {
                 // Solr is reachable, but is the core as well?
-                if ($core !== null) {
+                if ($core !== NULL) {
                     $result = $response->getStatusResult();
                     if (
                         $result instanceof StatusResult
@@ -645,7 +645,7 @@ 
                     }
                 }
                 // Instantiation successful!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
         } catch (\Exception $e) {
             // Nothing to do here.

Classes/Common/Solr/SolrSearch.php

Indentation +2 added lines, -2 removed lines

@@ -525,8 +525,8 @@
                                 $searchResult['snippet'] = $doc['snippet'];
                                 $searchResult['highlight'] = $doc['highlight'];
                                 $searchResult['highlight_word'] = preg_replace('/^;|;$/', '',       // remove ; at beginning or end
-                                                                  preg_replace('/;+/', ';',         // replace any multiple of ; with a single ;
-                                                                  preg_replace('/[{~\d*}{\s+}{^=*\d+.*\d*}`~!@#$%\^&*()_|+-=?;:\'",.<>\{\}\[\]\\\]/', ';', $this->searchParams['query']))); // replace search operators and special characters with ;
+                                                                    preg_replace('/;+/', ';',         // replace any multiple of ; with a single ;
+                                                                    preg_replace('/[{~\d*}{\s+}{^=*\d+.*\d*}`~!@#$%\^&*()_|+-=?;:\'",.<>\{\}\[\]\\\]/', ';', $this->searchParams['query']))); // replace search operators and special characters with ;
                             }
                             $documents[$doc['uid']]['searchResults'][] = $searchResult;
                         }

Spacing +27 added lines, -27 removed lines

@@ -220,7 +220,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'],
@@ -231,7 +231,7 @@ 
             if (empty($document['title']) && $document['partOf'] > 0) {
                 $superiorTitle = AbstractDocument::getTitle($document['partOf'], true);
                 if (!empty($superiorTitle)) {
-                    $document['title'] = '[' . $superiorTitle . ']';
+                    $document['title'] = '['.$superiorTitle.']';
                 }
             }
         }
@@ -366,13 +366,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 {
@@ -395,9 +395,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]).')';
                     }
                 }
             }
@@ -406,7 +406,7 @@ 
         // Add filter query for date search
         if (!empty($this->searchParams['dateFrom']) && !empty($this->searchParams['dateTo'])) {
             // combine dateFrom and dateTo into range search
-            $params['filterquery'][]['query'] = '{!join from=' . $fields['uid'] . ' to=' . $fields['uid'] . '}'. $fields['date'] . ':[' . $this->searchParams['dateFrom'] . ' TO ' . $this->searchParams['dateTo'] . ']';
+            $params['filterquery'][]['query'] = '{!join from='.$fields['uid'].' to='.$fields['uid'].'}'.$fields['date'].':['.$this->searchParams['dateFrom'].' TO '.$this->searchParams['dateTo'].']';
         }
 
         // Add filter query for faceting.
@@ -423,12 +423,12 @@ 
         ) {
             // 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 collections are given, we prepare the collection query string
@@ -448,8 +448,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;
                 }
             }
@@ -524,8 +524,8 @@ 
                             if ($this->searchParams['fulltext'] == '1') {
                                 $searchResult['snippet'] = $doc['snippet'];
                                 $searchResult['highlight'] = $doc['highlight'];
-                                $searchResult['highlight_word'] = preg_replace('/^;|;$/', '',       // remove ; at beginning or end
-                                                                  preg_replace('/;+/', ';',         // replace any multiple of ; with a single ;
+                                $searchResult['highlight_word'] = preg_replace('/^;|;$/', '', // remove ; at beginning or end
+                                                                  preg_replace('/;+/', ';', // replace any multiple of ; with a single ;
                                                                   preg_replace('/[{~\d*}{\s+}{^=*\d+.*\d*}`~!@#$%\^&*()_|+-=?;:\'",.<>\{\}\[\]\\\]/', ';', $this->searchParams['query']))); // replace search operators and special characters with ;
                             }
                             $documents[$doc['uid']]['searchResults'][] = $searchResult;
@@ -549,7 +549,7 @@ 
                         
                                     // Fetch metadata for the current batch
                                     $metadataOf = $this->fetchToplevelMetadataFromSolr([
-                                        'query' => 'partof:' . $doc['uid'],
+                                        'query' => 'partof:'.$doc['uid'],
                                         'start' => $start,
                                         'rows' => min($batchSize, $totalChildren - $start),
                                     ]);
@@ -601,8 +601,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;
                 }
             }
@@ -653,7 +653,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 = [
@@ -742,24 +742,24 @@ 
         foreach ($this->collections as $collection) {
             // check for virtual collections query string
             if ($collection->getIndexSearch()) {
-                $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '(' . $collection->getIndexSearch() . ')' : ' OR (' . $collection->getIndexSearch() . ')';
+                $virtualCollectionsQueryString .= empty($virtualCollectionsQueryString) ? '('.$collection->getIndexSearch().')' : ' OR ('.$collection->getIndexSearch().')';
             } else {
-                $collectionsQueryString .= empty($collectionsQueryString) ? '"' . $collection->getIndexName() . '"' : ' OR "' . $collection->getIndexName() . '"';
+                $collectionsQueryString .= empty($collectionsQueryString) ? '"'.$collection->getIndexName().'"' : ' OR "'.$collection->getIndexName().'"';
             }
         }
 
         // distinguish between simple collection browsing and actual searching within the collection(s)
         if (!empty($collectionsQueryString)) {
             if (empty($query)) {
-                $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . ') AND toplevel:true AND partof:0)';
+                $collectionsQueryString = '(collection_faceting:('.$collectionsQueryString.') AND toplevel:true AND partof:0)';
             } else {
-                $collectionsQueryString = '(collection_faceting:(' . $collectionsQueryString . '))';
+                $collectionsQueryString = '(collection_faceting:('.$collectionsQueryString.'))';
             }
         }
 
         // virtual collections might query documents that are neither toplevel:true nor partof:0 and need to be searched separately
         if (!empty($virtualCollectionsQueryString)) {
-            $virtualCollectionsQueryString = '(' . $virtualCollectionsQueryString . ')';
+            $virtualCollectionsQueryString = '('.$virtualCollectionsQueryString.')';
         }
 
         // combine both query strings into a single filterquery via OR if both are given, otherwise pass either of those
@@ -837,7 +837,7 @@ 
     private function translateLanguageCode(&$doc): void
     {
         if ($doc['metadata']['language']) {
-            foreach($doc['metadata']['language'] as $indexName => $language) {
+            foreach ($doc['metadata']['language'] as $indexName => $language) {
                 $doc['metadata']['language'][$indexName] = Helper::getLanguageName($language);
             }
         }

Braces +11 added lines, -22 removed lines

@@ -90,8 +90,7 @@ 
      *
      * @return void
      */
-    public function __construct(DocumentRepository $documentRepository, $collections, array $settings, array $searchParams, QueryResult $listedMetadata = null)
-    {
+    public function __construct(DocumentRepository $documentRepository, $collections, array $settings, array $searchParams, QueryResult $listedMetadata = null) {
         $this->documentRepository = $documentRepository;
         $this->collections = $collections;
         $this->settings = $settings;
@@ -210,8 +209,7 @@ 
      * @return mixed
      */
     #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         $idx = $this->result['document_keys'][$offset];
         $document = $this->result['documents'][$idx] ?? null;
 
@@ -279,8 +277,7 @@ 
      *
      * @return mixed
      */
-    public function getSolrResults()
-    {
+    public function getSolrResults() {
         return $this->result['solrResults'];
     }
 
@@ -293,8 +290,7 @@ 
      *
      * @return mixed
      */
-    public function getByUid($uid)
-    {
+    public function getByUid($uid) {
         return $this->result['documents'][$uid];
     }
 
@@ -305,8 +301,7 @@ 
      *
      * @return SolrSearchQuery
      */
-    public function getQuery()
-    {
+    public function getQuery() {
         return new SolrSearchQuery($this);
     }
 
@@ -317,8 +312,7 @@ 
      *
      * @return SolrSearch
      */
-    public function getFirst()
-    {
+    public function getFirst() {
         return $this[0];
     }
 
@@ -329,8 +323,7 @@ 
      *
      * @return array
      */
-    public function toArray()
-    {
+    public function toArray() {
         return array_values($this->result['documents']);
     }
 
@@ -343,8 +336,7 @@ 
      *
      * @return int
      */
-    public function getNumFound()
-    {
+    public function getNumFound() {
         return $this->result['numFound'];
     }
 
@@ -355,8 +347,7 @@ 
      *
      * @return void
      */
-    public function prepare()
-    {
+    public function prepare() {
         // Prepare query parameters.
         $params = [];
         $matches = [];
@@ -472,8 +463,7 @@ 
      *
      * @return void
      */
-    public function submit($start, $rows, $processResults = true)
-    {
+    public function submit($start, $rows, $processResults = true) {
         $params = $this->params;
         $params['start'] = $start;
         $params['rows'] = $rows;
@@ -631,8 +621,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 +23 added lines, -23 removed lines

@@ -90,7 +90,7 @@ 
      *
      * @return void
      */
-    public function __construct(DocumentRepository $documentRepository, $collections, array $settings, array $searchParams, QueryResult $listedMetadata = null)
+    public function __construct(DocumentRepository $documentRepository, $collections, array $settings, array $searchParams, QueryResult $listedMetadata = NULL)
     {
         $this->documentRepository = $documentRepository;
         $this->collections = $collections;
@@ -120,7 +120,7 @@ 
      */
     public function count(): int
     {
-        if ($this->result === null) {
+        if ($this->result === NULL) {
             return 0;
         }
 
@@ -213,9 +213,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'])) {
@@ -229,7 +229,7 @@ 
 
             // get title of parent/grandparent/... if empty
             if (empty($document['title']) && $document['partOf'] > 0) {
-                $superiorTitle = AbstractDocument::getTitle($document['partOf'], true);
+                $superiorTitle = AbstractDocument::getTitle($document['partOf'], TRUE);
                 if (!empty($superiorTitle)) {
                     $document['title'] = '[' . $superiorTitle . ']';
                 }
@@ -374,7 +374,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'])) {
@@ -458,7 +458,7 @@ 
         $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);
     }
 
     /**
@@ -472,14 +472,14 @@ 
      *
      * @return void
      */
-    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 = [];
@@ -504,7 +504,7 @@ 
                 }
                 if ($documents[$doc['uid']]) {
                     $this->translateLanguageCode($doc);
-                    if ($doc['toplevel'] === false) {
+                    if ($doc['toplevel'] === FALSE) {
                         // this maybe a chapter, article, ..., year
                         if ($doc['type'] === 'year') {
                             continue;
@@ -530,7 +530,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];
@@ -545,7 +545,7 @@ 
                                 $totalChildren = count($children);
                         
                                 for ($start = 0; $start < $totalChildren; $start += $batchSize) {
-                                    $batch = array_slice($children, $start, $batchSize, true);
+                                    $batch = array_slice($children, $start, $batchSize, TRUE);
                         
                                     // Fetch metadata for the current batch
                                     $metadataOf = $this->fetchToplevelMetadataFromSolr([
@@ -611,7 +611,7 @@ 
         $params['filterquery'][] = ['query' => 'toplevel:true'];
 
         // Perform search.
-        $result = $this->searchSolr($params, true);
+        $result = $this->searchSolr($params, TRUE);
 
         foreach ($result['documents'] as $doc) {
             $this->translateLanguageCode($doc);
@@ -631,7 +631,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'] : '*';
@@ -650,10 +650,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 = [
@@ -661,22 +661,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
@@ -703,7 +703,7 @@ 
             $resultSet['numberOfToplevels'] = $uidGroup->getNumberOfGroups();
             $resultSet['numFound'] = $uidGroup->getMatches();
             $highlighting = [];
-            if ($parameters['fulltext'] === true) {
+            if ($parameters['fulltext'] === TRUE) {
                 $data = $result->getData();
                 $highlighting = $data['ocrHighlighting'];
             }
@@ -716,7 +716,7 @@ 
             }
 
             // Save value in cache.
-            if (!empty($resultSet['documents']) && $enableCache === true) {
+            if (!empty($resultSet['documents']) && $enableCache === TRUE) {
                 $cache->set($cacheIdentifier, $resultSet);
             }
         } else {

Classes/Common/Solr/SolrSearchQuery.php

Indentation +9 added lines, -9 removed lines

@@ -38,15 +38,15 @@
      */
     private int $offset;
 
-     /**
-     * Constructs SolrSearchQuery instance.
-     *
-     * @access public
-     *
-     * @param SolrSearch $solrSearch
-     *
-     * @return void
-     */
+        /**
+         * Constructs SolrSearchQuery instance.
+         *
+         * @access public
+         *
+         * @param SolrSearch $solrSearch
+         *
+         * @return void
+         */
     public function __construct($solrSearch)
     {
         $this->solrSearch = $solrSearch;

Braces +5 added lines, -8 removed lines

@@ -18,8 +18,7 @@ 
  * @property int $limit
  * @property int $offset
  */
-class SolrSearchQuery implements QueryInterface
-{
+class SolrSearchQuery implements QueryInterface {
     /**
      * @access private
      * @var SolrSearch
@@ -47,8 +46,7 @@ 
      *
      * @return void
      */
-    public function __construct($solrSearch)
-    {
+    public function __construct($solrSearch) {
         $this->solrSearch = $solrSearch;
 
         $this->offset = 0;
@@ -70,8 +68,7 @@ 
      */
     // TODO: Return type (array) of method SolrSearchQuery::execute() should be compatible with return type (iterable<object>&TYPO3\CMS\Extbase\Persistence\QueryResultInterface) of method TYPO3\CMS\Extbase\Persistence\QueryInterface::execute()
     // @phpstan-ignore-next-line
-    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)
@@ -146,8 +143,8 @@ 
     // @phpstan-ignore-next-line
     public function getQuerySettings() {}
 
-    public function count()
-    {// @phpstan-ignore-next-line
+    public function count() {
+// @phpstan-ignore-next-line
         // TODO?
     }
 

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

@@ -70,7 +70,7 @@ 
      */
     // TODO: Return type (array) of method SolrSearchQuery::execute() should be compatible with return type (iterable<object>&TYPO3\CMS\Extbase\Persistence\QueryResultInterface) of method TYPO3\CMS\Extbase\Persistence\QueryInterface::execute()
     // @phpstan-ignore-next-line
-    public function execute($returnRawQueryResult = false)
+    public function execute($returnRawQueryResult = FALSE)
     {
         $this->solrSearch->submit($this->offset, $this->limit);
 
@@ -125,7 +125,7 @@ 
     // @phpstan-ignore-next-line
     public function logicalNot(ConstraintInterface $constraint) {}
     // @phpstan-ignore-next-line
-    public function equals($propertyName, $operand, $caseSensitive = true) {}
+    public function equals($propertyName, $operand, $caseSensitive = TRUE) {}
     // @phpstan-ignore-next-line
     public function like($propertyName, $operand) {}
     // @phpstan-ignore-next-line

Classes/Common/FulltextInterface.php

Braces +1 added lines, -2 removed lines

@@ -22,8 +22,7 @@
  *
  * @abstract
  */
-interface FulltextInterface
-{
+interface FulltextInterface {
     /**
      * This extracts raw fulltext data from XML
      *

Classes/Common/StdOutStream.php

Braces +1 added lines, -2 removed lines

@@ -33,8 +33,7 @@
      * 
      * @return void
      */
-    public function emit()
-    {
+    public function emit() {
         // Disable output buffering
         ob_end_flush();
 

Classes/Common/MetsDocument.php

Spacing +30 added lines, -30 removed lines

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

Braces +5 added lines, -10 removed lines

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

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

@@ -100,7 +100,7 @@ 
      *
      * @see MetsDocument::$mdSec
      */
-    protected bool $mdSecLoaded = false;
+    protected bool $mdSecLoaded = FALSE;
 
     /**
      * @access protected
@@ -122,7 +122,7 @@ 
      *
      * @see $fileGrps
      */
-    protected bool $fileGrpsLoaded = false;
+    protected bool $fileGrpsLoaded = FALSE;
 
     /**
      * @access protected
@@ -198,7 +198,7 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($file['mimeType'] === 'application/vnd.netfpx') {
-            $baseURL = $file['location'] . (strpos($file['location'], '?') === false ? '?' : '');
+            $baseURL = $file['location'] . (strpos($file['location'], '?') === FALSE ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
             return $baseURL . '&CVT=jpeg';
         }
@@ -261,7 +261,7 @@ 
     /**
      * @see AbstractDocument::getLogicalStructure()
      */
-    public function getLogicalStructure(string $id, bool $recursive = false): array
+    public function getLogicalStructure(string $id, bool $recursive = FALSE): array
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -302,7 +302,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, bool $recursive = false): array
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, bool $recursive = FALSE): array
     {
         $attributes = $structure->attributes();
 
@@ -320,7 +320,7 @@ 
             'pagination' => '',
             'type' => isset($attributes['TYPE']) ? (string) $attributes['TYPE'] : '',
             'description' => '',
-            'thumbnailId' => null,
+            'thumbnailId' => NULL,
             'files' => [],
         ];
 
@@ -351,7 +351,7 @@ 
             && array_key_exists($details['id'], $this->smLinks['l2p'])
         ) {
             // Link logical structure to the first corresponding physical page/track.
-            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, true), 1);
+            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE), 1);
             $details['thumbnailId'] = $this->getThumbnail();
             // Get page/track number of the first page/track related to this structure element.
             $details['pagination'] = $this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['orderlabel'];
@@ -360,7 +360,7 @@ 
             $details['points'] = 1;
             $details['thumbnailId'] = $this->getThumbnail();
         }
-        if ($details['thumbnailId'] === null) {
+        if ($details['thumbnailId'] === NULL) {
             unset($details['thumbnailId']);
         }
         // Get the files this structure element is pointing at.
@@ -382,7 +382,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;
@@ -403,14 +403,14 @@ 
         $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
         $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
 
-        $thumbnail = null;
+        $thumbnail = NULL;
 
         while ($fileGrpThumb = array_shift($fileGrpsThumb)) {
             if (empty($id)) {
-                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? null;
+                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? NULL;
             } else {
-                $parentId = $this->smLinks['l2p'][$id][0] ?? null;
-                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? null;
+                $parentId = $this->smLinks['l2p'][$id][0] ?? NULL;
+                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? NULL;
             }
 
             if (!empty($thumbnail)) {
@@ -521,7 +521,7 @@ 
                 continue;
             }
 
-            $hasMetadataSection[$mdSectionType] = true;
+            $hasMetadataSection[$mdSectionType] = TRUE;
         }
 
         // Files are not expected to reference a dmdSec
@@ -571,13 +571,13 @@ 
     private function extractAndProcessMetadata(string $dmdId, string $mdSectionType, array &$metadata, int $cPid, array $hasMetadataSection): bool
     {
         if ($mdSectionType === 'dmdSec' && isset($hasMetadataSection['dmdSec'])) {
-            return true;
+            return TRUE;
         }
 
         $metadataExtracted = $this->extractMetadataIfTypeSupported($dmdId, $mdSectionType, $metadata);
 
         if (!$metadataExtracted) {
-            return false;
+            return FALSE;
         }
 
         $additionalMetadata = $this->getAdditionalMetadataFromDatabase($cPid, $dmdId);
@@ -588,7 +588,7 @@ 
 
         $this->processAdditionalMetadata($additionalMetadata, $domXPath, $domNode, $metadata);
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -737,7 +737,7 @@ 
                     $obj = GeneralUtility::makeInstance($class);
                     if ($obj instanceof MetadataInterface) {
                         $obj->extractMetadata($this->mdSec[$dmdId]['xml'], $metadata, GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey)['useExternalApisForMetadata']);
-                        return true;
+                        return TRUE;
                     }
                 } else {
                     $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
@@ -746,7 +746,7 @@ 
         } else {
             $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -946,16 +946,16 @@ 
     protected function loadLocation(string $location): bool
     {
         $fileResource = Helper::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $xml = Helper::getXmlFileAsString($fileResource);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -977,9 +977,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -1005,7 +1005,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;
                 }
@@ -1022,7 +1022,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'];
@@ -1035,7 +1035,7 @@ 
                 }
             }
 
-            $this->mdSecLoaded = true;
+            $this->mdSecLoaded = TRUE;
         }
         return $this->mdSec;
     }
@@ -1066,7 +1066,7 @@ 
     {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($element);
@@ -1084,7 +1084,7 @@ 
         }
 
         if (empty($xml)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($xml[0]);
@@ -1145,9 +1145,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;
     }
@@ -1240,7 +1240,7 @@ 
                 array_unshift($elements, $id);
                 $this->physicalStructure = $elements;
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -1258,7 +1258,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;
     }
@@ -1266,7 +1266,7 @@ 
     /**
      * @see AbstractDocument::magicGetThumbnail()
      */
-    protected function magicGetThumbnail(bool $forceReload = false): string
+    protected function magicGetThumbnail(bool $forceReload = FALSE): string
     {
         if (
             !$this->thumbnailLoaded
@@ -1276,14 +1276,14 @@ 
             $cPid = $this->cPid ?: $this->pid;
             if (!$cPid) {
                 $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             // Load extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             if (empty($extConf['fileGrpThumbs'])) {
                 $this->logger->warning('No fileGrp for thumbnails specified');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->magicGetToplevelId();
@@ -1337,7 +1337,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1415,8 +1415,8 @@ 
     public function __toString(): string
     {
         $xml = new \DOMDocument('1.0', 'utf-8');
-        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
-        $xml->formatOutput = true;
+        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), TRUE));
+        $xml->formatOutput = TRUE;
         return $xml->saveXML();
     }
 
@@ -1431,7 +1431,7 @@ 
     public function __wakeup(): void
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.