Erikmitk / kitodo-presentation

Classes/Domain/Model/Document.php

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

@@ -40,7 +40,7 @@ 
      *
      * @var \Kitodo\Dlf\Common\Doc|null
      */
-    protected $doc = null;
+    protected $doc = NULL;
 
     /**
      * @var string
@@ -156,7 +156,7 @@ 
      * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\Kitodo\Dlf\Domain\Model\Collection>
      * @Extbase\ORM\Lazy
      */
-    protected $collections = null;
+    protected $collections = NULL;
 
     /**
      * @var string

Braces +4 added lines, -8 removed lines

@@ -192,14 +192,12 @@ 
     /**
      * constructor
      */
-    public function __construct()
-    {
+    public function __construct() {
         // Do not remove the next line: It would break the functionality
         $this->initStorageObjects();
     }
 
-    protected function initStorageObjects()
-    {
+    protected function initStorageObjects() {
         $this->collections = new ObjectStorage();
     }
 
@@ -577,8 +575,7 @@ 
      *
      * @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\Kitodo\Dlf\Domain\Model\Collection> $collections
      */
-    public function getCollections()
-    {
+    public function getCollections() {
         return $this->collections;
     }
 
@@ -607,8 +604,7 @@ 
      *
      * @return \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\Kitodo\Dlf\Domain\Model\Collection> collections
      */
-    public function removeCollection(Collection $collection)
-    {
+    public function removeCollection(Collection $collection) {
         $this->collections->detach($collection);
     }
 

Classes/Domain/Model/Collection.php

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

@@ -61,7 +61,7 @@
      *
      * @var \TYPO3\CMS\Extbase\Domain\Model\FileReference
      */
-    protected $thumbnail = null;
+    protected $thumbnail = NULL;
 
     /**
      * @var int

Classes/Domain/Repository/MetadataRepository.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 
         // order by oai_name
         $query->setOrderings(
-            array('sorting' => QueryInterface::ORDER_ASCENDING)
+            array ('sorting' => QueryInterface::ORDER_ASCENDING)
         );
 
         return $query->execute();

Braces +1 added lines, -2 removed lines

@@ -25,8 +25,7 @@
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findBySettings($settings = [])
-    {
+    public function findBySettings($settings = []) {
         $query = $this->createQuery();
 
         $constraints = [];

Classes/Domain/Repository/CollectionRepository.php

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 
         // order by oai_name
         $query->setOrderings(
-            array('oai_name' => QueryInterface::ORDER_ASCENDING)
+            array ('oai_name' => QueryInterface::ORDER_ASCENDING)
         );
 
         return $query->execute();

Braces +4 added lines, -8 removed lines

@@ -35,8 +35,7 @@ 
      *
      * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findAllByUids($uids)
-    {
+    public function findAllByUids($uids) {
         $query = $this->createQuery();
 
         $constraints = [];
@@ -49,8 +48,7 @@ 
         return $query->execute();
     }
 
-    public function getCollectionForMetadata($pages)
-    {
+    public function getCollectionForMetadata($pages) {
         // Get list of collections to show.
         $query = $this->createQuery();
 
@@ -66,8 +64,7 @@ 
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findCollectionsBySettings($settings = [])
-    {
+    public function findCollectionsBySettings($settings = []) {
         $query = $this->createQuery();
 
         $constraints = [];
@@ -104,8 +101,7 @@ 
         return $query->execute();
     }
 
-    public function getIndexNameForSolr($settings, $set)
-    {
+    public function getIndexNameForSolr($settings, $set) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_collections');
 

Classes/ExpressionLanguage/DocumentTypeFunctionProvider.php

Spacing +4 added lines, -4 removed lines

@@ -157,7 +157,7 @@ 
                 if ($this->document) {
                     $doc = Doc::getInstance($this->document->getLocation(), ['storagePid' => $pid], true);
                 } else {
-                    $this->logger->error('Invalid UID "' . $requestData['id'] . '" or PID "' . $pid . '" for document loading');
+                    $this->logger->error('Invalid UID "'.$requestData['id'].'" or PID "'.$pid.'" for document loading');
                 }
             } else if (GeneralUtility::isValidUrl($requestData['id'])) {
 
@@ -175,7 +175,7 @@ 
 
                     $this->document->setLocation($requestData['id']);
                 } else {
-                    $this->logger->error('Invalid location given "' . $requestData['id'] . '" for document loading');
+                    $this->logger->error('Invalid location given "'.$requestData['id'].'" for document loading');
                 }
             }
 
@@ -192,11 +192,11 @@ 
                 if ($this->document !== null && $doc !== null) {
                     $this->document->setDoc($doc);
                 } else {
-                    $this->logger->error('Failed to load document with record ID "' . $requestData['recordId'] . '"');
+                    $this->logger->error('Failed to load document with record ID "'.$requestData['recordId'].'"');
                 }
             }
         } else {
-            $this->logger->error('Invalid UID "' . $requestData['id'] . '" or PID "' . $pid . '" for document loading');
+            $this->logger->error('Invalid UID "'.$requestData['id'].'" or PID "'.$pid.'" for document loading');
         }
     }
 }

Braces +5 added lines, -10 removed lines

@@ -41,8 +41,7 @@ 
     /**
      * @return ExpressionFunction[] An array of Function instances
      */
-    public function getFunctions()
-    {
+    public function getFunctions() {
         return [
             $this->getDocumentTypeFunction(),
         ];
@@ -68,8 +67,7 @@ 
      *
      * @return void
      */
-    protected function initializeRepositories($storagePid)
-    {
+    protected function initializeRepositories($storagePid) {
         Helper::polyfillExtbaseClassesForTYPO3v9();
 
         // TODO: When we drop support for TYPO3v9, we needn't/shouldn't use ObjectManager anymore
@@ -92,12 +90,10 @@ 
     {
         return new ExpressionFunction(
             'getDocumentType',
-            function()
-            {
+            function() {
                 // Not implemented, we only use the evaluator
             },
-            function($arguments, $cPid)
-            {
+            function($arguments, $cPid) {
                 /** @var RequestWrapper $requestWrapper */
                 $requestWrapper = $arguments['request'];
                 $queryParams = $requestWrapper->getQueryParams();
@@ -143,8 +139,7 @@ 
      *
      * @return void
      */
-    protected function loadDocument($requestData, int $pid)
-    {
+    protected function loadDocument($requestData, int $pid) {
         // Try to get document format from database
         if (!empty($requestData['id'])) {
 

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

@@ -112,7 +112,7 @@ 
 
                 // Load document with current plugin parameters.
                 $this->loadDocument($queryParams['tx_dlf'], $cPid);
-                if ($this->document === null) {
+                if ($this->document === NULL) {
                     return $type;
                 }
                 // Set PID for metadata definitions.
@@ -123,7 +123,7 @@ 
                     // Calendar plugin does not support IIIF (yet). Abort for all newspaper related types.
                     if (
                         $this->document->getDoc() instanceof IiifManifest
-                        && array_search($metadata['type'][0], ['newspaper', 'ephemera', 'year', 'issue']) !== false
+                        && array_search($metadata['type'][0], ['newspaper', 'ephemera', 'year', 'issue']) !== FALSE
                     ) {
                         return $type;
                     }
@@ -150,25 +150,25 @@ 
 
             $this->initializeRepositories($pid);
 
-            $doc = null;
+            $doc = NULL;
             if (MathUtility::canBeInterpretedAsInteger($requestData['id'])) {
                 // find document from repository by uid
                 $this->document = $this->documentRepository->findOneByIdAndSettings((int) $requestData['id'], ['storagePid' => $pid]);
                 if ($this->document) {
-                    $doc = Doc::getInstance($this->document->getLocation(), ['storagePid' => $pid], true);
+                    $doc = Doc::getInstance($this->document->getLocation(), ['storagePid' => $pid], TRUE);
                 } else {
                     $this->logger->error('Invalid UID "' . $requestData['id'] . '" or PID "' . $pid . '" for document loading');
                 }
             } else if (GeneralUtility::isValidUrl($requestData['id'])) {
 
-                $doc = Doc::getInstance($requestData['id'], ['storagePid' => $pid], true);
+                $doc = Doc::getInstance($requestData['id'], ['storagePid' => $pid], TRUE);
 
-                if ($doc !== null) {
+                if ($doc !== NULL) {
                     if ($doc->recordId) {
                         $this->document = $this->documentRepository->findOneByRecordId($doc->recordId);
                     }
 
-                    if ($this->document === null) {
+                    if ($this->document === NULL) {
                         // create new dummy Document object
                         $this->document = GeneralUtility::makeInstance(Document::class);
                     }
@@ -179,7 +179,7 @@ 
                 }
             }
 
-            if ($this->document !== null && $doc !== null) {
+            if ($this->document !== NULL && $doc !== NULL) {
                 $this->document->setDoc($doc);
             }
 
@@ -187,9 +187,9 @@ 
 
             $this->document = $this->documentRepository->findOneByRecordId($requestData['recordId']);
 
-            if ($this->document !== null) {
-                $doc = Doc::getInstance($this->document->getLocation(), ['storagePid' => $pid], true);
-                if ($this->document !== null && $doc !== null) {
+            if ($this->document !== NULL) {
+                $doc = Doc::getInstance($this->document->getLocation(), ['storagePid' => $pid], TRUE);
+                if ($this->document !== NULL && $doc !== NULL) {
                     $this->document->setDoc($doc);
                 } else {
                     $this->logger->error('Failed to load document with record ID "' . $requestData['recordId'] . '"');

Classes/Common/Solr.php

Spacing +10 added lines, -10 removed lines

@@ -134,7 +134,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);
@@ -230,13 +230,13 @@ 
                 ->execute();
 
             while ($resArray = $result->fetch()) {
-                $fields[] = $resArray['index_name'] . '_' . ($resArray['index_tokenized'] ? 't' : 'u') . ($resArray['index_stored'] ? 's' : 'u') . 'i';
+                $fields[] = $resArray['index_name'].'_'.($resArray['index_tokenized'] ? 't' : 'u').($resArray['index_stored'] ? 's' : 'u').'i';
             }
 
             // Check if queried field is valid.
             $splitQuery = explode(':', $query, 2);
             if (in_array($splitQuery[0], $fields)) {
-                $query = $splitQuery[0] . ':(' . self::escapeQuery(trim($splitQuery[1], '()')) . ')';
+                $query = $splitQuery[0].':('.self::escapeQuery(trim($splitQuery[1], '()')).')';
             } else {
                 $query = self::escapeQuery($query);
             }
@@ -341,7 +341,7 @@ 
     {
         $number = max(intval($number), 0);
         // Check if core already exists.
-        $solr = self::getInstance('dlfCore' . $number);
+        $solr = self::getInstance('dlfCore'.$number);
         if (!$solr->ready) {
             return $number;
         } else {
@@ -403,7 +403,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 = [];
         if (($entry = $cache->get($cacheIdentifier)) === false) {
@@ -534,12 +534,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -572,12 +572,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }
@@ -614,7 +614,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 +21 added lines, -42 removed lines

@@ -37,8 +37,7 @@ 
  * @property-read bool $ready Is the Solr service instantiated successfully?
  * @property-read \Solarium\Client $service This holds the Solr service object
  */
-class Solr implements LoggerAwareInterface
-{
+class Solr implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     /**
@@ -130,8 +129,7 @@ 
      *
      * @return string The name of the new core
      */
-    public static function createCore($core = '')
-    {
+    public static function createCore($core = '') {
         // Get next available core name if none given.
         if (empty($core)) {
             $core = 'dlfCore' . self::getNextCoreNumber();
@@ -178,8 +176,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQuery($query)
-    {
+    public static function escapeQuery($query) {
         $helper = GeneralUtility::makeInstance(\Solarium\Core\Query\Helper::class);
         // Escape query phrase or term.
         if (preg_match('/^".*"$/', $query)) {
@@ -202,8 +199,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQueryKeepField($query, $pid)
-    {
+    public static function escapeQueryKeepField($query, $pid) {
         // Is there a field query?
         if (preg_match('/^[[:alnum:]]+_[tu][su]i:\(?.*\)?$/', $query)) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -253,8 +249,7 @@ 
      *
      * @return array fields
      */
-    public static function getFields()
-    {
+    public static function getFields() {
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
 
         $fields = [];
@@ -296,8 +291,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Solr Instance of this class
      */
-    public static function getInstance($core = null)
-    {
+    public static function getInstance($core = null) {
         // Get core name if UID is given.
         if (MathUtility::canBeInterpretedAsInteger($core)) {
             $core = Helper::getIndexNameFromUid($core, 'tx_dlf_solrcores');
@@ -337,8 +331,7 @@ 
      *
      * @return int First unused core number found
      */
-    public static function getNextCoreNumber($number = 0)
-    {
+    public static function getNextCoreNumber($number = 0) {
         $number = max(intval($number), 0);
         // Check if core already exists.
         $solr = self::getInstance('dlfCore' . $number);
@@ -356,8 +349,7 @@ 
      *
      * @return void
      */
-    protected function loadSolrConnectionInfo()
-    {
+    protected function loadSolrConnectionInfo() {
         if (empty($this->config)) {
             $config = [];
             // Extract extension configuration.
@@ -397,8 +389,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    public function search_raw($parameters = [])
-    {
+    public function search_raw($parameters = []) {
         // Set additional query parameters.
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
@@ -428,8 +419,7 @@ 
      *
      * @return string|null The core name of the current query endpoint or null if core admin endpoint
      */
-    protected function _getCore()
-    {
+    protected function _getCore() {
         return $this->core;
     }
 
@@ -440,8 +430,7 @@ 
      *
      * @return int The max number of results
      */
-    protected function _getLimit()
-    {
+    protected function _getLimit() {
         return $this->limit;
     }
 
@@ -452,8 +441,7 @@ 
      *
      * @return int Total number of hits for last search
      */
-    protected function _getNumberOfHits()
-    {
+    protected function _getNumberOfHits() {
         return $this->numberOfHits;
     }
 
@@ -464,8 +452,7 @@ 
      *
      * @return bool Is the search instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -476,8 +463,7 @@ 
      *
      * @return \Solarium\Client Apache Solr service object
      */
-    protected function _getService()
-    {
+    protected function _getService() {
         return $this->service;
     }
 
@@ -490,8 +476,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -504,8 +489,7 @@ 
      *
      * @return void
      */
-    protected function _setLimit($value)
-    {
+    protected function _setLimit($value) {
         $this->limit = max(intval($value), 0);
     }
 
@@ -518,8 +502,7 @@ 
      *
      * @return void
      */
-    protected function _setParams(array $value)
-    {
+    protected function _setParams(array $value) {
         $this->params = $value;
     }
 
@@ -532,8 +515,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -555,8 +537,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -570,8 +551,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -592,8 +572,7 @@ 
      *
      * @return void
      */
-    protected function __construct($core)
-    {
+    protected function __construct($core) {
         // Get Solr connection parameters from configuration.
         $this->loadSolrConnectionInfo();
         // Configure connection adapter.

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

@@ -55,7 +55,7 @@ 
      * @var string|null
      * @access protected
      */
-    protected $core = null;
+    protected $core = NULL;
 
     /**
      * This holds the PID for the configuration
@@ -103,7 +103,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * This holds the singleton search objects with their core as array key
@@ -296,7 +296,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Solr Instance of this class
      */
-    public static function getInstance($core = null)
+    public static function getInstance($core = NULL)
     {
         // Get core name if UID is given.
         if (MathUtility::canBeInterpretedAsInteger($core)) {
@@ -305,7 +305,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);
         }
@@ -403,10 +403,10 @@ 
         $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 = [];
-        if (($entry = $cache->get($cacheIdentifier)) === false) {
+        if (($entry = $cache->get($cacheIdentifier)) === FALSE) {
             $selectQuery = $this->service->createSelect(array_merge($this->params, $parameters));
             $result = $this->service->select($selectQuery);
             foreach ($result as $doc) {
@@ -632,7 +632,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);
@@ -640,7 +640,7 @@ 
             $response = $this->service->coreAdmin($query);
             if ($response->getWasSuccessful()) {
                 // Solr is reachable, but is the core as well?
-                if ($core !== null) {
+                if ($core !== NULL) {
                     $result = $response->getStatusResult();
                     if (
                         $result instanceof \Solarium\QueryType\Server\CoreAdmin\Result\StatusResult
@@ -654,7 +654,7 @@ 
                     }
                 }
                 // Instantiation successful!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
         } catch (\Exception $e) {
             // Nothing to do here.

Classes/Common/SolrSearchResult/ResultDocument.php

Braces +19 added lines, -38 removed lines

@@ -24,8 +24,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class ResultDocument
-{
+class ResultDocument {
 
     /**
      * The identifier
@@ -134,8 +133,7 @@ 
      *
      * @return void
      */
-    public function __construct($record, $highlighting, $fields)
-    {
+    public function __construct($record, $highlighting, $fields) {
         $this->id = $record[$fields['id']];
         $this->uid = $record[$fields['uid']];
         $this->page = $record[$fields['page']];
@@ -160,8 +158,7 @@ 
      *
      * @return string The result's record identifier
      */
-    public function getId()
-    {
+    public function getId() {
         return $this->id;
     }
 
@@ -172,8 +169,7 @@ 
      *
      * @return string|null The result's record unified identifier
      */
-    public function getUid()
-    {
+    public function getUid() {
         return $this->uid;
     }
 
@@ -184,8 +180,7 @@ 
      *
      * @return int The result's record page
      */
-    public function getPage()
-    {
+    public function getPage() {
         return $this->page;
     }
 
@@ -196,8 +191,7 @@ 
      *
      * @return string All result's record snippets imploded to one string
      */
-    public function getSnippets()
-    {
+    public function getSnippets() {
         return $this->snippets;
     }
 
@@ -208,8 +202,7 @@ 
      *
      * @return string
      */
-    public function getThumbnail()
-    {
+    public function getThumbnail() {
         return $this->thumbnail;
     }
 
@@ -220,8 +213,7 @@ 
      *
      * @return string
      */
-    public function getTitle()
-    {
+    public function getTitle() {
         return $this->title;
     }
 
@@ -232,8 +224,7 @@ 
      *
      * @return boolean
      */
-    public function getToplevel()
-    {
+    public function getToplevel() {
         return $this->toplevel;
     }
 
@@ -244,8 +235,7 @@ 
      *
      * @return string
      */
-    public function getType()
-    {
+    public function getType() {
         return $this->type;
     }
 
@@ -256,8 +246,7 @@ 
      *
      * @return array(Page) All result's pages which contain search phrase
      */
-    public function getPages()
-    {
+    public function getPages() {
         return $this->pages;
     }
 
@@ -268,8 +257,7 @@ 
      *
      * @return array(Region) All result's regions which contain search phrase
      */
-    public function getRegions()
-    {
+    public function getRegions() {
         return $this->regions;
     }
 
@@ -280,8 +268,7 @@ 
      *
      * @return array(Highlight) All result's highlights of search phrase
      */
-    public function getHighlights()
-    {
+    public function getHighlights() {
         return $this->highlights;
     }
 
@@ -292,8 +279,7 @@ 
      *
      * @return array(string) All result's highlights of search phrase
      */
-    public function getHighlightsIds()
-    {
+    public function getHighlightsIds() {
         $highlightsIds = [];
         foreach ($this->highlights as $highlight) {
             array_push($highlightsIds, $highlight->getId());
@@ -309,8 +295,7 @@ 
      *
      * @return void
      */
-    private function parseSnippets()
-    {
+    private function parseSnippets() {
         $snippetArray = $this->getArrayByIndex('text');
 
         $this->snippets = !empty($snippetArray) ? implode(' [...] ', $snippetArray) : '';
@@ -324,8 +309,7 @@ 
      *
      * @return void
      */
-    private function parsePages()
-    {
+    private function parsePages() {
         $pageArray = $this->getArrayByIndex('pages');
 
         $i = 0;
@@ -345,8 +329,7 @@ 
      *
      * @return void
      */
-    private function parseRegions()
-    {
+    private function parseRegions() {
         $regionArray = $this->getArrayByIndex('regions');
 
         $i = 0;
@@ -366,8 +349,7 @@ 
      *
      * @return void
      */
-    private function parseHighlights()
-    {
+    private function parseHighlights() {
         $highlightArray = $this->getArrayByIndex('highlights');
 
         foreach ($highlightArray as $highlights) {
@@ -388,8 +370,7 @@ 
      *
      * @return array
      */
-    private function getArrayByIndex($index)
-    {
+    private function getArrayByIndex($index) {
         $objectArray = [];
         foreach ($this->snippetsForRecord as $snippet) {
             if (!empty($snippet[$index])) {

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

@@ -81,7 +81,7 @@
      * @var boolean
      * @access private
      */
-    private $toplevel = false;
+    private $toplevel = FALSE;
 
     /**
      * The structure type

Classes/Common/Indexer.php

Braces +8 added lines, -16 removed lines

@@ -32,8 +32,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * The extension key
      *
@@ -93,8 +92,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public static function add(Document $document)
-    {
+    public static function add(Document $document) {
         if (in_array($document->getUid(), self::$processedDocs)) {
             return true;
         } elseif (self::solrConnect($document->getSolrcore(), $document->getPid())) {
@@ -209,8 +207,7 @@ 
      *
      * @return string The field's dynamic index name
      */
-    public static function getIndexFieldName($index_name, $pid = 0)
-    {
+    public static function getIndexFieldName($index_name, $pid = 0) {
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
@@ -236,8 +233,7 @@ 
      *
      * @return void
      */
-    protected static function loadIndexConf($pid)
-    {
+    protected static function loadIndexConf($pid) {
         if (!self::$fieldsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_metadata');
@@ -307,8 +303,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processLogical(Document $document, array $logicalUnit)
-    {
+    protected static function processLogical(Document $document, array $logicalUnit) {
         $success = true;
         $doc = $document->getDoc();
         $doc->cPid = $document->getPid();
@@ -436,8 +431,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processPhysical(Document $document, $page, array $physicalUnit)
-    {
+    protected static function processPhysical(Document $document, $page, array $physicalUnit) {
         $doc = $document->getDoc();
         $doc->cPid = $document->getPid();
         if ($doc->hasFulltext && $fullText = $doc->getFullText($physicalUnit['id'])) {
@@ -525,8 +519,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function solrConnect($core, $pid = 0)
-    {
+    protected static function solrConnect($core, $pid = 0) {
         // Get Solr instance.
         if (!self::$solr) {
             // Connect to Solr server.
@@ -549,8 +542,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

Spacing +14 added lines, -14 removed lines

@@ -115,7 +115,7 @@ 
                         $parent->setDoc($doc);
                         $success = self::add($parent);
                     } else {
-                        Helper::log('Could not load parent document with UID ' . $document->getDoc()->parentId, LOG_SEVERITY_ERROR);
+                        Helper::log('Could not load parent document with UID '.$document->getDoc()->parentId, LOG_SEVERITY_ERROR);
                         return false;
                     }
                 }
@@ -125,7 +125,7 @@ 
                 self::$processedDocs[] = $document->getUid();
                 // Delete old Solr documents.
                 $updateQuery = self::$solr->service->createUpdate();
-                $updateQuery->addDeleteQuery('uid:' . $document->getUid());
+                $updateQuery->addDeleteQuery('uid:'.$document->getUid());
                 self::$solr->service->update($updateQuery);
 
                 // Index every logical unit as separate Solr document.
@@ -174,14 +174,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     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;
             }
         } else {
@@ -214,7 +214,7 @@ 
         // Sanitize input.
         $pid = max(intval($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.
@@ -223,7 +223,7 @@ 
         $suffix = (in_array($index_name, self::$fields['tokenized']) ? 't' : 'u');
         $suffix .= (in_array($index_name, self::$fields['stored']) ? 's' : 'u');
         $suffix .= (in_array($index_name, self::$fields['indexed']) ? 'i' : 'u');
-        $index_name .= '_' . $suffix;
+        $index_name .= '_'.$suffix;
         return $index_name;
     }
 
@@ -356,11 +356,11 @@ 
                     $solrDoc->setField(self::getIndexFieldName($index_name, $document->getPid()), $data, self::$fields['fieldboost'][$index_name]);
                     if (in_array($index_name, self::$fields['sortables'])) {
                         // Add sortable fields to index.
-                        $solrDoc->setField($index_name . '_sorting', $metadata[$index_name . '_sorting'][0]);
+                        $solrDoc->setField($index_name.'_sorting', $metadata[$index_name.'_sorting'][0]);
                     }
                     if (in_array($index_name, self::$fields['facets'])) {
                         // Add facets to index.
-                        $solrDoc->setField($index_name . '_faceting', $data);
+                        $solrDoc->setField($index_name.'_faceting', $data);
                     }
                     if (in_array($index_name, self::$fields['autocomplete'])) {
                         $autocomplete = array_merge($autocomplete, $data);
@@ -385,14 +385,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getLanguageService()->getLL('flash.solrException') . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getLanguageService()->getLL('flash.solrException').'<br />'.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;
             }
         }
@@ -458,7 +458,7 @@ 
                                 $data = self::removeAppendsFromAuthor($data);
                             }
                             // Add facets to index.
-                            $solrDoc->setField($index_name . '_faceting', $data);
+                            $solrDoc->setField($index_name.'_faceting', $data);
                         }
                     }
                 }
@@ -476,14 +476,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getLanguageService()->getLL('flash.solrException') . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getLanguageService()->getLL('flash.solrException').'<br />'.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;
             }
         }
@@ -534,7 +534,7 @@ 
     private static function getSolrDocument($updateQuery, $document, $unit, $fullText = '') {
         $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());

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

@@ -66,7 +66,7 @@ 
      * @var bool
      * @access protected
      */
-    protected static $fieldsLoaded = false;
+    protected static $fieldsLoaded = FALSE;
 
     /**
      * List of already processed documents
@@ -96,9 +96,9 @@ 
     public static function add(Document $document)
     {
         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.
             if ($parentId = $document->getPartof()) {
@@ -110,13 +110,13 @@ 
                 $parent = $documentRepository->findByUid($parentId);
                 if ($parent) {
                     // get XML document of parent
-                    $doc = Doc::getInstance($parent->getLocation(), ['storagePid' => $parent->getPid()], true);
-                    if ($doc !== null) {
+                    $doc = Doc::getInstance($parent->getLocation(), ['storagePid' => $parent->getPid()], TRUE);
+                    if ($doc !== NULL) {
                         $parent->setDoc($doc);
                         $success = self::add($parent);
                     } else {
                         Helper::log('Could not load parent document with UID ' . $document->getDoc()->parentId, LOG_SEVERITY_ERROR);
-                        return false;
+                        return FALSE;
                     }
                 }
             }
@@ -157,7 +157,7 @@ 
                             sprintf(Helper::getLanguageService()->getLL('flash.documentIndexed'), $document->getTitle(), $document->getUid()),
                             Helper::getLanguageService()->getLL('flash.done'),
                             FlashMessage::OK,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     } else {
@@ -165,7 +165,7 @@ 
                             sprintf(Helper::getLanguageService()->getLL('flash.documentNotIndexed'), $document->getTitle(), $document->getUid()),
                             Helper::getLanguageService()->getLL('flash.error'),
                             FlashMessage::ERROR,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     }
@@ -177,12 +177,12 @@ 
                         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;
             }
         } else {
             if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
@@ -190,12 +190,12 @@ 
                     Helper::getLanguageService()->getLL('flash.solrNoConnection'),
                     Helper::getLanguageService()->getLL('flash.warning'),
                     FlashMessage::WARNING,
-                    true,
+                    TRUE,
                     'core.template.flashMessages'
                 );
             }
             Helper::log('Could not connect to Apache Solr server', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -290,10 +290,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;
         }
     }
 
@@ -309,7 +309,7 @@ 
      */
     protected static function processLogical(Document $document, array $logicalUnit)
     {
-        $success = true;
+        $success = TRUE;
         $doc = $document->getDoc();
         $doc->cPid = $document->getPid();
         // Get metadata for logical unit.
@@ -333,7 +333,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']);
             $solrDoc->setField('record_id', $metadata['record_id'][0]);
@@ -388,12 +388,12 @@ 
                         Helper::getLanguageService()->getLL('flash.solrException') . '<br />' . 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;
             }
         }
         // Check for child elements...
@@ -439,7 +439,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']);
 
@@ -479,15 +479,15 @@ 
                         Helper::getLanguageService()->getLL('flash.solrException') . '<br />' . 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;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -513,10 +513,10 @@ 
                     self::loadIndexConf($pid);
                 }
             } else {
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**

Classes/Common/Doc.php

Spacing +12 added lines, -12 removed lines

@@ -569,14 +569,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?
@@ -595,12 +595,12 @@ 
                     $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.'"');
                 }
             }
             $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;
     }
@@ -674,10 +674,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;
     }
@@ -808,7 +808,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;
     }
@@ -949,7 +949,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 (
@@ -1184,12 +1184,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no getter function for property "' . $var . '"');
+            $this->logger->warning('There is no getter function for property "'.$var.'"');
             return;
         } else {
             return $this->$method();
@@ -1222,12 +1222,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            $this->logger->warning('There is no setter function for property "' . $var . '"');
+            $this->logger->warning('There is no setter function for property "'.$var.'"');
         } else {
             $this->$method($value);
         }

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

@@ -104,7 +104,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $formatsLoaded = false;
+    protected $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -114,7 +114,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltext = false;
+    protected $hasFulltext = FALSE;
 
     /**
      * Last searched logical and physical page
@@ -122,7 +122,7 @@ 
      * @var array
      * @access protected
      */
-    protected $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * This holds the logical units
@@ -148,7 +148,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $metadataArrayLoaded = false;
+    protected $metadataArrayLoaded = FALSE;
 
     /**
      * The holds the total number of pages
@@ -189,7 +189,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $physicalStructureLoaded = false;
+    protected $physicalStructureLoaded = FALSE;
 
     /**
      * This holds the PID of the document or zero if not in database
@@ -214,7 +214,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * The METS file's / IIIF manifest's record identifier
@@ -248,7 +248,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $rootIdLoaded = false;
+    protected $rootIdLoaded = FALSE;
 
     /**
      * This holds the smLinks between logical and physical structMap
@@ -265,7 +265,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $smLinksLoaded = false;
+    protected $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -282,7 +282,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $tableOfContentsLoaded = false;
+    protected $tableOfContentsLoaded = FALSE;
 
     /**
      * This holds the document's thumbnail location
@@ -299,7 +299,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $thumbnailLoaded = false;
+    protected $thumbnailLoaded = FALSE;
 
     /**
      * This holds the toplevel structure's "@ID" (METS) or the manifest's "@id" (IIIF)
@@ -408,17 +408,17 @@ 
      *
      * @return \Kitodo\Dlf\Common\Doc|null Instance of this class, either MetsDocument or IiifManifest
      */
-    public static function &getInstance($location, $settings = [], $forceReload = false)
+    public static function &getInstance($location, $settings = [], $forceReload = FALSE)
     {
         // Create new instance depending on format (METS or IIIF) ...
-        $documentFormat = null;
-        $xml = null;
-        $iiif = null;
+        $documentFormat = NULL;
+        $xml = NULL;
+        $iiif = NULL;
 
         if ($instance = self::getDocCache($location)) {
             return $instance;
         } else {
-            $instance = null;
+            $instance = NULL;
         }
 
         // Try to load a file from the url
@@ -427,17 +427,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['iiifThumbnailHeight']);
                         IiifHelper::setMaxThumbnailWidth($extConf['iiifThumbnailWidth']);
@@ -478,7 +478,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    public abstract function getLogicalStructure($id, $recursive = false);
+    public abstract function getLogicalStructure($id, $recursive = FALSE);
 
     /**
      * This extracts all the metadata for a logical structure node
@@ -515,7 +515,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;
@@ -566,7 +566,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 . '"');
@@ -618,7 +618,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 {
@@ -638,7 +638,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
+    public static function getTitle($uid, $recursive = FALSE)
     {
         $title = '';
         // Sanitize input.
@@ -671,7 +671,7 @@ 
                     && intval($partof)
                     && $partof != $uid
                 ) {
-                    $title = self::getTitle($partof, true);
+                    $title = self::getTitle($partof, TRUE);
                 }
             } else {
                 Helper::log('No document with UID ' . $uid . ' found or document not accessible', LOG_SEVERITY_WARNING);
@@ -732,12 +732,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;
     }
 
     /**
@@ -810,7 +810,7 @@ 
         } else {
             $this->logger->error('Invalid file location "' . $location . '" for document loading');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -857,7 +857,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -958,7 +958,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1067,7 +1067,7 @@ 
                 $parent = self::getInstance($this->parentId, ['storagePid' => $this->pid]);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1096,8 +1096,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;
     }
@@ -1113,7 +1113,7 @@ 
      *
      * @return string The document's thumbnail location
      */
-    protected abstract function _getThumbnail($forceReload = false);
+    protected abstract function _getThumbnail($forceReload = FALSE);
 
     /**
      * This returns the ID of the toplevel logical structure node

Braces +32 added lines, -64 removed lines

@@ -49,8 +49,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's "@ID" (METS) or the manifest's "@id" (IIIF)
  * @abstract
  */
-abstract class Doc
-{
+abstract class Doc {
     /**
      * This holds the logger
      *
@@ -326,8 +325,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -505,8 +503,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -551,8 +548,7 @@ 
      *
      * @return string The OCR full text
      */
-    protected function getFullTextFromXml($id)
-    {
+    protected function getFullTextFromXml($id) {
         $fullText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -614,8 +610,7 @@ 
      *
      * @return string The format of the OCR full text
      */
-    private function getTextFormat($fileContent)
-    {
+    private function getTextFormat($fileContent) {
         $xml = Helper::getXmlFileAsString($fileContent);
 
         if ($xml !== false) {
@@ -638,8 +633,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
-    {
+    public static function getTitle($uid, $recursive = false) {
         $title = '';
         // Sanitize input.
         $uid = max(intval($uid), 0);
@@ -691,8 +685,7 @@ 
      *
      * @return array The logical structure node's / resource's parsed metadata array
      */
-    public function getTitledata($cPid = 0)
-    {
+    public function getTitledata($cPid = 0) {
         $titledata = $this->getMetadata($this->_getToplevelId(), $cPid);
         // Add information from METS structural map to titledata array.
         if ($this instanceof MetsDocument) {
@@ -725,8 +718,7 @@ 
      * @return int|bool: false if structure with $logId is not a child of this substructure,
      * or the actual depth.
      */
-    protected function getTreeDepth($structure, $depth, $logId)
-    {
+    protected function getTreeDepth($structure, $depth, $logId) {
         foreach ($structure as $element) {
             if ($element['id'] == $logId) {
                 return $depth;
@@ -748,8 +740,7 @@ 
      * @param string $logId: The id of the logical structure element whose depth is requested
      * @return int|bool tree depth as integer or false if no element with $logId exists within the TOC.
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         return $this->getTreeDepth($this->_getTableOfContents(), 1, $logId);
     }
 
@@ -801,8 +792,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function load($location)
-    {
+    protected function load($location) {
         // Load XML / JSON-LD file.
         if (GeneralUtility::isValidUrl($location)) {
             // the actual loading is format specific
@@ -829,8 +819,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -870,8 +859,7 @@ 
      *
      * @return void
      */
-    public function registerNamespaces(&$obj)
-    {
+    public function registerNamespaces(&$obj) {
         // TODO Check usage. XML specific method does not seem to be used anywhere outside this class within the project, but it is public and may be used by extensions.
         $this->loadFormats();
         // Do we have a \SimpleXMLElement or \DOMXPath object?
@@ -896,8 +884,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -908,8 +895,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -921,8 +907,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -944,8 +929,7 @@ 
      *
      * @return array Array of metadata with their corresponding logical structure node ID as key
      */
-    protected function _getMetadataArray()
-    {
+    protected function _getMetadataArray() {
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
@@ -970,8 +954,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -983,8 +966,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1007,8 +989,7 @@ 
      *
      * @return array Array of elements' type, label and file representations ordered by "@ID" attribute / Canvas order
      */
-    protected function _getPhysicalStructureInfo()
-    {
+    protected function _getPhysicalStructureInfo() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Build physical structure array.
@@ -1024,8 +1005,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1036,8 +1016,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1048,8 +1027,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1060,8 +1038,7 @@ 
      *
      * @return int The UID of the root document or zero if not applicable
      */
-    protected function _getRootId()
-    {
+    protected function _getRootId() {
         if (!$this->rootIdLoaded) {
             if ($this->parentId) {
                 $parent = self::getInstance($this->parentId, ['storagePid' => $this->pid]);
@@ -1091,8 +1068,7 @@ 
      *
      * @return array Array of structure nodes' id, label, type and physical page indexes/mptr / Canvas link with original hierarchy preserved
      */
-    protected function _getTableOfContents()
-    {
+    protected function _getTableOfContents() {
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
@@ -1133,8 +1109,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1147,8 +1122,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1165,8 +1139,7 @@ 
      *
      * @return void
      */
-    protected function __construct($location, $pid, $preloadedDocument)
-    {
+    protected function __construct($location, $pid, $preloadedDocument) {
         $this->pid = $pid;
         $this->setPreloadedDocument($preloadedDocument);
         $this->init($location);
@@ -1183,8 +1156,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1206,8 +1178,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -1221,8 +1192,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1240,8 +1210,7 @@ 
      * @param string $location
      * @return Doc|false
      */
-    private static function getDocCache(string $location)
-    {
+    private static function getDocCache(string $location) {
         $cacheIdentifier = md5($location);
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_doc');
         $cacheHit = $cache->get($cacheIdentifier);
@@ -1256,8 +1225,7 @@ 
      * @param Doc $doc
      * @return void
      */
-    private static function setDocCache(string $location, Doc $doc)
-    {
+    private static function setDocCache(string $location, Doc $doc) {
         $cacheIdentifier = md5($location);
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_doc');