Erikmitk / kitodo-presentation

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

Spacing +29 added lines, -29 removed lines

@@ -168,7 +168,7 @@ 
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
-            $fileLocation = (strrpos($fileLocation, 'info.json') === strlen($fileLocation) - 9) ? $fileLocation : (strrpos($fileLocation, '/') === strlen($fileLocation) ? $fileLocation . 'info.json' : $fileLocation . '/info.json');
+            $fileLocation = (strrpos($fileLocation, 'info.json') === strlen($fileLocation) - 9) ? $fileLocation : (strrpos($fileLocation, '/') === strlen($fileLocation) ? $fileLocation.'info.json' : $fileLocation.'/info.json');
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
             IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
@@ -178,9 +178,9 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($fileMimeType === 'application/vnd.netfpx') {
-            $baseURL = $fileLocation . (strpos($fileLocation, '?') === false ? '?' : '');
+            $baseURL = $fileLocation.(strpos($fileLocation, '?') === false ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
-            return $baseURL . '&CVT=jpeg';
+            return $baseURL.'&CVT=jpeg';
         }
         return $fileLocation;
     }
@@ -191,14 +191,14 @@ 
      */
     public function getFileLocation($id)
     {
-        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
+        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
             && !empty($location)
         ) {
             return (string) $location[0]->attributes('http://www.w3.org/1999/xlink')->href;
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '"');
+            $this->logger->warning('There is no file node with @ID "'.$id.'"');
             return '';
         }
     }
@@ -209,14 +209,14 @@ 
      */
     public function getFileMimeType($id)
     {
-        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
+        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/@MIMETYPE');
         if (
             !empty($id)
             && !empty($mimetype)
         ) {
             return (string) $mimetype[0];
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '" or no MIME type specified');
+            $this->logger->warning('There is no file node with @ID "'.$id.'" or no MIME type specified');
             return '';
         }
     }
@@ -237,7 +237,7 @@ 
             return $this->logicalUnits[$id];
         } elseif (!empty($id)) {
             // Get specified logical unit.
-            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]');
+            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]');
         } else {
             // Get all logical units at top level.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div');
@@ -377,7 +377,7 @@ 
             // Retain current PID.
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
         } elseif (!$cPid) {
-            $this->logger->warning('Invalid PID ' . $cPid . ' for metadata definitions');
+            $this->logger->warning('Invalid PID '.$cPid.' for metadata definitions');
             return [];
         }
         // Get metadata from parsed metadata array if available.
@@ -418,7 +418,7 @@ 
         if (!empty($this->logicalUnits[$id])) {
             $dmdIds = $this->logicalUnits[$id]['dmdId'];
         } else {
-            $dmdIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]/@DMDID');
+            $dmdIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]/@DMDID');
             $dmdIds = (string) $dmdIds[0];
         }
         if (!empty($dmdIds)) {
@@ -444,11 +444,11 @@ 
                     ) {
                         $obj->extractMetadata($this->dmdSec[$dmdId]['xml'], $metadata);
                     } else {
-                        $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->dmdSec[$dmdId]['type'] . '"');
+                        $this->logger->warning('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->dmdSec[$dmdId]['type'].'"');
                     }
                 }
             } else {
-                $this->logger->notice('Unsupported metadata format "' . $this->dmdSec[$dmdId]['type'] . '" in dmdSec with @ID "' . $dmdId . '"');
+                $this->logger->notice('Unsupported metadata format "'.$this->dmdSec[$dmdId]['type'].'" in dmdSec with @ID "'.$dmdId.'"');
                 // Continue searching for supported metadata with next @DMDID.
                 continue;
             }
@@ -456,7 +456,7 @@ 
             if (!empty($this->logicalUnits[$id])) {
                 $metadata['type'] = [$this->logicalUnits[$id]['type']];
             } else {
-                $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]/@TYPE');
+                $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]/@TYPE');
                 if (!empty($struct)) {
                     $metadata['type'] = [(string) $struct[0]];
                 }
@@ -573,13 +573,13 @@ 
                             $values instanceof \DOMNodeList
                             && $values->length > 0
                         ) {
-                            $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values->item(0)->nodeValue);
+                            $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values->item(0)->nodeValue);
                         } elseif (!($values instanceof \DOMNodeList)) {
-                            $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values);
+                            $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values);
                         }
                     }
-                    if (empty($metadata[$resArray['index_name'] . '_sorting'][0])) {
-                        $metadata[$resArray['index_name'] . '_sorting'][0] = $metadata[$resArray['index_name']][0];
+                    if (empty($metadata[$resArray['index_name'].'_sorting'][0])) {
+                        $metadata[$resArray['index_name'].'_sorting'][0] = $metadata[$resArray['index_name']][0];
                     }
                 }
             }
@@ -595,7 +595,7 @@ 
         if ($hasSupportedMetadata) {
             return $metadata;
         } else {
-            $this->logger->warning('No supported metadata found for logical structure with @ID "' . $id . '"');
+            $this->logger->warning('No supported metadata found for logical structure with @ID "'.$id.'"');
             return [];
         }
     }
@@ -622,7 +622,7 @@ 
      */
     public function getStructureDepth($logId)
     {
-        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
+        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$logId.'"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
         } else {
@@ -646,9 +646,9 @@ 
             $this->registerNamespaces($this->mets);
         } else {
             if (!empty($location)) {
-                $this->logger->error('No METS part found in document with location "' . $location . '".');
+                $this->logger->error('No METS part found in document with location "'.$location.'".');
             } else if (!empty($this->recordId)) {
-                $this->logger->error('No METS part found in document with recordId "' . $this->recordId . '".');
+                $this->logger->error('No METS part found in document with recordId "'.$this->recordId.'".');
             } else {
                 $this->logger->error('No METS part found in current document.');
             }
@@ -670,7 +670,7 @@ 
                 return true;
             }
         }
-        $this->logger->error('Could not load XML file from "' . $location . '"');
+        $this->logger->error('Could not load XML file from "'.$location.'"');
         return false;
     }
 
@@ -725,15 +725,15 @@ 
             $dmdIds = $this->mets->xpath('./mets:dmdSec/@ID');
             if (!empty($dmdIds)) {
                 foreach ($dmdIds as $dmdId) {
-                    if ($type = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[not(@MDTYPE="OTHER")]/@MDTYPE')) {
+                    if ($type = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[not(@MDTYPE="OTHER")]/@MDTYPE')) {
                         if (!empty($this->formats[(string) $type[0]])) {
                             $type = (string) $type[0];
-                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
                         }
-                    } elseif ($type = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="OTHER"]/@OTHERMDTYPE')) {
+                    } elseif ($type = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="OTHER"]/@OTHERMDTYPE')) {
                         if (!empty($this->formats[(string) $type[0]])) {
                             $type = (string) $type[0];
-                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="' . (string) $dmdId . '"]/mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+                            $xml = $this->mets->xpath('./mets:dmdSec[@ID="'.(string) $dmdId.'"]/mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
                         }
                     }
                     if (!empty($xml)) {
@@ -918,7 +918,7 @@ 
             // Retain current PID.
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
             if (!$cPid) {
-                $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
+                $this->logger->error('Invalid PID '.$cPid.' for structure definitions');
                 $this->thumbnailLoaded = true;
                 return $this->thumbnail;
             }
@@ -955,7 +955,7 @@ 
                 if (!empty($resArray['thumbnail'])) {
                     $strctType = Helper::getIndexNameFromUid($resArray['thumbnail'], 'tx_dlf_structures', $cPid);
                     // Check if this document has a structure element of the desired type.
-                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="' . $strctType . '"]/@ID');
+                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="'.$strctType.'"]/@ID');
                     if (!empty($strctIds)) {
                         $strctId = (string) $strctIds[0];
                     }
@@ -978,7 +978,7 @@ 
                     }
                 }
             } else {
-                $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
+                $this->logger->error('No structure of type "'.$metadata['type'][0].'" found in database');
             }
             $this->thumbnailLoaded = true;
         }

Braces +27 added lines, -54 removed lines

@@ -47,8 +47,7 @@ 
  * @property-read string $thumbnail This holds the document's thumbnail location
  * @property-read string $toplevelId This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
  */
-final class MetsDocument extends Doc
-{
+final class MetsDocument extends Doc {
     /**
      * This holds the whole XML file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -127,8 +126,7 @@ 
      *
      * @return  void
      */
-    public function addMetadataFromMets(&$metadata, $id)
-    {
+    public function addMetadataFromMets(&$metadata, $id) {
         $details = $this->getLogicalStructure($id);
         if (!empty($details)) {
             $metadata['mets_order'][0] = $details['order'];
@@ -142,8 +140,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::establishRecordId()
      */
-    protected function establishRecordId($pid)
-    {
+    protected function establishRecordId($pid) {
         // Check for METS object @ID.
         if (!empty($this->mets['OBJID'])) {
             $this->recordId = (string) $this->mets['OBJID'];
@@ -163,8 +160,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
@@ -189,8 +185,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
@@ -207,8 +202,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
         if (
             !empty($id)
@@ -225,8 +219,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         // Is the requested logical unit already loaded?
         if (
@@ -266,8 +259,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false)
-    {
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false) {
         // Get attributes.
         foreach ($structure->attributes() as $attribute => $value) {
             $attributes[$attribute] = (string) $value;
@@ -365,8 +357,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getMetadata()
      */
-    public function getMetadata($id, $cPid = 0)
-    {
+    public function getMetadata($id, $cPid = 0) {
         // Make sure $cPid is a non-negative integer.
         $cPid = max(intval($cPid), 0);
         // If $cPid is not given, try to get it elsewhere.
@@ -604,8 +595,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFullText()
      */
-    public function getFullText($id)
-    {
+    public function getFullText($id) {
         $fullText = '';
 
         // Load fileGrps and check for full text files.
@@ -620,8 +610,7 @@ 
      * {@inheritDoc}
      * @see Doc::getStructureDepth()
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
@@ -634,8 +623,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::init()
      */
-    protected function init($location)
-    {
+    protected function init($location) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_class($this));
         // Get METS node from XML file.
         $this->registerNamespaces($this->xml);
@@ -659,8 +647,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = Helper::getUrl($location);
         if ($fileResource !== false) {
             $xml = Helper::getXmlFileAsString($fileResource);
@@ -678,8 +665,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -690,8 +676,7 @@ 
      * {@inheritDoc}
      * @see Doc::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -704,8 +689,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -716,8 +700,7 @@ 
      *
      * @return array Array of dmdSecs with their IDs as array key
      */
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         if (!$this->dmdSecLoaded) {
             // Get available data formats.
             $this->loadFormats();
@@ -755,8 +738,7 @@ 
      *
      * @return array Array of file use groups with file IDs
      */
-    protected function _getFileGrps()
-    {
+    protected function _getFileGrps() {
         if (!$this->fileGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -801,8 +783,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $ids = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID]/@ID');
         // Get all logical structure nodes with metadata.
         if (!empty($ids)) {
@@ -820,8 +801,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -829,8 +809,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getPhysicalStructure()
      */
-    protected function _getPhysicalStructure()
-    {
+    protected function _getPhysicalStructure() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Does the document have a structMap node of type "PHYSICAL"?
@@ -890,8 +869,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded) {
             $smLinks = $this->mets->xpath('./mets:structLink/mets:smLink');
             if (!empty($smLinks)) {
@@ -909,8 +887,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -989,8 +966,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             // Get all logical structure nodes with metadata, but without associated METS-Pointers.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID and not(./mets:mptr)]');
@@ -1022,8 +998,7 @@ 
      *
      * @return array Properties to be serialized
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // \SimpleXMLElement objects can't be serialized, thus save the XML as string for serialization
         $this->asXML = $this->xml->asXML();
         return ['uid', 'pid', 'recordId', 'parentId', 'asXML'];
@@ -1036,8 +1011,7 @@ 
      *
      * @return string String representing the METS object
      */
-    public function __toString()
-    {
+    public function __toString() {
         $xml = new \DOMDocument('1.0', 'utf-8');
         $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
         $xml->formatOutput = true;
@@ -1052,8 +1026,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $xml = Helper::getXmlFileAsString($this->asXML);
         if ($xml !== false) {
             $this->asXML = '';

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

@@ -73,7 +73,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $dmdSecLoaded = false;
+    protected $dmdSecLoaded = FALSE;
 
     /**
      * The extension key
@@ -99,7 +99,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $fileGrpsLoaded = false;
+    protected $fileGrpsLoaded = FALSE;
 
     /**
      * This holds the XML file's METS part as \SimpleXMLElement object
@@ -174,11 +174,11 @@ 
             IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
             IiifHelper::setMaxThumbnailWidth($conf['iiifThumbnailWidth']);
             $service = IiifHelper::loadIiifResource($fileLocation);
-            if ($service !== null && $service instanceof AbstractImageService) {
+            if ($service !== NULL && $service instanceof AbstractImageService) {
                 return $service->getImageUrl();
             }
         } elseif ($fileMimeType === 'application/vnd.netfpx') {
-            $baseURL = $fileLocation . (strpos($fileLocation, '?') === false ? '?' : '');
+            $baseURL = $fileLocation . (strpos($fileLocation, '?') === FALSE ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
             return $baseURL . '&CVT=jpeg';
         }
@@ -225,7 +225,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
+    public function getLogicalStructure($id, $recursive = FALSE)
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -266,7 +266,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false)
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = FALSE)
     {
         // Get attributes.
         foreach ($structure->attributes() as $attribute => $value) {
@@ -311,7 +311,7 @@ 
             && array_key_exists($details['id'], $this->smLinks['l2p'])
         ) {
             // Link logical structure to the first corresponding physical page/track.
-            $details['points'] = max(intval(array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, true)), 1);
+            $details['points'] = max(intval(array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE)), 1);
             $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
             while ($fileGrpThumb = array_shift($fileGrpsThumb)) {
                 if (!empty($this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['files'][$fileGrpThumb])) {
@@ -355,7 +355,7 @@ 
             $details['children'] = [];
             foreach ($structure->children('http://www.loc.gov/METS/')->div as $child) {
                 // Repeat for all children.
-                $details['children'][] = $this->getLogicalStructureInfo($child, true);
+                $details['children'][] = $this->getLogicalStructureInfo($child, TRUE);
             }
         }
         return $details;
@@ -424,7 +424,7 @@ 
         if (!empty($dmdIds)) {
             // Handle multiple DMDIDs separately.
             $dmdIds = explode(' ', $dmdIds);
-            $hasSupportedMetadata = false;
+            $hasSupportedMetadata = FALSE;
         } else {
             // There is no dmdSec for this structure node.
             return [];
@@ -589,7 +589,7 @@ 
                 $metadata['title_sorting'][0] = '';
             }
             // Extract metadata only from first supported dmdSec.
-            $hasSupportedMetadata = true;
+            $hasSupportedMetadata = TRUE;
             break;
         }
         if ($hasSupportedMetadata) {
@@ -662,16 +662,16 @@ 
     protected function loadLocation($location)
     {
         $fileResource = Helper::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $xml = Helper::getXmlFileAsString($fileResource);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -695,9 +695,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -743,7 +743,7 @@ 
                     }
                 }
             }
-            $this->dmdSecLoaded = true;
+            $this->dmdSecLoaded = TRUE;
         }
         return $this->dmdSec;
     }
@@ -790,9 +790,9 @@ 
                 !empty($extConf['fileGrpFulltext'])
                 && array_intersect(GeneralUtility::trimExplode(',', $extConf['fileGrpFulltext']), $this->fileGrps) !== []
             ) {
-                $this->hasFulltext = true;
+                $this->hasFulltext = TRUE;
             }
-            $this->fileGrpsLoaded = true;
+            $this->fileGrpsLoaded = TRUE;
         }
         return $this->fileGrps;
     }
@@ -881,7 +881,7 @@ 
                     $this->physicalStructure = array_merge($physSeq, $elements);
                 }
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -900,7 +900,7 @@ 
                     $this->smLinks['p2l'][(string) $smLink->attributes('http://www.w3.org/1999/xlink')->to][] = (string) $smLink->attributes('http://www.w3.org/1999/xlink')->from;
                 }
             }
-            $this->smLinksLoaded = true;
+            $this->smLinksLoaded = TRUE;
         }
         return $this->smLinks;
     }
@@ -909,7 +909,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
+    protected function _getThumbnail($forceReload = FALSE)
     {
         if (
             !$this->thumbnailLoaded
@@ -919,14 +919,14 @@ 
             $cPid = ($this->cPid ? $this->cPid : $this->pid);
             if (!$cPid) {
                 $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             // Load extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
             if (empty($extConf['fileGrpThumbs'])) {
                 $this->logger->warning('No fileGrp for thumbnails specified');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->_getToplevelId();
@@ -980,7 +980,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1039,8 +1039,8 @@ 
     public function __toString()
     {
         $xml = new \DOMDocument('1.0', 'utf-8');
-        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
-        $xml->formatOutput = true;
+        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), TRUE));
+        $xml->formatOutput = TRUE;
         return $xml->saveXML();
     }
 
@@ -1055,7 +1055,7 @@ 
     public function __wakeup()
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.

Classes/Common/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);
         }

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->setPreloadedDocument($preloadedDocument);
         $this->init($location);
         $this->establishRecordId($pid);
@@ -1182,8 +1155,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1205,8 +1177,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));
     }
 
@@ -1220,8 +1191,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1239,8 +1209,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);
@@ -1255,8 +1224,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');
 

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

Classes/Common/Helper.php

Spacing +34 added lines, -34 removed lines

@@ -142,7 +142,7 @@ 
                 if (!preg_match('/[0-9]{8}-[0-9]{1}/i', $id)) {
                     return false;
                 } elseif ($checksum == 10) {
-                    return self::checkIdentifier(($digits + 1) . substr($id, -2, 2), 'SWD');
+                    return self::checkIdentifier(($digits + 1).substr($id, -2, 2), 'SWD');
                 } elseif (substr($id, -1, 1) != $checksum) {
                     return false;
                 }
@@ -307,7 +307,7 @@ 
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialisation vector and encrypted data.
         if ($encrypted !== false) {
-            $encrypted = base64_encode($iv . $encrypted);
+            $encrypted = base64_encode($iv.$encrypted);
         }
         return $encrypted;
     }
@@ -361,8 +361,8 @@ 
     public static function getHookObjects($scriptRelPath)
     {
         $hookObjects = [];
-        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
-            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
+        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey.'/'.$scriptRelPath]['hookClass'])) {
+            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey.'/'.$scriptRelPath]['hookClass'] as $classRef) {
                 $hookObjects[] = GeneralUtility::makeInstance($classRef);
             }
         }
@@ -388,7 +388,7 @@ 
             !$uid
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::log('Invalid UID "' . $uid . '" or table "' . $table . '"', LOG_SEVERITY_ERROR);
+            self::log('Invalid UID "'.$uid.'" or table "'.$table.'"', LOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -399,15 +399,15 @@ 
         // Should we check for a specific PID, too?
         if ($pid !== -1) {
             $pid = max(intval($pid), 0);
-            $where = $queryBuilder->expr()->eq($table . '.pid', $pid);
+            $where = $queryBuilder->expr()->eq($table.'.pid', $pid);
         }
 
         // Get index_name from database.
         $result = $queryBuilder
-            ->select($table . '.index_name AS index_name')
+            ->select($table.'.index_name AS index_name')
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.uid', $uid),
+                $queryBuilder->expr()->eq($table.'.uid', $uid),
                 $where,
                 self::whereExpression($table)
             )
@@ -417,7 +417,7 @@ 
         if ($resArray = $result->fetch()) {
             return $resArray['index_name'];
         } else {
-            self::log('No "index_name" with UID ' . $uid . ' and PID ' . $pid . ' found in table "' . $table . '"', LOG_SEVERITY_WARNING);
+            self::log('No "index_name" with UID '.$uid.' and PID '.$pid.' found in table "'.$table.'"', LOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -436,9 +436,9 @@ 
         // Analyze code and set appropriate ISO table.
         $isoCode = strtolower(trim($code));
         if (preg_match('/^[a-z]{3}$/', $isoCode)) {
-            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey) . 'Resources/Private/Data/iso-639-2b.xml';
+            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey).'Resources/Private/Data/iso-639-2b.xml';
         } elseif (preg_match('/^[a-z]{2}$/', $isoCode)) {
-            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey) . 'Resources/Private/Data/iso-639-1.xml';
+            $file = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath(self::$extKey).'Resources/Private/Data/iso-639-1.xml';
         } else {
             // No ISO code, return unchanged.
             return $code;
@@ -456,13 +456,13 @@ 
                 $lang = $languageService->getLLL($isoCode, $iso639);
             }
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return $code;
         }
         if (!empty($lang)) {
             return $lang;
         } else {
-            self::log('Language code "' . $code . '" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
+            self::log('Language code "'.$code.'" not found in ISO-639 table', LOG_SEVERITY_NOTICE);
             return $code;
         }
     }
@@ -557,7 +557,7 @@ 
             '-' => 39,
             ':' => 17,
         ];
-        $urn = strtolower($base . $id);
+        $urn = strtolower($base.$id);
         if (preg_match('/[^a-z0-9:-]/', $urn)) {
             self::log('Invalid chars in given parameters', LOG_SEVERITY_WARNING);
             return '';
@@ -571,7 +571,7 @@ 
             $checksum += ($i + 1) * intval(substr($digits, $i, 1));
         }
         $checksum = substr(intval($checksum / intval(substr($digits, -1, 1))), -1, 1);
-        return $base . $id . $checksum;
+        return $base.$id.$checksum;
     }
 
     /**
@@ -665,7 +665,7 @@ 
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
-            self::log('Invalid PID ' . $pid . ' for translation', LOG_SEVERITY_WARNING);
+            self::log('Invalid PID '.$pid.' for translation', LOG_SEVERITY_WARNING);
             return $index_name;
         }
         /** @var \TYPO3\CMS\Frontend\Page\PageRepository $pageRepository */
@@ -687,13 +687,13 @@ 
         // First fetch the uid of the received index_name
         $result = $queryBuilder
             ->select(
-                $table . '.uid AS uid',
-                $table . '.l18n_parent AS l18n_parent'
+                $table.'.uid AS uid',
+                $table.'.l18n_parent AS l18n_parent'
             )
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.pid', $pid),
-                $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
+                $queryBuilder->expr()->eq($table.'.pid', $pid),
+                $queryBuilder->expr()->eq($table.'.index_name', $queryBuilder->expr()->literal($index_name)),
                 self::whereExpression($table, true)
             )
             ->setMaxResults(1)
@@ -706,12 +706,12 @@ 
             $resArray = $allResults[0];
 
             $result = $queryBuilder
-                ->select($table . '.index_name AS index_name')
+                ->select($table.'.index_name AS index_name')
                 ->from($table)
                 ->where(
-                    $queryBuilder->expr()->eq($table . '.pid', $pid),
-                    $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
-                    $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($languageAspect->getContentId())),
+                    $queryBuilder->expr()->eq($table.'.pid', $pid),
+                    $queryBuilder->expr()->eq($table.'.uid', $resArray['l18n_parent']),
+                    $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($languageAspect->getContentId())),
                     self::whereExpression($table, true)
                 )
                 ->setMaxResults(1)
@@ -729,14 +729,14 @@ 
         if (empty($labels[$table][$pid][$languageAspect->getContentId()][$index_name])) {
             // Check if this table is allowed for translation.
             if (in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures'])) {
-                $additionalWhere = $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]);
+                $additionalWhere = $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]);
                 if ($languageAspect->getContentId() > 0) {
                     $additionalWhere = $queryBuilder->expr()->andX(
                         $queryBuilder->expr()->orX(
-                            $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]),
-                            $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($languageAspect->getContentId()))
+                            $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]),
+                            $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($languageAspect->getContentId()))
                         ),
-                        $queryBuilder->expr()->eq($table . '.l18n_parent', 0)
+                        $queryBuilder->expr()->eq($table.'.l18n_parent', 0)
                     );
                 }
 
@@ -745,7 +745,7 @@ 
                     ->select('*')
                     ->from($table)
                     ->where(
-                        $queryBuilder->expr()->eq($table . '.pid', $pid),
+                        $queryBuilder->expr()->eq($table.'.pid', $pid),
                         $additionalWhere,
                         self::whereExpression($table, true)
                     )
@@ -763,10 +763,10 @@ 
                         }
                     }
                 } else {
-                    self::log('No translation with PID ' . $pid . ' available in table "' . $table . '" or translation not accessible', LOG_SEVERITY_NOTICE);
+                    self::log('No translation with PID '.$pid.' available in table "'.$table.'" or translation not accessible', LOG_SEVERITY_NOTICE);
                 }
             } else {
-                self::log('No translations available for table "' . $table . '"', LOG_SEVERITY_WARNING);
+                self::log('No translations available for table "'.$table.'"', LOG_SEVERITY_WARNING);
             }
         }
 
@@ -808,9 +808,9 @@ 
             return GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable($table)
                 ->expr()
-                ->eq($table . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'], 0);
+                ->eq($table.'.'.$GLOBALS['TCA'][$table]['ctrl']['delete'], 0);
         } else {
-            self::log('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', LOG_SEVERITY_ERROR);
+            self::log('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', LOG_SEVERITY_ERROR);
             return '1=-1';
         }
     }
@@ -849,7 +849,7 @@ 
      */
     public static function polyfillExtbaseClassesForTYPO3v9()
     {
-        $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
+        $classes = require __DIR__.'/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
         $configurationManager = $objectManager->get(ConfigurationManager::class);

Braces +24 added lines, -48 removed lines

@@ -31,8 +31,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -80,8 +79,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
-    {
+    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = GeneralUtility::makeInstance(
@@ -106,8 +104,7 @@ 
      *
      * @return bool Is $id a valid GNL identifier of the given $type?
      */
-    public static function checkIdentifier($id, $type)
-    {
+    public static function checkIdentifier($id, $type) {
         $digits = substr($id, 0, 8);
         $checksum = 0;
         for ($i = 0, $j = strlen($digits); $i < $j; $i++) {
@@ -171,8 +168,7 @@ 
      *
      * @return mixed The decrypted value or false on error
      */
-    public static function decrypt($encrypted)
-    {
+    public static function decrypt($encrypted) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -211,8 +207,7 @@ 
      *
      * @return \SimpleXMLElement|false
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
@@ -243,8 +238,7 @@ 
      *
      * @return void
      */
-    public static function log($message, $severity = 0)
-    {
+    public static function log($message, $severity = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_called_class());
 
         switch ($severity) {
@@ -274,8 +268,7 @@ 
      *
      * @return mixed Hashed string or false on error
      */
-    public static function digest($string)
-    {
+    public static function digest($string) {
         if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
             return false;
@@ -294,8 +287,7 @@ 
      *
      * @return mixed Encrypted string or false on error
      */
-    public static function encrypt($string)
-    {
+    public static function encrypt($string) {
         if (
             !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
             || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
@@ -328,8 +320,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -343,8 +334,7 @@ 
      *
      * @return string The cleaned up string
      */
-    public static function getCleanString($string)
-    {
+    public static function getCleanString($string) {
         // Convert to lowercase.
         $string = strtolower($string);
         // Remove non-alphanumeric characters.
@@ -365,8 +355,7 @@ 
      *
      * @return array Array of hook objects for the class
      */
-    public static function getHookObjects($scriptRelPath)
-    {
+    public static function getHookObjects($scriptRelPath) {
         $hookObjects = [];
         if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'])) {
             foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::$extKey . '/' . $scriptRelPath]['hookClass'] as $classRef) {
@@ -387,8 +376,7 @@ 
      *
      * @return string "index_name" for the given UID
      */
-    public static function getIndexNameFromUid($uid, $table, $pid = -1)
-    {
+    public static function getIndexNameFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -438,8 +426,7 @@ 
      *
      * @return string Localized full name of language or unchanged input
      */
-    public static function getLanguageName($code)
-    {
+    public static function getLanguageName($code) {
         // Analyze code and set appropriate ISO table.
         $isoCode = strtolower(trim($code));
         if (preg_match('/^[a-z]{3}$/', $isoCode)) {
@@ -481,8 +468,7 @@ 
      *
      * @return array
      */
-    public static function getDocumentStructures($pid = -1)
-    {
+    public static function getDocumentStructures($pid = -1) {
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
         $queryBuilder = $connectionPool->getQueryBuilderForTable('tx_dlf_structures');
 
@@ -522,8 +508,7 @@ 
      *
      * @return string Uniform Resource Name as string
      */
-    public static function getURN($base, $id)
-    {
+    public static function getURN($base, $id) {
         $concordance = [
             '0' => 1,
             '1' => 2,
@@ -590,8 +575,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -602,8 +586,7 @@ 
      *
      * @return bool
      */
-    public static function isValidHttpUrl($url)
-    {
+    public static function isValidHttpUrl($url) {
         if (!GeneralUtility::isValidUrl($url)) {
             return false;
         }
@@ -629,8 +612,7 @@ 
      *
      * @return array Merged array
      */
-    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
-    {
+    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true) {
         \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($original, $overrule, $addKeys, $includeEmptyValues, $enableUnsetFeature);
         return $original;
     }
@@ -644,8 +626,7 @@ 
      *
      * @return string All flash messages in the queue rendered as HTML.
      */
-    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages')
-    {
+    public static function renderFlashMessages($queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessages = $flashMessageQueue->getAllMessagesAndFlush();
@@ -665,8 +646,7 @@ 
      *
      * @return string Localized label for $index_name
      */
-    public static function translate($index_name, $table, $pid)
-    {
+    public static function translate($index_name, $table, $pid) {
         // Load labels into static variable for future use.
         static $labels = [];
         // Sanitize input.
@@ -794,8 +774,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = false)
-    {
+    public static function whereExpression($table, $showHidden = false) {
         if (\TYPO3_MODE === 'FE') {
             // Should we ignore the record's hidden flag?
             $ignoreHide = 0;
@@ -827,8 +806,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 
@@ -854,8 +832,7 @@ 
      *
      * @access public
      */
-    public static function polyfillExtbaseClassesForTYPO3v9()
-    {
+    public static function polyfillExtbaseClassesForTYPO3v9() {
         $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
@@ -892,8 +869,7 @@ 
      *
      * @return string|bool
      */
-    public static function getUrl(string $url)
-    {
+    public static function getUrl(string $url) {
         if (!Helper::isValidHttpUrl($url)) {
             return false;
         }

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

@@ -80,7 +80,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
+    public static function addMessage($message, $title, $severity, $session = FALSE, $queue = 'kitodo.default.flashMessages')
     {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
@@ -122,9 +122,9 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'ZDB':
@@ -132,19 +132,19 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}-[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'SWD':
                 $checksum = 11 - $checksum;
                 if (!preg_match('/[0-9]{8}-[0-9]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif ($checksum == 10) {
                     return self::checkIdentifier(($digits + 1) . substr($id, -2, 2), 'SWD');
                 } elseif (substr($id, -1, 1) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
             case 'GKD':
@@ -153,13 +153,13 @@ 
                     $checksum = 'X';
                 }
                 if (!preg_match('/[0-9]{8}-[0-9X]{1}/i', $id)) {
-                    return false;
+                    return FALSE;
                 } elseif (strtoupper(substr($id, -1, 1)) != $checksum) {
-                    return false;
+                    return FALSE;
                 }
                 break;
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -174,28 +174,28 @@ 
     public static function decrypt($encrypted)
     {
         if (
-            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
-            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
+            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(TRUE))
+            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))
         ) {
             self::log('OpenSSL library doesn\'t support cipher and/or hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::log('No encryption key set in TYPO3 configuration', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (
             empty($encrypted)
             || strlen($encrypted) < openssl_cipher_iv_length(self::$cipherAlgorithm)
         ) {
             self::log('Invalid parameters given for decryption', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Split initialisation vector and encrypted data.
         $binary = base64_decode($encrypted);
         $iv = substr($binary, 0, openssl_cipher_iv_length(self::$cipherAlgorithm));
         $data = substr($binary, openssl_cipher_iv_length(self::$cipherAlgorithm));
-        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, true);
+        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, TRUE);
         // Decrypt data.
         $decrypted = openssl_decrypt($data, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         return $decrypted;
@@ -216,13 +216,13 @@ 
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
-            return false;
+            return FALSE;
         }
 
         // Turn off libxml's error logging.
-        $libxmlErrors = libxml_use_internal_errors(true);
+        $libxmlErrors = libxml_use_internal_errors(TRUE);
         // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
-        $previousValueOfEntityLoader = libxml_disable_entity_loader(true);
+        $previousValueOfEntityLoader = libxml_disable_entity_loader(TRUE);
         // Try to load XML from file.
         $xml = simplexml_load_string($content);
         // reset entity loader setting
@@ -276,9 +276,9 @@ 
      */
     public static function digest($string)
     {
-        if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
+        if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Hash string.
         $hashed = openssl_digest($string, self::$hashAlgorithm);
@@ -297,23 +297,23 @@ 
     public static function encrypt($string)
     {
         if (
-            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(true))
-            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(true))
+            !in_array(self::$cipherAlgorithm, openssl_get_cipher_methods(TRUE))
+            || !in_array(self::$hashAlgorithm, openssl_get_md_methods(TRUE))
         ) {
             self::log('OpenSSL library doesn\'t support cipher and/or hash algorithm', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::log('No encryption key set in TYPO3 configuration', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Generate random initialisation vector.
         $iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length(self::$cipherAlgorithm));
-        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, true);
+        $key = openssl_digest($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], self::$hashAlgorithm, TRUE);
         // Encrypt data.
         $encrypted = openssl_encrypt($string, self::$cipherAlgorithm, $key, OPENSSL_RAW_DATA, $iv);
         // Merge initialisation vector and encrypted data.
-        if ($encrypted !== false) {
+        if ($encrypted !== FALSE) {
             $encrypted = base64_encode($iv . $encrypted);
         }
         return $encrypted;
@@ -458,7 +458,7 @@ 
                 $lang = $languageService->getLLL($isoCode, $iso639);
             }
         } elseif (\TYPO3_MODE === 'BE') {
-            $iso639 = $languageService->includeLLFile($file, false, true);
+            $iso639 = $languageService->includeLLFile($file, FALSE, TRUE);
             if (!empty($iso639['default'][$isoCode])) {
                 $lang = $languageService->getLLL($isoCode, $iso639);
             }
@@ -605,7 +605,7 @@ 
     public static function isValidHttpUrl($url)
     {
         if (!GeneralUtility::isValidUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         $parsed = parse_url($url);
@@ -629,7 +629,7 @@ 
      *
      * @return array Merged array
      */
-    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = true, $includeEmptyValues = true, $enableUnsetFeature = true)
+    public static function mergeRecursiveWithOverrule(array $original, array $overrule, $addKeys = TRUE, $includeEmptyValues = TRUE, $enableUnsetFeature = TRUE)
     {
         \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($original, $overrule, $addKeys, $includeEmptyValues, $enableUnsetFeature);
         return $original;
@@ -701,7 +701,7 @@ 
             ->where(
                 $queryBuilder->expr()->eq($table . '.pid', $pid),
                 $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
-                self::whereExpression($table, true)
+                self::whereExpression($table, TRUE)
             )
             ->setMaxResults(1)
             ->execute();
@@ -719,7 +719,7 @@ 
                     $queryBuilder->expr()->eq($table . '.pid', $pid),
                     $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
                     $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($languageAspect->getContentId())),
-                    self::whereExpression($table, true)
+                    self::whereExpression($table, TRUE)
                 )
                 ->setMaxResults(1)
                 ->execute();
@@ -754,7 +754,7 @@ 
                     ->where(
                         $queryBuilder->expr()->eq($table . '.pid', $pid),
                         $additionalWhere,
-                        self::whereExpression($table, true)
+                        self::whereExpression($table, TRUE)
                     )
                     ->setMaxResults(10000)
                     ->execute();
@@ -794,7 +794,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = false)
+    public static function whereExpression($table, $showHidden = FALSE)
     {
         if (\TYPO3_MODE === 'FE') {
             // Should we ignore the record's hidden flag?
@@ -863,13 +863,13 @@ 
         $frameworkConfiguration = $configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
 
         $extbaseClassmap = &$frameworkConfiguration['persistence']['classes'];
-        if ($extbaseClassmap === null) {
+        if ($extbaseClassmap === NULL) {
             $extbaseClassmap = [];
         }
 
         foreach ($classes as $className => $classConfig) {
             $extbaseClass = &$extbaseClassmap[$className];
-            if ($extbaseClass === null) {
+            if ($extbaseClass === NULL) {
                 $extbaseClass = [];
             }
             if (!isset($extbaseClass['mapping'])) {
@@ -895,7 +895,7 @@ 
     public static function getUrl(string $url)
     {
         if (!Helper::isValidHttpUrl($url)) {
-            return false;
+            return FALSE;
         }
 
         // Get extension configuration.

Classes/Command/BaseCommand.php

Spacing +1 added lines, -1 removed lines

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

Braces +4 added lines, -8 removed lines

@@ -38,8 +38,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class BaseCommand extends Command
-{
+class BaseCommand extends Command {
     /**
      * @var CollectionRepository
      */
@@ -79,8 +78,7 @@ 
      *
      * @return bool
      */
-    protected function initializeRepositories($storagePid)
-    {
+    protected function initializeRepositories($storagePid) {
         if (MathUtility::canBeInterpretedAsInteger($storagePid)) {
             $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
             $frameworkConfiguration = $configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
@@ -159,8 +157,7 @@ 
      *
      * @return bool true on success
      */
-    protected function saveToDatabase(Document $document)
-    {
+    protected function saveToDatabase(Document $document) {
         $success = false;
 
         $doc = $document->getDoc();
@@ -268,8 +265,7 @@ 
      *
      * @return int The parent document's id.
      */
-    protected function getParentDocumentUidForSaving(Document $document)
-    {
+    protected function getParentDocumentUidForSaving(Document $document) {
         $doc = $document->getDoc();
 
         if ($doc !== null) {

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

@@ -96,11 +96,11 @@ 
             $this->libraryRepository = $objectManager->get(LibraryRepository::class);
             $this->structureRepository = $objectManager->get(StructureRepository::class);
         } else {
-            return false;
+            return FALSE;
         }
         $this->storagePid = MathUtility::forceIntegerInRange((int) $storagePid, 0);
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -161,10 +161,10 @@ 
      */
     protected function saveToDatabase(Document $document)
     {
-        $success = false;
+        $success = FALSE;
 
         $doc = $document->getDoc();
-        if ($doc === null) {
+        if ($doc === NULL) {
             return $success;
         }
         $doc->cPid = $this->storagePid;
@@ -244,7 +244,7 @@ 
             $document->setPartof($this->getParentDocumentUidForSaving($document));
         }
 
-        if ($document->getUid() === null) {
+        if ($document->getUid() === NULL) {
             // new document
             $this->documentRepository->add($document);
         } else {
@@ -255,7 +255,7 @@ 
         $persistenceManager = GeneralUtility::makeInstance(PersistenceManager::class);
         $persistenceManager->persistAll();
 
-        $success = true;
+        $success = TRUE;
 
         return $success;
     }
@@ -272,7 +272,7 @@ 
     {
         $doc = $document->getDoc();
 
-        if ($doc !== null) {
+        if ($doc !== NULL) {
             // Get the closest ancestor of the current document which has a MPTR child.
             $parentMptr = $doc->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $doc->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
             if (!empty($parentMptr)) {
@@ -284,7 +284,7 @@ 
                 if ($parentDoc->recordId) {
                     $parentDocument = $this->documentRepository->findOneByRecordId($parentDoc->recordId);
 
-                    if ($parentDocument === null) {
+                    if ($parentDocument === NULL) {
                         // create new Document object
                         $parentDocument = GeneralUtility::makeInstance(Document::class);
                     }
@@ -296,7 +296,7 @@ 
 
                     $success = $this->saveToDatabase($parentDocument);
 
-                    if ($success === true) {
+                    if ($success === TRUE) {
                         // add to index
                         Indexer::add($parentDocument);
                         return $parentDocument->getUid();

Classes/Command/IndexCommand.php

Spacing +8 added lines, -8 removed lines

@@ -96,7 +96,7 @@ 
         $this->initializeRepositories($input->getOption('pid'));
 
         if ($this->storagePid == 0) {
-            $io->error('ERROR: No valid PID (' . $this->storagePid . ') given.');
+            $io->error('ERROR: No valid PID ('.$this->storagePid.') given.');
             exit(1);
         }
 
@@ -111,13 +111,13 @@ 
             if (empty($solrCoreUid) || !in_array($solrCoreUid, $allSolrCores)) {
                 $output_solrCores = [];
                 foreach ($allSolrCores as $index_name => $uid) {
-                    $output_solrCores[] = $uid . ' : ' . $index_name;
+                    $output_solrCores[] = $uid.' : '.$index_name;
                 }
                 if (empty($output_solrCores)) {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. No valid cores found on PID ' . $this->storagePid . ".\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. No valid cores found on PID '.$this->storagePid.".\n");
                     exit(1);
                 } else {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. ' . "Valid cores are (<uid>:<index_name>):\n" . implode("\n", $output_solrCores) . "\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. '."Valid cores are (<uid>:<index_name>):\n".implode("\n", $output_solrCores)."\n");
                     exit(1);
                 }
             }
@@ -157,7 +157,7 @@ 
             $document = $this->documentRepository->findByUid($input->getOption('doc'));
 
             if ($document === null) {
-                $io->error('ERROR: Document with UID "' . $input->getOption('doc') . '" could not be found on PID ' . $this->storagePid . ' .');
+                $io->error('ERROR: Document with UID "'.$input->getOption('doc').'" could not be found on PID '.$this->storagePid.' .');
                 exit(1);
             } else {
                 $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
@@ -182,17 +182,17 @@ 
         }
 
         if ($doc === null) {
-            $io->error('ERROR: Document "' . $input->getOption('doc') . '" could not be loaded.');
+            $io->error('ERROR: Document "'.$input->getOption('doc').'" could not be loaded.');
             exit(1);
         }
 
         $document->setSolrcore($solrCoreUid);
 
         if ($dryRun) {
-            $io->section('DRY RUN: Would index ' . $document->getUid() . ' ("' . $document->getLocation() . '") on PID ' . $this->storagePid . ' and Solr core ' . $solrCoreUid . '.');
+            $io->section('DRY RUN: Would index '.$document->getUid().' ("'.$document->getLocation().'") on PID '.$this->storagePid.' and Solr core '.$solrCoreUid.'.');
         } else {
             if ($io->isVerbose()) {
-                $io->section('Indexing ' . $document->getUid() . ' ("' . $document->getLocation() . '") on PID ' . $this->storagePid . ' and Solr core ' . $solrCoreUid . '.');
+                $io->section('Indexing '.$document->getUid().' ("'.$document->getLocation().'") on PID '.$this->storagePid.' and Solr core '.$solrCoreUid.'.');
             }
             $document->setDoc($doc);
             // save to database

Braces +3 added lines, -6 removed lines

@@ -33,16 +33,14 @@ 
  * @subpackage dlf
  * @access public
  */
-class IndexCommand extends BaseCommand
-{
+class IndexCommand extends BaseCommand {
 
     /**
      * Configure the command by defining the name, options and arguments
      *
      * @return void
      */
-    public function configure()
-    {
+    public function configure() {
         $this
             ->setDescription('Index single document into database and Solr.')
             ->setHelp('')
@@ -86,8 +84,7 @@ 
      *
      * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
+    protected function execute(InputInterface $input, OutputInterface $output) {
         $dryRun = $input->getOption('dry-run') != false ? true : false;
 
         $io = new SymfonyStyle($input, $output);

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

@@ -48,7 +48,7 @@ 
             ->setHelp('')
             ->addOption(
                 'dry-run',
-                null,
+                NULL,
                 InputOption::VALUE_NONE,
                 'If this option is set, the files will not actually be processed but the location URI is shown.'
             )
@@ -88,7 +88,7 @@ 
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $dryRun = $input->getOption('dry-run') != false ? true : false;
+        $dryRun = $input->getOption('dry-run') != FALSE ? TRUE : FALSE;
 
         $io = new SymfonyStyle($input, $output);
         $io->title($this->getDescription());
@@ -145,32 +145,32 @@ 
                 $this->owner = $this->libraryRepository->findOneByIndexName((string) $input->getOption('owner'));
             }
         } else {
-            $this->owner = null;
+            $this->owner = NULL;
         }
 
-        $document = null;
-        $doc = null;
+        $document = NULL;
+        $doc = NULL;
 
         // Try to find existing document in database
         if (MathUtility::canBeInterpretedAsInteger($input->getOption('doc'))) {
 
             $document = $this->documentRepository->findByUid($input->getOption('doc'));
 
-            if ($document === null) {
+            if ($document === NULL) {
                 $io->error('ERROR: Document with UID "' . $input->getOption('doc') . '" could not be found on PID ' . $this->storagePid . ' .');
                 exit(1);
             } else {
-                $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
+                $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], TRUE);
             }
 
         } else if (GeneralUtility::isValidUrl($input->getOption('doc'))) {
-            $doc = Doc::getInstance($input->getOption('doc'), ['storagePid' => $this->storagePid], true);
+            $doc = Doc::getInstance($input->getOption('doc'), ['storagePid' => $this->storagePid], TRUE);
 
             if ($doc->recordId) {
                 $document = $this->documentRepository->findOneByRecordId($doc->recordId);
             }
 
-            if ($document === null) {
+            if ($document === NULL) {
                 // create new Document object
                 $document = GeneralUtility::makeInstance(Document::class);
             }
@@ -181,7 +181,7 @@ 
             }
         }
 
-        if ($doc === null) {
+        if ($doc === NULL) {
             $io->error('ERROR: Document "' . $input->getOption('doc') . '" could not be loaded.');
             exit(1);
         }

Classes/Command/ReindexCommand.php

Spacing +7 added lines, -7 removed lines

@@ -100,7 +100,7 @@ 
         $this->initializeRepositories($input->getOption('pid'));
 
         if ($this->storagePid == 0) {
-            $io->error('ERROR: No valid PID (' . $this->storagePid . ') given.');
+            $io->error('ERROR: No valid PID ('.$this->storagePid.') given.');
             exit(1);
         }
 
@@ -115,13 +115,13 @@ 
             if (empty($solrCoreUid) || !in_array($solrCoreUid, $allSolrCores)) {
                 $output_solrCores = [];
                 foreach ($allSolrCores as $index_name => $uid) {
-                    $output_solrCores[] = $uid . ' : ' . $index_name;
+                    $output_solrCores[] = $uid.' : '.$index_name;
                 }
                 if (empty($output_solrCores)) {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. No valid cores found on PID ' . $this->storagePid . ".\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. No valid cores found on PID '.$this->storagePid.".\n");
                     exit(1);
                 } else {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. ' . "Valid cores are (<uid>:<index_name>):\n" . implode("\n", $output_solrCores) . "\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. '."Valid cores are (<uid>:<index_name>):\n".implode("\n", $output_solrCores)."\n");
                     exit(1);
                 }
             }
@@ -163,15 +163,15 @@ 
             $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
 
             if ($doc === null) {
-                $io->warning('WARNING: Document "' . $document->getLocation() . '" could not be loaded. Skip to next document.');
+                $io->warning('WARNING: Document "'.$document->getLocation().'" could not be loaded. Skip to next document.');
                 continue;
             }
 
             if ($dryRun) {
-                $io->writeln('DRY RUN: Would index ' . ($id + 1) . '/' . count($documents) . '  with UID "' . $document->getUid() . '" ("' . $document->getLocation() . '") on PID ' . $this->storagePid . ' and Solr core ' . $solrCoreUid . '.');
+                $io->writeln('DRY RUN: Would index '.($id + 1).'/'.count($documents).'  with UID "'.$document->getUid().'" ("'.$document->getLocation().'") on PID '.$this->storagePid.' and Solr core '.$solrCoreUid.'.');
             } else {
                 if ($io->isVerbose()) {
-                    $io->writeln(date('Y-m-d H:i:s') . ' Indexing ' . ($id + 1) . '/' . count($documents) . ' with UID "' . $document->getUid() . '" ("' . $document->getLocation() . '") on PID ' . $this->storagePid . ' and Solr core ' . $solrCoreUid . '.');
+                    $io->writeln(date('Y-m-d H:i:s').' Indexing '.($id + 1).'/'.count($documents).' with UID "'.$document->getUid().'" ("'.$document->getLocation().'") on PID '.$this->storagePid.' and Solr core '.$solrCoreUid.'.');
                 }
                 $document->setDoc($doc);
                 // save to database

Braces +3 added lines, -6 removed lines

@@ -32,15 +32,13 @@ 
  * @subpackage dlf
  * @access public
  */
-class ReindexCommand extends BaseCommand
-{
+class ReindexCommand extends BaseCommand {
     /**
      * Configure the command by defining the name, options and arguments
      *
      * @return void
      */
-    public function configure()
-    {
+    public function configure() {
         $this
             ->setDescription('Reindex a collection into database and Solr.')
             ->setHelp('')
@@ -90,8 +88,7 @@ 
      *
      * @return int
      */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
+    protected function execute(InputInterface $input, OutputInterface $output) {
         $dryRun = $input->getOption('dry-run') != false ? true : false;
 
         $io = new SymfonyStyle($input, $output);

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

@@ -46,7 +46,7 @@ 
             ->setHelp('')
             ->addOption(
                 'dry-run',
-                null,
+                NULL,
                 InputOption::VALUE_NONE,
                 'If this option is set, the files will not actually be processed but the location URI is shown.'
             )
@@ -92,7 +92,7 @@ 
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $dryRun = $input->getOption('dry-run') != false ? true : false;
+        $dryRun = $input->getOption('dry-run') != FALSE ? TRUE : FALSE;
 
         $io = new SymfonyStyle($input, $output);
         $io->title($this->getDescription());
@@ -137,7 +137,7 @@ 
                 $this->owner = $this->libraryRepository->findOneByIndexName((string) $input->getOption('owner'));
             }
         } else {
-            $this->owner = null;
+            $this->owner = NULL;
         }
 
         if (!empty($input->getOption('all'))) {
@@ -148,21 +148,21 @@ 
             && !is_array($input->getOption('coll'))
         ) {
             // "coll" may be a single integer or a comma-separated list of integers.
-            if (empty(array_filter(GeneralUtility::intExplode(',', $input->getOption('coll'), true)))) {
+            if (empty(array_filter(GeneralUtility::intExplode(',', $input->getOption('coll'), TRUE)))) {
                 $io->error('ERROR: Parameter --coll|-c is not a valid comma-separated list of collection UIDs.');
                 exit(1);
             }
             // Get all documents of given collections.
-            $documents = $this->documentRepository->findAllByCollectionsLimited(GeneralUtility::intExplode(',', $input->getOption('coll'), true), 0);
+            $documents = $this->documentRepository->findAllByCollectionsLimited(GeneralUtility::intExplode(',', $input->getOption('coll'), TRUE), 0);
         } else {
             $io->error('ERROR: One of parameters --all|-a or --coll|-c must be given.');
             exit(1);
         }
 
         foreach ($documents as $id => $document) {
-            $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], true);
+            $doc = Doc::getInstance($document->getLocation(), ['storagePid' => $this->storagePid], TRUE);
 
-            if ($doc === null) {
+            if ($doc === NULL) {
                 $io->warning('WARNING: Document "' . $document->getLocation() . '" could not be loaded. Skip to next document.');
                 continue;
             }