Erikmitk / kitodo-presentation

Classes/Common/Solr.php

Spacing +11 added lines, -11 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);
             }
@@ -343,7 +343,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 {
@@ -418,7 +418,7 @@ 
         // Set filter query to just get toplevel documents.
         $params['filterquery'][] = ['query' => 'toplevel:true'];
         // Set join query to get all documents with the same uids.
-        $params['query'] = '{!join from=uid to=uid}' . $params['query'];
+        $params['query'] = '{!join from=uid to=uid}'.$params['query'];
         // Perform search to determine the total number of toplevel hits and fetch the required rows.
         $selectQuery = $this->service->createSelect($params);
         $results = $this->service->select($selectQuery);
@@ -475,7 +475,7 @@ 
         // Set query.
         $parameters['query'] = $query;
         // 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) {
@@ -606,12 +606,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();
@@ -644,12 +644,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);
         }
@@ -686,7 +686,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 +22 added lines, -44 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.
@@ -395,8 +387,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\DocumentList The result list
      */
-    public function search()
-    {
+    public function search() {
         $toplevel = [];
         // Take over query parameters.
         $params = $this->params;
@@ -465,8 +456,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    public function search_raw($query = '', $parameters = [])
-    {
+    public function search_raw($query = '', $parameters = []) {
         // Set additional query parameters.
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
@@ -498,8 +488,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;
     }
 
@@ -510,8 +499,7 @@ 
      *
      * @return int The max number of results
      */
-    protected function _getLimit()
-    {
+    protected function _getLimit() {
         return $this->limit;
     }
 
@@ -522,8 +510,7 @@ 
      *
      * @return int Total number of hits for last search
      */
-    protected function _getNumberOfHits()
-    {
+    protected function _getNumberOfHits() {
         return $this->numberOfHits;
     }
 
@@ -534,8 +521,7 @@ 
      *
      * @return bool Is the search instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -546,8 +532,7 @@ 
      *
      * @return \Solarium\Client Apache Solr service object
      */
-    protected function _getService()
-    {
+    protected function _getService() {
         return $this->service;
     }
 
@@ -560,8 +545,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -574,8 +558,7 @@ 
      *
      * @return void
      */
-    protected function _setLimit($value)
-    {
+    protected function _setLimit($value) {
         $this->limit = max(intval($value), 0);
     }
 
@@ -588,8 +571,7 @@ 
      *
      * @return void
      */
-    protected function _setParams(array $value)
-    {
+    protected function _setParams(array $value) {
         $this->params = $value;
     }
 
@@ -602,8 +584,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -625,8 +606,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));
     }
 
@@ -640,8 +620,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -662,8 +641,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 +10 added lines, -10 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);
         }
@@ -447,7 +447,7 @@ 
                 'core' => $this->core,
                 'pid' => $this->cPid,
                 'order' => 'score',
-                'order.asc' => true,
+                'order.asc' => TRUE,
                 'numberOfHits' => $this->numberOfHits,
                 'numberOfToplevelHits' => $numberOfToplevelHits
             ]
@@ -473,10 +473,10 @@ 
         // Set query.
         $parameters['query'] = $query;
         // 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) {
@@ -702,7 +702,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);
@@ -710,7 +710,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
@@ -724,7 +724,7 @@ 
                     }
                 }
                 // Instantiation successful!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
         } catch (\Exception $e) {
             // Nothing to do here.

Classes/Common/Indexer.php

Spacing +15 added lines, -15 removed lines

@@ -102,7 +102,7 @@ 
                 if ($parent->ready) {
                     $success = self::add($parent, $core);
                 } else {
-                    Helper::log('Could not load parent document with UID ' . $doc->parentId, LOG_SEVERITY_ERROR);
+                    Helper::log('Could not load parent document with UID '.$doc->parentId, LOG_SEVERITY_ERROR);
                     return false;
                 }
             }
@@ -111,7 +111,7 @@ 
                 self::$processedDocs[] = $doc->uid;
                 // Delete old Solr documents.
                 $updateQuery = self::$solr->service->createUpdate();
-                $updateQuery->addDeleteQuery('uid:' . $doc->uid);
+                $updateQuery->addDeleteQuery('uid:'.$doc->uid);
                 self::$solr->service->update($updateQuery);
 
                 // Index every logical unit as separate Solr document.
@@ -176,14 +176,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         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 {
@@ -216,7 +216,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.
@@ -225,7 +225,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;
     }
 
@@ -333,7 +333,7 @@ 
             $updateQuery = self::$solr->service->createUpdate();
             $solrDoc = $updateQuery->createDocument();
             // Create unique identifier from document's UID and unit's XML ID.
-            $solrDoc->setField('id', $doc->uid . $logicalUnit['id']);
+            $solrDoc->setField('id', $doc->uid.$logicalUnit['id']);
             $solrDoc->setField('uid', $doc->uid);
             $solrDoc->setField('pid', $doc->pid);
             if (MathUtility::canBeInterpretedAsInteger($logicalUnit['points'])) {
@@ -374,11 +374,11 @@ 
                     $solrDoc->setField(self::getIndexFieldName($index_name, $doc->pid), $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);
@@ -403,14 +403,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         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;
             }
         }
@@ -448,7 +448,7 @@ 
             $updateQuery = self::$solr->service->createUpdate();
             $solrDoc = $updateQuery->createDocument();
             // Create unique identifier from document's UID and unit's XML ID.
-            $solrDoc->setField('id', $doc->uid . $physicalUnit['id']);
+            $solrDoc->setField('id', $doc->uid.$physicalUnit['id']);
             $solrDoc->setField('uid', $doc->uid);
             $solrDoc->setField('pid', $doc->pid);
             $solrDoc->setField('page', $page);
@@ -483,7 +483,7 @@ 
                             }
                         }
                         // Add facets to index.
-                        $solrDoc->setField($index_name . '_faceting', $data);
+                        $solrDoc->setField($index_name.'_faceting', $data);
                     }
                 }
             }
@@ -500,14 +500,14 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.solrException', true).'<br />'.htmlspecialchars($e->getMessage()),
                         Helper::getMessage('flash.error', true),
                         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;
             }
         }

Braces +8 added lines, -16 removed lines

@@ -28,8 +28,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * The extension key
      *
@@ -90,8 +89,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public static function add(Document &$doc, $core = 0)
-    {
+    public static function add(Document &$doc, $core = 0) {
         if (in_array($doc->uid, self::$processedDocs)) {
             return true;
         } elseif (self::solrConnect($core, $doc->pid)) {
@@ -211,8 +209,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) {
@@ -238,8 +235,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');
@@ -309,8 +305,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processLogical(Document &$doc, array $logicalUnit)
-    {
+    protected static function processLogical(Document &$doc, array $logicalUnit) {
         $success = true;
         // Get metadata for logical unit.
         $metadata = $doc->metadataArray[$logicalUnit['id']];
@@ -439,8 +434,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processPhysical(Document &$doc, $page, array $physicalUnit)
-    {
+    protected static function processPhysical(Document &$doc, $page, array $physicalUnit) {
         if ($doc->hasFulltext && $fullText = $doc->getFullText($physicalUnit['id'])) {
             // Read extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -524,8 +518,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.
@@ -548,8 +541,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

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

@@ -62,7 +62,7 @@ 
      * @var bool
      * @access protected
      */
-    protected static $fieldsLoaded = false;
+    protected static $fieldsLoaded = FALSE;
 
     /**
      * List of already processed documents
@@ -93,17 +93,17 @@ 
     public static function add(Document &$doc, $core = 0)
     {
         if (in_array($doc->uid, self::$processedDocs)) {
-            return true;
+            return TRUE;
         } elseif (self::solrConnect($core, $doc->pid)) {
-            $success = true;
+            $success = TRUE;
             // Handle multi-volume documents.
             if ($doc->parentId) {
-                $parent = Document::getInstance($doc->parentId, 0, true);
+                $parent = Document::getInstance($doc->parentId, 0, TRUE);
                 if ($parent->ready) {
                     $success = self::add($parent, $core);
                 } else {
                     Helper::log('Could not load parent document with UID ' . $doc->parentId, LOG_SEVERITY_ERROR);
-                    return false;
+                    return FALSE;
                 }
             }
             try {
@@ -157,17 +157,17 @@ 
                     if ($success) {
                         Helper::addMessage(
                             htmlspecialchars(sprintf(Helper::getMessage('flash.documentIndexed'), $resArray['title'], $doc->uid)),
-                            Helper::getMessage('flash.done', true),
+                            Helper::getMessage('flash.done', TRUE),
                             FlashMessage::OK,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     } else {
                         Helper::addMessage(
                             htmlspecialchars(sprintf(Helper::getMessage('flash.documentNotIndexed'), $resArray['title'], $doc->uid)),
-                            Helper::getMessage('flash.error', true),
+                            Helper::getMessage('flash.error', TRUE),
                             FlashMessage::ERROR,
-                            true,
+                            TRUE,
                             'core.template.flashMessages'
                         );
                     }
@@ -176,28 +176,28 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         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)) {
                 Helper::addMessage(
-                    Helper::getMessage('flash.solrNoConnection', true),
-                    Helper::getMessage('flash.warning', true),
+                    Helper::getMessage('flash.solrNoConnection', TRUE),
+                    Helper::getMessage('flash.warning', TRUE),
                     FlashMessage::WARNING,
-                    true,
+                    TRUE,
                     'core.template.flashMessages'
                 );
             }
             Helper::log('Could not connect to Apache Solr server', LOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -292,10 +292,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;
         }
     }
 
@@ -311,7 +311,7 @@ 
      */
     protected static function processLogical(Document &$doc, array $logicalUnit)
     {
-        $success = true;
+        $success = TRUE;
         // Get metadata for logical unit.
         $metadata = $doc->metadataArray[$logicalUnit['id']];
         if (!empty($metadata)) {
@@ -348,7 +348,7 @@ 
             $solrDoc->setField('root', $doc->rootId);
             $solrDoc->setField('sid', $logicalUnit['id']);
             // 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('type', $logicalUnit['type'], self::$fields['fieldboost']['type']);
             $solrDoc->setField('title', $metadata['title'][0], self::$fields['fieldboost']['title']);
             $solrDoc->setField('volume', $metadata['volume'][0], self::$fields['fieldboost']['volume']);
@@ -403,15 +403,15 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         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...
@@ -462,7 +462,7 @@ 
             $solrDoc->setField('partof', $doc->parentId);
             $solrDoc->setField('root', $doc->rootId);
             $solrDoc->setField('sid', $physicalUnit['id']);
-            $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']);
 
@@ -500,18 +500,18 @@ 
             } catch (\Exception $e) {
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
-                        Helper::getMessage('flash.solrException', true) . '<br />' . htmlspecialchars($e->getMessage()),
-                        Helper::getMessage('flash.error', true),
+                        Helper::getMessage('flash.solrException', TRUE) . '<br />' . htmlspecialchars($e->getMessage()),
+                        Helper::getMessage('flash.error', TRUE),
                         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;
     }
 
     /**
@@ -537,10 +537,10 @@ 
                     self::loadIndexConf($pid);
                 }
             } else {
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**

Classes/Common/Document.php

Spacing +16 added lines, -16 removed lines

@@ -671,14 +671,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?
@@ -697,12 +697,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;
     }
@@ -770,10 +770,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;
     }
@@ -908,7 +908,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;
     }
@@ -1018,7 +1018,7 @@ 
             // Retain current PID.
             $pid = $this->pid;
         } elseif (!$pid) {
-            $this->logger->error('Invalid PID ' . $pid . ' for document saving');
+            $this->logger->error('Invalid PID '.$pid.' for document saving');
             return false;
         }
         // Set PID for metadata definitions.
@@ -1055,7 +1055,7 @@ 
         if ($resArray = $result->fetch()) {
             $structure = $resArray['uid'];
         } else {
-            $this->logger->error('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"');
+            $this->logger->error('Could not identify document/structure type "'.$queryBuilder->expr()->literal($metadata['type'][0]).'"');
             return false;
         }
         $metadata['type'][0] = $structure;
@@ -1304,7 +1304,7 @@ 
         if ($core) {
             return Indexer::add($this, $core);
         } else {
-            $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
+            $this->logger->notice('Invalid UID "'.$core.'" for Solr core');
             return false;
         }
     }
@@ -1382,7 +1382,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 (
@@ -1710,7 +1710,7 @@ 
             // Document ready!
             $this->ready = true;
         } else {
-            $this->logger->error('No document with UID ' . $uid . ' found or document not accessible');
+            $this->logger->error('No document with UID '.$uid.' found or document not accessible');
         }
     }
 
@@ -1725,12 +1725,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();
@@ -1763,12 +1763,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

@@ -48,8 +48,7 @@ 
  * @property-read mixed $uid This holds the UID or the URL of the document
  * @abstract
  */
-abstract class Document
-{
+abstract class Document {
     /**
      * This holds the logger
      *
@@ -341,8 +340,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -607,8 +605,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -653,8 +650,7 @@ 
      *
      * @return string The OCR full text
      */
-    protected function getFullTextFromXml($id)
-    {
+    protected function getFullTextFromXml($id) {
         $fullText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -716,8 +712,7 @@ 
      *
      * @return string The format of the OCR full text
      */
-    private function getTextFormat($fileContent)
-    {
+    private function getTextFormat($fileContent) {
         // Get the root element's name as text format.
         return strtoupper(Helper::getXmlFileAsString($fileContent)->getName());
     }
@@ -734,8 +729,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);
@@ -787,8 +781,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) {
@@ -821,8 +814,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;
@@ -844,8 +836,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);
     }
 
@@ -895,8 +886,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)) {
             // Load extension configuration
@@ -929,8 +919,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -970,8 +959,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?
@@ -1000,8 +988,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
-    {
+    public function save($pid = 0, $core = 0, $owner = null) {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
             return false;
@@ -1329,8 +1316,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -1341,8 +1327,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -1354,8 +1339,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -1377,8 +1361,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) {
@@ -1403,8 +1386,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -1416,8 +1398,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1440,8 +1421,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.
@@ -1457,8 +1437,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1469,8 +1448,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1481,8 +1459,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1493,8 +1470,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, $this->pid);
@@ -1524,8 +1500,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.
@@ -1566,8 +1541,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1580,8 +1554,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1592,8 +1565,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -1610,8 +1582,7 @@ 
      *
      * @return void
      */
-    protected function __construct($uid, $pid, $preloadedDocument)
-    {
+    protected function __construct($uid, $pid, $preloadedDocument) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
         $location = '';
@@ -1723,8 +1694,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1746,8 +1716,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));
     }
 
@@ -1761,8 +1730,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)

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

@@ -103,7 +103,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $formatsLoaded = false;
+    protected $formatsLoaded = FALSE;
 
     /**
      * Are there any fulltext files available? This also includes IIIF text annotations
@@ -113,7 +113,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $hasFulltext = false;
+    protected $hasFulltext = FALSE;
 
     /**
      * Last searched logical and physical page
@@ -121,7 +121,7 @@ 
      * @var array
      * @access protected
      */
-    protected $lastSearchedPhysicalPage = ['logicalPage' => null, 'physicalPage' => null];
+    protected $lastSearchedPhysicalPage = ['logicalPage' => NULL, 'physicalPage' => NULL];
 
     /**
      * This holds the documents location
@@ -155,7 +155,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $metadataArrayLoaded = false;
+    protected $metadataArrayLoaded = FALSE;
 
     /**
      * The holds the total number of pages
@@ -196,7 +196,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $physicalStructureLoaded = false;
+    protected $physicalStructureLoaded = FALSE;
 
     /**
      * This holds the PID of the document or zero if not in database
@@ -221,7 +221,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * The METS file's / IIIF manifest's record identifier
@@ -255,7 +255,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $rootIdLoaded = false;
+    protected $rootIdLoaded = FALSE;
 
     /**
      * This holds the smLinks between logical and physical structMap
@@ -272,7 +272,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $smLinksLoaded = false;
+    protected $smLinksLoaded = FALSE;
 
     /**
      * This holds the logical structure
@@ -289,7 +289,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $tableOfContentsLoaded = false;
+    protected $tableOfContentsLoaded = FALSE;
 
     /**
      * This holds the document's thumbnail location
@@ -306,7 +306,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)
@@ -423,7 +423,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Document Instance of this class, either MetsDocument or IiifManifest
      */
-    public static function &getInstance($uid, $pid = 0, $forceReload = false)
+    public static function &getInstance($uid, $pid = 0, $forceReload = FALSE)
     {
         // Sanitize input.
         $pid = max(intval($pid), 0);
@@ -463,10 +463,10 @@ 
             }
         }
         // Create new instance depending on format (METS or IIIF) ...
-        $instance = null;
-        $documentFormat = null;
-        $xml = null;
-        $iiif = null;
+        $instance = NULL;
+        $documentFormat = NULL;
+        $xml = NULL;
+        $iiif = NULL;
         // Try to get document format from database
         if (MathUtility::canBeInterpretedAsInteger($uid)) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -515,17 +515,17 @@ 
                     @ini_set('user_agent', $extConf['useragent']);
                 }
                 $content = GeneralUtility::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) {
                             // Load plugin configuration.
                             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
                             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
@@ -580,7 +580,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
@@ -617,7 +617,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;
@@ -668,7 +668,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 . '"');
@@ -734,7 +734,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.
@@ -767,7 +767,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);
@@ -828,12 +828,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;
     }
 
     /**
@@ -910,7 +910,7 @@ 
         } else {
             $this->logger->error('Invalid file location "' . $location . '" for document loading');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -957,7 +957,7 @@ 
                     'class' => $resArray['class']
                 ];
             }
-            $this->formatsLoaded = true;
+            $this->formatsLoaded = TRUE;
         }
     }
 
@@ -1000,11 +1000,11 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
+    public function save($pid = 0, $core = 0, $owner = NULL)
     {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
-            return false;
+            return FALSE;
         }
         // Make sure $pid is a non-negative integer.
         $pid = max(intval($pid), 0);
@@ -1019,7 +1019,7 @@ 
             $pid = $this->pid;
         } elseif (!$pid) {
             $this->logger->error('Invalid PID ' . $pid . ' for document saving');
-            return false;
+            return FALSE;
         }
         // Set PID for metadata definitions.
         $this->cPid = $pid;
@@ -1032,7 +1032,7 @@ 
         // Check for record identifier.
         if (empty($metadata['record_id'][0])) {
             $this->logger->error('No record identifier found to avoid duplication');
-            return false;
+            return FALSE;
         }
         // Load plugin configuration.
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -1056,7 +1056,7 @@ 
             $structure = $resArray['uid'];
         } else {
             $this->logger->error('Could not identify document/structure type "' . $queryBuilder->expr()->literal($metadata['type'][0]) . '"');
-            return false;
+            return FALSE;
         }
         $metadata['type'][0] = $structure;
 
@@ -1116,9 +1116,9 @@ 
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
                         htmlspecialchars(sprintf(Helper::getMessage('flash.newCollection'), $collection, $substUid[$collNewUid])),
-                        Helper::getMessage('flash.attention', true),
+                        Helper::getMessage('flash.attention', TRUE),
                         \TYPO3\CMS\Core\Messaging\FlashMessage::INFO,
-                        true
+                        TRUE
                     );
                 }
             }
@@ -1169,9 +1169,9 @@ 
                 if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
                     Helper::addMessage(
                         htmlspecialchars(sprintf(Helper::getMessage('flash.newLibrary'), $owner, $ownerUid)),
-                        Helper::getMessage('flash.attention', true),
+                        Helper::getMessage('flash.attention', TRUE),
                         \TYPO3\CMS\Core\Messaging\FlashMessage::INFO,
-                        true
+                        TRUE
                     );
                 }
             }
@@ -1259,7 +1259,7 @@ 
             'author' => implode('; ', $metadata['author']),
             'year' => implode('; ', $metadata['year']),
             'place' => implode('; ', $metadata['place']),
-            'thumbnail' => $this->_getThumbnail(true),
+            'thumbnail' => $this->_getThumbnail(TRUE),
             'metadata' => serialize($listed),
             'metadata_sorting' => serialize($sortable),
             'structure' => $metadata['type'][0],
@@ -1295,9 +1295,9 @@ 
         if (!(\TYPO3_REQUESTTYPE & \TYPO3_REQUESTTYPE_CLI)) {
             Helper::addMessage(
                 htmlspecialchars(sprintf(Helper::getMessage('flash.documentSaved'), $metadata['title'][0], $this->uid)),
-                Helper::getMessage('flash.done', true),
+                Helper::getMessage('flash.done', TRUE),
                 \TYPO3\CMS\Core\Messaging\FlashMessage::OK,
-                true
+                TRUE
             );
         }
         // Add document to index.
@@ -1305,7 +1305,7 @@ 
             return Indexer::add($this, $core);
         } else {
             $this->logger->notice('Invalid UID "' . $core . '" for Solr core');
-            return false;
+            return FALSE;
         }
     }
 
@@ -1391,7 +1391,7 @@ 
         ) {
             $this->prepareMetadataArray($cPid);
             $this->metadataArray[0] = $cPid;
-            $this->metadataArrayLoaded = true;
+            $this->metadataArrayLoaded = TRUE;
         }
         return $this->metadataArray;
     }
@@ -1500,7 +1500,7 @@ 
                 $parent = self::getInstance($this->parentId, $this->pid);
                 $this->rootId = $parent->rootId;
             }
-            $this->rootIdLoaded = true;
+            $this->rootIdLoaded = TRUE;
         }
         return $this->rootId;
     }
@@ -1529,8 +1529,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;
     }
@@ -1546,7 +1546,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
@@ -1627,7 +1627,7 @@ 
                 && $this->load($uid))) {
                 // Initialize core METS object.
                 $this->init();
-                if ($this->getDocument() !== null) {
+                if ($this->getDocument() !== NULL) {
                     // Cast to string for safety reasons.
                     $location = (string) $uid;
                     $this->establishRecordId($pid);
@@ -1685,30 +1685,30 @@ 
             $this->parentId = $resArray['partof'];
             $this->thumbnail = $resArray['thumbnail'];
             $this->location = $resArray['location'];
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
             // Load XML file if necessary...
             if (
-                $this->getDocument() === null
+                $this->getDocument() === NULL
                 && $this->load($this->location)
             ) {
                 // ...and set some basic properties.
                 $this->init();
             }
             // Do we have a METS / IIIF object now?
-            if ($this->getDocument() !== null) {
+            if ($this->getDocument() !== NULL) {
                 // Set new location if necessary.
                 if (!empty($location)) {
                     $this->location = $location;
                 }
                 // Document ready!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
-        } elseif ($this->getDocument() !== null) {
+        } elseif ($this->getDocument() !== NULL) {
             // Set location as UID for documents not in database.
             $this->uid = $location;
             $this->location = $location;
             // Document ready!
-            $this->ready = true;
+            $this->ready = TRUE;
         } else {
             $this->logger->error('No document with UID ' . $uid . ' found or document not accessible');
         }

Classes/Common/Helper.php

Braces +26 added lines, -52 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -74,8 +73,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(
@@ -100,8 +98,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++) {
@@ -165,8 +162,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))
@@ -204,8 +200,7 @@ 
      *
      * @return mixed
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Turn off libxml's error logging.
         $libxmlErrors = libxml_use_internal_errors(true);
         // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
@@ -230,8 +225,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) {
@@ -261,8 +255,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;
@@ -281,8 +274,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))
@@ -315,8 +307,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -330,8 +321,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.
@@ -352,8 +342,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) {
@@ -374,8 +363,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 (
@@ -427,8 +415,7 @@ 
      *
      * @return string "label" for the given UID
      */
-    public static function getLabelFromUid($uid, $table, $pid = -1)
-    {
+    public static function getLabelFromUid($uid, $table, $pid = -1) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         if (
@@ -478,8 +465,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)) {
@@ -524,8 +510,7 @@ 
      *
      * @return string The translated string or the given key on failure
      */
-    public static function getMessage($key, $hsc = false, $default = '')
-    {
+    public static function getMessage($key, $hsc = false, $default = '') {
         // Set initial output to default value.
         $translated = (string) $default;
         // Load common messages file.
@@ -567,8 +552,7 @@ 
      *
      * @return string "uid" for the given index_name
      */
-    public static function getUidFromIndexName($index_name, $table, $pid = -1)
-    {
+    public static function getUidFromIndexName($index_name, $table, $pid = -1) {
         if (
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
@@ -619,8 +603,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,
@@ -687,8 +670,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -701,8 +683,7 @@ 
      *
      * @return mixed Session value for given key or null on failure
      */
-    public static function loadFromSession($key)
-    {
+    public static function loadFromSession($key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -734,8 +715,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;
     }
@@ -752,8 +732,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false)
-    {
+    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = false, $cmdFirst = false) {
         if (
             \TYPO3_MODE === 'BE'
             && $GLOBALS['BE_USER']->isAdmin()
@@ -799,8 +778,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();
@@ -819,8 +797,7 @@ 
      *
      * @return bool true on success, false on failure
      */
-    public static function saveToSession($value, $key)
-    {
+    public static function saveToSession($value, $key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -852,8 +829,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.
@@ -976,8 +952,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;
@@ -1006,8 +981,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }