Erikmitk / kitodo-presentation

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;
                         }

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 +24 added lines, -24 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 (isset($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,23 +661,23 @@ 
             '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);
 
-            $fulltextExists = $parameters['fulltext'] ?? false;
-            if ($fulltextExists === true) {
+            $fulltextExists = $parameters['fulltext'] ?? FALSE;
+            if ($fulltextExists === TRUE) {
                 // get highlighting component and apply settings
                 $selectQuery->getHighlighting();
             }
 
             $solrRequest = $solr->service->createRequest($selectQuery);
 
-            if ($fulltextExists === true) {
+            if ($fulltextExists === 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
@@ -704,7 +704,7 @@ 
             $resultSet['numberOfToplevels'] = $uidGroup->getNumberOfGroups();
             $resultSet['numFound'] = $uidGroup->getMatches();
             $highlighting = [];
-            if ($fulltextExists === true) {
+            if ($fulltextExists === TRUE) {
                 $data = $result->getData();
                 $highlighting = $data['ocrHighlighting'];
             }
@@ -717,7 +717,7 @@ 
             }
 
             // Save value in cache.
-            if (!empty($resultSet['documents']) && $enableCache === true) {
+            if (!empty($resultSet['documents']) && $enableCache === TRUE) {
                 $cache->set($cacheIdentifier, $resultSet);
             }
         } else {

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 = [
@@ -743,24 +743,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
@@ -838,7 +838,7 @@ 
     private function translateLanguageCode(&$doc): void
     {
         if (array_key_exists('language', $doc['metadata'])) {
-            foreach($doc['metadata']['language'] as $indexName => $language) {
+            foreach ($doc['metadata']['language'] as $indexName => $language) {
                 $doc['metadata']['language'][$indexName] = Helper::getLanguageName($language);
             }
         }

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/MetadataInterface.php

Braces +1 added lines, -2 removed lines

@@ -22,8 +22,7 @@
  *
  * @abstract
  */
-interface MetadataInterface
-{
+interface MetadataInterface {
     /**
      * This extracts metadata from XML
      *

Classes/Common/Indexer.php

Braces +3 added lines, -6 removed lines

@@ -32,8 +32,7 @@ 
  *
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * @access public
      * @static
@@ -604,8 +603,7 @@ 
      *
      * @return array|string
      */
-    private static function removeAppendsFromAuthor($authors)
-    {
+    private static function removeAppendsFromAuthor($authors) {
         if (is_array($authors)) {
             foreach ($authors as $i => $author) {
                 $splitName = explode(pack('C', 31), $author);
@@ -685,7 +683,6 @@ 
      *
      * @return void
      */
-    private function __construct()
-    {
+    private function __construct() {
     }
 }

Spacing +15 added lines, -15 removed lines

@@ -114,7 +114,7 @@ 
                         $parent->setCurrentDocument($doc);
                         $success = self::add($parent, $documentRepository);
                     } else {
-                        Helper::log('Could not load parent document with UID ' . $document->getCurrentDocument()->parentId, LOG_SEVERITY_ERROR);
+                        Helper::log('Could not load parent document with UID '.$document->getCurrentDocument()->parentId, LOG_SEVERITY_ERROR);
                         return false;
                     }
                 }
@@ -197,19 +197,19 @@ 
             } catch (\Exception $e) {
                 if (!(Environment::isCli())) {
                     Helper::addMessage(
-                        Helper::getLanguageService()->getLL('flash.solrException') . ' ' . htmlspecialchars($e->getMessage()),
+                        Helper::getLanguageService()->getLL('flash.solrException').' '.htmlspecialchars($e->getMessage()),
                         Helper::getLanguageService()->getLL('flash.error'),
                         FlashMessage::ERROR,
                         true,
                         'core.template.flashMessages'
                     );
                 }
-                Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
+                Helper::log('Apache Solr threw exception: "'.$e->getMessage().'"', LOG_SEVERITY_ERROR);
                 return false;
             }
         }
 
-        Helper::log('Document not deleted from SOLR - problem with the connection to the SOLR core ' . $solrCoreUid, LOG_SEVERITY_ERROR);
+        Helper::log('Document not deleted from SOLR - problem with the connection to the SOLR core '.$solrCoreUid, LOG_SEVERITY_ERROR);
         return false;
     }
 
@@ -230,7 +230,7 @@ 
         // Sanitize input.
         $pid = max((int) $pid, 0);
         if (!$pid) {
-            Helper::log('Invalid PID ' . $pid . ' for metadata configuration', LOG_SEVERITY_ERROR);
+            Helper::log('Invalid PID '.$pid.' for metadata configuration', LOG_SEVERITY_ERROR);
             return '';
         }
         // Load metadata configuration.
@@ -239,7 +239,7 @@ 
         $suffix = (in_array($indexName, self::$fields['tokenized']) ? 't' : 'u');
         $suffix .= (in_array($indexName, self::$fields['stored']) ? 's' : 'u');
         $suffix .= (in_array($indexName, self::$fields['indexed']) ? 'i' : 'u');
-        $indexName .= '_' . $suffix;
+        $indexName .= '_'.$suffix;
         return $indexName;
     }
 
@@ -360,7 +360,7 @@ 
                 $solrDoc->setField('title', $metadata['title'][0], self::$fields['fieldboost']['title']);
                 $solrDoc->setField('volume', $metadata['volume'][0], self::$fields['fieldboost']['volume']);
                 // verify date formatting
-                if(strtotime($metadata['date'][0])) {
+                if (strtotime($metadata['date'][0])) {
                     $solrDoc->setField('date', self::getFormattedDate($metadata['date'][0]));
                 }
                 $solrDoc->setField('record_id', $metadata['record_id'][0]);
@@ -523,11 +523,11 @@ 
                 $solrDoc->setField(self::getIndexFieldName($indexName, $document->getPid()), $data, self::$fields['fieldboost'][$indexName]);
                 if (in_array($indexName, self::$fields['sortables'])) {
                     // Add sortable fields to index.
-                    $solrDoc->setField($indexName . '_sorting', $metadata[$indexName . '_sorting'][0]);
+                    $solrDoc->setField($indexName.'_sorting', $metadata[$indexName.'_sorting'][0]);
                 }
                 if (in_array($indexName, self::$fields['facets'])) {
                     // Add facets to index.
-                    $solrDoc->setField($indexName . '_faceting', $data);
+                    $solrDoc->setField($indexName.'_faceting', $data);
                 }
                 if (in_array($indexName, self::$fields['autocomplete'])) {
                     $autocomplete = array_merge($autocomplete, $data);
@@ -563,7 +563,7 @@ 
                         $data = self::removeAppendsFromAuthor($data);
                     }
                     // Add facets to index.
-                    $solrDoc->setField($indexName . '_faceting', $data);
+                    $solrDoc->setField($indexName.'_faceting', $data);
                 }
             }
             // Add sorting information to physical sub-elements if applicable.
@@ -593,9 +593,9 @@ 
         $update = self::$solr->service->createUpdate();
         $query = "";
         if ($field == 'uid' || $field == 'partof') {
-            $query = $field . ':' . $value;
+            $query = $field.':'.$value;
         } else {
-            $query = $field . ':"' . $value . '"';
+            $query = $field.':"'.$value.'"';
         }
         $update->addDeleteQuery($query);
         $update->addCommit();
@@ -620,7 +620,7 @@ 
     {
         $solrDoc = $updateQuery->createDocument();
         // Create unique identifier from document's UID and unit's XML ID.
-        $solrDoc->setField('id', $document->getUid() . $unit['id']);
+        $solrDoc->setField('id', $document->getUid().$unit['id']);
         $solrDoc->setField('uid', $document->getUid());
         $solrDoc->setField('pid', $document->getPid());
         $solrDoc->setField('partof', $document->getPartof());
@@ -699,9 +699,9 @@ 
     private static function handleException(string $errorMessage): void
     {
         if (!(Environment::isCli())) {
-            self::addErrorMessage(Helper::getLanguageService()->getLL('flash.solrException') . '<br />' . htmlspecialchars($errorMessage));
+            self::addErrorMessage(Helper::getLanguageService()->getLL('flash.solrException').'<br />'.htmlspecialchars($errorMessage));
         }
-        Helper::log('Apache Solr threw exception: "' . $errorMessage . '"', LOG_SEVERITY_ERROR);
+        Helper::log('Apache Solr threw exception: "'.$errorMessage.'"', LOG_SEVERITY_ERROR);
     }
 
     /**

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

@@ -67,7 +67,7 @@ 
      *
      * @see $fields
      */
-    protected static bool $fieldsLoaded = false;
+    protected static bool $fieldsLoaded = FALSE;
 
     /**
      * @access protected
@@ -98,9 +98,9 @@ 
     public static function add(Document $document, DocumentRepository $documentRepository): bool
     {
         if (in_array($document->getUid(), self::$processedDocs)) {
-            return true;
+            return TRUE;
         } elseif (self::solrConnect($document->getSolrcore(), $document->getPid())) {
-            $success = true;
+            $success = TRUE;
             Helper::getLanguageService()->includeLLFile('EXT:dlf/Resources/Private/Language/locallang_be.xlf');
             // Handle multi-volume documents.
             $parentId = $document->getPartof();
@@ -109,13 +109,13 @@ 
                 $parent = $documentRepository->findByUid($parentId);
                 if ($parent) {
                     // get XML document of parent
-                    $doc = AbstractDocument::getInstance($parent->getLocation(), ['storagePid' => $parent->getPid()], true);
-                    if ($doc !== null) {
+                    $doc = AbstractDocument::getInstance($parent->getLocation(), ['storagePid' => $parent->getPid()], TRUE);
+                    if ($doc !== NULL) {
                         $parent->setCurrentDocument($doc);
                         $success = self::add($parent, $documentRepository);
                     } else {
                         Helper::log('Could not load parent document with UID ' . $document->getCurrentDocument()->parentId, LOG_SEVERITY_ERROR);
-                        return false;
+                        return FALSE;
                     }
                 }
             }
@@ -162,7 +162,7 @@ 
                 return $success;
             } catch (\Exception $e) {
                 self::handleException($e->getMessage());
-                return false;
+                return FALSE;
             }
         } else {
             if (!(Environment::isCli())) {
@@ -173,7 +173,7 @@ 
                 );
             }
             Helper::log('Could not connect to Apache Solr server', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -193,24 +193,24 @@ 
         if (self::solrConnect($solrCoreUid, $input->getOption('pid'))) {
             try {
                 self::deleteDocument($field, $input->getOption('doc'));
-                return true;
+                return TRUE;
             } catch (\Exception $e) {
                 if (!(Environment::isCli())) {
                     Helper::addMessage(
                         Helper::getLanguageService()->getLL('flash.solrException') . ' ' . htmlspecialchars($e->getMessage()),
                         Helper::getLanguageService()->getLL('flash.error'),
                         FlashMessage::ERROR,
-                        true,
+                        TRUE,
                         'core.template.flashMessages'
                     );
                 }
                 Helper::log('Apache Solr threw exception: "' . $e->getMessage() . '"', LOG_SEVERITY_ERROR);
-                return false;
+                return FALSE;
             }
         }
 
         Helper::log('Document not deleted from SOLR - problem with the connection to the SOLR core ' . $solrCoreUid, LOG_SEVERITY_ERROR);
-        return false;
+        return FALSE;
     }
 
     /**
@@ -308,10 +308,10 @@ 
                 if ($indexing['index_boost'] > 0.0) {
                     self::$fields['fieldboost'][$indexing['index_name']] = floatval($indexing['index_boost']);
                 } else {
-                    self::$fields['fieldboost'][$indexing['index_name']] = false;
+                    self::$fields['fieldboost'][$indexing['index_name']] = FALSE;
                 }
             }
-            self::$fieldsLoaded = true;
+            self::$fieldsLoaded = TRUE;
         }
     }
 
@@ -329,7 +329,7 @@ 
      */
     protected static function processLogical(Document $document, array $logicalUnit): bool
     {
-        $success = true;
+        $success = TRUE;
         $doc = $document->getCurrentDocument();
         $doc->cPid = $document->getPid();
         // Get metadata for logical unit.
@@ -356,7 +356,7 @@ 
                     $solrDoc->setField('thumbnail', $doc->getFileLocation($logicalUnit['thumbnailId']));
                 }
                 // There can be only one toplevel unit per UID, independently of backend configuration
-                $solrDoc->setField('toplevel', $logicalUnit['id'] == $doc->toplevelId ? true : false);
+                $solrDoc->setField('toplevel', $logicalUnit['id'] == $doc->toplevelId ? TRUE : FALSE);
                 $solrDoc->setField('title', $metadata['title'][0], self::$fields['fieldboost']['title']);
                 $solrDoc->setField('volume', $metadata['volume'][0], self::$fields['fieldboost']['volume']);
                 // verify date formatting
@@ -392,11 +392,11 @@ 
                     self::$solr->service->update($updateQuery);
                 } catch (\Exception $e) {
                     self::handleException($e->getMessage());
-                    return false;
+                    return FALSE;
                 }
             } else {
                 Helper::log('Tip: If "record_id" field is missing then there is possibility that METS file still contains it but with the wrong source type attribute in "recordIdentifier" element', LOG_SEVERITY_NOTICE);
-                return false;
+                return FALSE;
             }
         }
         // Check for child elements...
@@ -444,7 +444,7 @@ 
                     break;
                 }
             }
-            $solrDoc->setField('toplevel', false);
+            $solrDoc->setField('toplevel', FALSE);
             $solrDoc->setField('type', $physicalUnit['type'], self::$fields['fieldboost']['type']);
             $solrDoc->setField('collection', $doc->metadataArray[$doc->toplevelId]['collection']);
             $solrDoc->setField('location', $document->getLocation());
@@ -465,10 +465,10 @@ 
                 self::$solr->service->update($updateQuery);
             } catch (\Exception $e) {
                 self::handleException($e->getMessage());
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -494,9 +494,9 @@ 
             if ($pid) {
                 self::loadIndexConf($pid);
             }
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -743,7 +743,7 @@ 
             $message,
             Helper::getLanguageService()->getLL($type),
             $status,
-            true,
+            TRUE,
             'core.template.flashMessages'
         );
     }

Classes/Common/AbstractDocument.php

Spacing +13 added lines, -13 removed lines

@@ -664,14 +664,14 @@ 
                     if ($fileContent !== false) {
                         $textFormat = $this->getTextFormat($fileContent);
                     } else {
-                        $this->logger->warning('Couldn\'t load full text file for structure node @ID "' . $id . '"');
+                        $this->logger->warning('Couldn\'t load full text file for structure node @ID "'.$id.'"');
                         return $fullText;
                     }
                     break;
                 }
             }
         } else {
-            $this->logger->warning('Invalid structure node @ID "' . $id . '"');
+            $this->logger->warning('Invalid structure node @ID "'.$id.'"');
             return $fullText;
         }
         // Is this text format supported?
@@ -683,7 +683,7 @@ 
             }
             $fullText = $textMiniOcr;
         } else {
-            $this->logger->warning('Unsupported text format "' . $textFormat . '" in physical node with @ID "' . $id . '"');
+            $this->logger->warning('Unsupported text format "'.$textFormat.'" in physical node with @ID "'.$id.'"');
         }
         return $fullText;
     }
@@ -712,10 +712,10 @@ 
                 $textMiniOcr = $obj->getTextAsMiniOcr($ocrTextXml);
                 $this->rawTextArray[$id] = $textMiniOcr;
             } else {
-                $this->logger->warning('Invalid class/method "' . $class . '->getRawText()" for text format "' . $textFormat . '"');
+                $this->logger->warning('Invalid class/method "'.$class.'->getRawText()" for text format "'.$textFormat.'"');
             }
         } else {
-            $this->logger->warning('Class "' . $class . ' does not exists for "' . $textFormat . ' text format"');
+            $this->logger->warning('Class "'.$class.' does not exists for "'.$textFormat.' text format"');
         }
         return $textMiniOcr;
     }
@@ -790,10 +790,10 @@ 
                     $title = self::getTitle($partof, true);
                 }
             } else {
-                Helper::log('No document with UID ' . $uid . ' found or document not accessible', LOG_SEVERITY_WARNING);
+                Helper::log('No document with UID '.$uid.' found or document not accessible', LOG_SEVERITY_WARNING);
             }
         } else {
-            Helper::log('Invalid UID ' . $uid . ' for document', LOG_SEVERITY_ERROR);
+            Helper::log('Invalid UID '.$uid.' for document', LOG_SEVERITY_ERROR);
         }
         return $title;
     }
@@ -883,7 +883,7 @@ 
             // the actual loading is format specific
             return $this->loadLocation($location);
         } else {
-            $this->logger->error('Invalid file location "' . $location . '" for document loading');
+            $this->logger->error('Invalid file location "'.$location.'" for document loading');
         }
         return false;
     }
@@ -1035,7 +1035,7 @@ 
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
-            $this->logger->error('Invalid PID ' . $cPid . ' for metadata definitions');
+            $this->logger->error('Invalid PID '.$cPid.' for metadata definitions');
             return [];
         }
         if (
@@ -1212,12 +1212,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();
@@ -1250,12 +1250,12 @@ 
      */
     public function __set(string $var, $value): void
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }

Braces +7 added lines, -14 removed lines

@@ -57,8 +57,7 @@ 
  * @property-read string $toplevelId this holds the toplevel structure's "@ID" (METS) or the manifest's "@id" (IIIF)
  * @property \SimpleXMLElement $xml this holds the whole XML file as \SimpleXMLElement object
  */
-abstract class AbstractDocument
-{
+abstract class AbstractDocument {
     /**
      * @access protected
      * @var Logger This holds the logger
@@ -838,8 +837,7 @@ 
      * @return int|bool false if structure with $logId is not a child of this substructure,
      * or the actual depth.
      */
-    protected function getTreeDepth(array $structure, int $depth, string $logId)
-    {
+    protected function getTreeDepth(array $structure, int $depth, string $logId) {
         foreach ($structure as $element) {
             if ($element['id'] == $logId) {
                 return $depth;
@@ -862,8 +860,7 @@ 
      *
      * @return int|bool tree depth as integer or false if no element with $logId exists within the TOC.
      */
-    public function getStructureDepth(string $logId)
-    {
+    public function getStructureDepth(string $logId) {
         return $this->getTreeDepth($this->magicGetTableOfContents(), 1, $logId);
     }
 
@@ -1122,8 +1119,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function magicGetRecordId()
-    {
+    protected function magicGetRecordId() {
         return $this->recordId;
     }
 
@@ -1193,8 +1189,7 @@ 
      *
      * @return void
      */
-    protected function __construct(int $pid, string $location, $preloadedDocument, array $settings = [])
-    {
+    protected function __construct(int $pid, string $location, $preloadedDocument, array $settings = []) {
         $this->pid = $pid;
         $this->setPreloadedDocument($preloadedDocument);
         $this->init($location, $settings);
@@ -1210,8 +1205,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)
@@ -1272,8 +1266,7 @@ 
      *
      * @return AbstractDocument|false
      */
-    private static function getDocumentCache(string $location)
-    {
+    private static function getDocumentCache(string $location) {
         $cacheIdentifier = hash('md5', $location);
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_doc');
         $cacheHit = $cache->get($cacheIdentifier);

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

@@ -111,7 +111,7 @@ 
      *
      * @see $formats
      */
-    protected bool $formatsLoaded = false;
+    protected bool $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -121,13 +121,13 @@ 
      * @access protected
      * @var bool
      */
-    protected bool $hasFulltext = false;
+    protected bool $hasFulltext = FALSE;
 
     /**
      * @access protected
      * @var array Last searched logical and physical page
      */
-    protected array $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected array $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * @access protected
@@ -150,7 +150,7 @@ 
      *
      * @see $metadataArray
      */
-    protected bool $metadataArrayLoaded = false;
+    protected bool $metadataArrayLoaded = FALSE;
 
     /**
      * @access protected
@@ -182,7 +182,7 @@ 
      *
      * @see $physicalStructure
      */
-    protected bool $physicalStructureLoaded = false;
+    protected bool $physicalStructureLoaded = FALSE;
 
     /**
      * @access protected
@@ -203,7 +203,7 @@ 
      * @access protected
      * @var bool Is the document instantiated successfully?
      */
-    protected bool $ready = false;
+    protected bool $ready = FALSE;
 
     /**
      * @access protected
@@ -223,7 +223,7 @@ 
      *
      * @see $rootId
      */
-    protected bool $rootIdLoaded = false;
+    protected bool $rootIdLoaded = FALSE;
 
     /**
      * @access protected
@@ -237,7 +237,7 @@ 
      *
      * @see $smLinks
      */
-    protected bool $smLinksLoaded = false;
+    protected bool $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -253,7 +253,7 @@ 
      *
      * @see $tableOfContents
      */
-    protected bool $tableOfContentsLoaded = false;
+    protected bool $tableOfContentsLoaded = FALSE;
 
     /**
      * @access protected
@@ -267,7 +267,7 @@ 
      *
      * @see $thumbnail
      */
-    protected bool $thumbnailLoaded = false;
+    protected bool $thumbnailLoaded = FALSE;
 
     /**
      * @access protected
@@ -361,7 +361,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    abstract public function getLogicalStructure(string $id, bool $recursive = false): array;
+    abstract public function getLogicalStructure(string $id, bool $recursive = FALSE): array;
 
     /**
      * This extracts all the metadata for a logical structure node
@@ -449,7 +449,7 @@ 
      *
      * @return string The document's thumbnail location
      */
-    abstract protected function magicGetThumbnail(bool $forceReload = false): string;
+    abstract protected function magicGetThumbnail(bool $forceReload = FALSE): string;
 
     /**
      * This returns the ID of the toplevel logical structure node
@@ -528,21 +528,21 @@ 
      *
      * @return AbstractDocument|null Instance of this class, either MetsDocument or IiifManifest
      */
-    public static function &getInstance(string $location, array $settings = [], bool $forceReload = false)
+    public static function &getInstance(string $location, array $settings = [], bool $forceReload = FALSE)
     {
         // Create new instance depending on format (METS or IIIF) ...
-        $documentFormat = null;
-        $xml = null;
-        $iiif = null;
+        $documentFormat = NULL;
+        $xml = NULL;
+        $iiif = NULL;
 
         if (!$forceReload) {
             $instance = self::getDocumentCache($location);
-            if ($instance !== false) {
+            if ($instance !== FALSE) {
                 return $instance;
             }
         }
 
-        $instance = null;
+        $instance = NULL;
 
         // Try to load a file from the url
         if (GeneralUtility::isValidUrl($location)) {
@@ -550,17 +550,17 @@ 
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
 
             $content = Helper::getUrl($location);
-            if ($content !== false) {
+            if ($content !== FALSE) {
                 $xml = Helper::getXmlFileAsString($content);
-                if ($xml !== false) {
+                if ($xml !== FALSE) {
                     /* @var $xml \SimpleXMLElement */
                     $xml->registerXPathNamespace('mets', 'http://www.loc.gov/METS/');
                     $xpathResult = $xml->xpath('//mets:mets');
-                    $documentFormat = !empty($xpathResult) ? 'METS' : null;
+                    $documentFormat = !empty($xpathResult) ? 'METS' : NULL;
                 } else {
                     // Try to load file as IIIF resource instead.
-                    $contentAsJsonArray = json_decode($content, true);
-                    if ($contentAsJsonArray !== null) {
+                    $contentAsJsonArray = json_decode($content, TRUE);
+                    if ($contentAsJsonArray !== NULL) {
                         IiifHelper::setUrlReader(IiifUrlReader::getInstance());
                         IiifHelper::setMaxThumbnailHeight($extConf['iiif']['thumbnailHeight']);
                         IiifHelper::setMaxThumbnailWidth($extConf['iiif']['thumbnailWidth']);
@@ -583,7 +583,7 @@ 
             $instance = new IiifManifest($pid, $location, $iiif);
         }
 
-        if ($instance !== null) {
+        if ($instance !== NULL) {
             self::setDocumentCache($location, $instance);
         }
 
@@ -624,7 +624,7 @@ 
         } else {
             $physicalPage = 0;
             foreach ($this->physicalStructureInfo as $page) {
-                if (strpos($page['orderlabel'], $logicalPage) !== false) {
+                if (strpos($page['orderlabel'], $logicalPage) !== FALSE) {
                     $this->lastSearchedPhysicalPage['logicalPage'] = $logicalPage;
                     $this->lastSearchedPhysicalPage['physicalPage'] = $physicalPage;
                     return $physicalPage;
@@ -661,7 +661,7 @@ 
                 if (!empty($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext])) {
                     // Get full text file.
                     $fileContent = GeneralUtility::getUrl($this->getFileLocation($this->physicalStructureInfo[$id]['files'][$fileGrpFulltext]));
-                    if ($fileContent !== false) {
+                    if ($fileContent !== FALSE) {
                         $textFormat = $this->getTextFormat($fileContent);
                     } else {
                         $this->logger->warning('Couldn\'t load full text file for structure node @ID "' . $id . '"');
@@ -733,7 +733,7 @@ 
     {
         $xml = Helper::getXmlFileAsString($fileContent);
 
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             // Get the root element's name as text format.
             return strtoupper($xml->getName());
         } else {
@@ -753,7 +753,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle(int $uid, bool $recursive = false): string
+    public static function getTitle(int $uid, bool $recursive = FALSE): string
     {
         $title = '';
         // Sanitize input.
@@ -787,7 +787,7 @@ 
                     && (int) $partof
                     && $partof != $uid
                 ) {
-                    $title = self::getTitle($partof, true);
+                    $title = self::getTitle($partof, TRUE);
                 }
             } else {
                 Helper::log('No document with UID ' . $uid . ' found or document not accessible', LOG_SEVERITY_WARNING);
@@ -845,12 +845,12 @@ 
                 return $depth;
             } elseif (array_key_exists('children', $element)) {
                 $foundInChildren = $this->getTreeDepth($element['children'], $depth + 1, $logId);
-                if ($foundInChildren !== false) {
+                if ($foundInChildren !== FALSE) {
                     return $foundInChildren;
                 }
             }
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -885,7 +885,7 @@ 
         } else {
             $this->logger->error('Invalid file location "' . $location . '" for document loading');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -923,7 +923,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -1044,7 +1044,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1143,7 +1143,7 @@ 
                 $parent = self::getInstance($this->parentId, ['storagePid' => $this->pid]);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1160,8 +1160,8 @@ 
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
-            $this->getLogicalStructure('', true);
-            $this->tableOfContentsLoaded = true;
+            $this->getLogicalStructure('', TRUE);
+            $this->tableOfContentsLoaded = TRUE;
         }
         return $this->tableOfContents;
     }
@@ -1218,7 +1218,7 @@ 
             || !method_exists($this, $method)
         ) {
             $this->logger->warning('There is no getter function for property "' . $var . '"');
-            return null;
+            return NULL;
         } else {
             return $this->$method();
         }