Erikmitk / kitodo-presentation

Classes/Plugin/Tools/SearchInDocumentTool.php

Spacing +2 added lines, -2 removed lines

@@ -108,7 +108,7 @@ 
             '###LABEL_PAGE###' => htmlspecialchars($this->pi_getLL('label.logicalPage')),
             '###LABEL_NORESULT###' => htmlspecialchars($this->pi_getLL('label.noresult')),
             '###CURRENT_DOCUMENT###' => $this->doc->uid,
-            '###SOLR_ENCRYPTED###' => $encryptedSolr ?: '',
+            '###SOLR_ENCRYPTED###' => $encryptedSolr ? : '',
         ];
 
         $content .= $this->templateService->substituteMarkerArray($this->template, $markerArray);
@@ -125,7 +125,7 @@ 
     protected function addSearchInDocumentJS()
     {
         $pageRenderer = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Page\PageRenderer::class);
-        $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($this->extKey)) . 'Resources/Public/Javascript/Search/SearchInDocument.js');
+        $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($this->extKey)).'Resources/Public/Javascript/Search/SearchInDocument.js');
     }
 
     /**

Braces +4 added lines, -8 removed lines

@@ -24,8 +24,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class SearchInDocumentTool extends \Kitodo\Dlf\Common\AbstractPlugin
-{
+class SearchInDocumentTool extends \Kitodo\Dlf\Common\AbstractPlugin {
     public $scriptRelPath = 'Classes/Plugin/Tools/SearchInDocumentTool.php';
 
     /**
@@ -38,8 +37,7 @@ 
      *
      * @return string The content that is displayed on the website
      */
-    public function main($content, $conf)
-    {
+    public function main($content, $conf) {
 
         $this->init($conf);
 
@@ -122,8 +120,7 @@ 
      *
      * @return void
      */
-    protected function addSearchInDocumentJS()
-    {
+    protected function addSearchInDocumentJS() {
         $pageRenderer = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Page\PageRenderer::class);
         $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($this->extKey)) . 'Resources/Public/Javascript/Search/SearchInDocument.js');
     }
@@ -135,8 +132,7 @@ 
      *
      * @return string with encrypted core name
      */
-    protected function getEncryptedCoreName()
-    {
+    protected function getEncryptedCoreName() {
         // Get core name.
         $name = Helper::getIndexNameFromUid($this->conf['solrcore'], 'tx_dlf_solrcores');
         // Encrypt core name.

Classes/Plugin/Search.php

Spacing +29 added lines, -29 removed lines

@@ -61,7 +61,7 @@ 
 
         if ($result->rowCount() == 1) {
             $pageRenderer = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Page\PageRenderer::class);
-            $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($this->extKey)) . 'Resources/Public/Javascript/Search/Suggester.js');
+            $pageRenderer->addJsFooterFile(\TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($this->extKey)).'Resources/Public/Javascript/Search/Suggester.js');
         } else {
             Helper::devLog('No metadata fields configured for search suggestions', DEVLOG_SEVERITY_WARNING);
         }
@@ -83,7 +83,7 @@ 
             && $list->metadata['options']['source'] == 'collection'
         ) {
             // Get collection's UID.
-            return '<input type="hidden" name="' . $this->prefixId . '[collection]" value="' . $list->metadata['options']['select'] . '" />';
+            return '<input type="hidden" name="'.$this->prefixId.'[collection]" value="'.$list->metadata['options']['select'].'" />';
         } elseif (!empty($list->metadata['options']['params']['filterquery'])) {
             // Get collection's UID from search metadata.
             foreach ($list->metadata['options']['params']['filterquery'] as $facet) {
@@ -95,7 +95,7 @@ 
                     $collectionId = Helper::getUidFromIndexName(trim($facetKeyVal[1], '(")'), 'tx_dlf_collections');
                 }
             }
-            return '<input type="hidden" name="' . $this->prefixId . '[collection]" value="' . $collectionId . '" />';
+            return '<input type="hidden" name="'.$this->prefixId.'[collection]" value="'.$collectionId.'" />';
         }
         return '';
     }
@@ -119,7 +119,7 @@ 
             $this->loadDocument();
             // Get document's UID or parent ID.
             if ($this->doc->ready) {
-                return '<input type="hidden" name="' . $this->prefixId . '[id]" value="' . ($this->doc->parentId > 0 ? $this->doc->parentId : $this->doc->uid) . '" />';
+                return '<input type="hidden" name="'.$this->prefixId.'[id]" value="'.($this->doc->parentId > 0 ? $this->doc->parentId : $this->doc->uid).'" />';
             }
         } elseif (!empty($list->metadata['options']['params']['filterquery'])) {
             // Get document's UID from search metadata.
@@ -129,7 +129,7 @@ 
                     $documentId = (int) substr($facetKeyVal[1], 1, strpos($facetKeyVal[1], ')'));
                 }
             }
-            return '<input type="hidden" name="' . $this->prefixId . '[id]" value="' . $documentId . '" />';
+            return '<input type="hidden" name="'.$this->prefixId.'[id]" value="'.$documentId.'" />';
         }
         return '';
     }
@@ -151,7 +151,7 @@ 
         }
         // Add encrypted fields to search form.
         if ($name !== false) {
-            return '<input type="hidden" name="' . $this->prefixId . '[encrypted]" value="' . $name . '" />';
+            return '<input type="hidden" name="'.$this->prefixId.'[encrypted]" value="'.$name.'" />';
         } else {
             return '';
         }
@@ -177,19 +177,19 @@ 
         // Get operator options.
         $operatorOptions = '';
         foreach (['AND', 'OR', 'NOT'] as $operator) {
-            $operatorOptions .= '<option class="tx-dlf-search-operator-option tx-dlf-search-operator-' . $operator . '" value="' . $operator . '">' . htmlspecialchars($this->pi_getLL($operator, '')) . '</option>';
+            $operatorOptions .= '<option class="tx-dlf-search-operator-option tx-dlf-search-operator-'.$operator.'" value="'.$operator.'">'.htmlspecialchars($this->pi_getLL($operator, '')).'</option>';
         }
         // Get field selector options.
         $fieldSelectorOptions = '';
         $searchFields = GeneralUtility::trimExplode(',', $this->conf['extendedFields'], true);
         foreach ($searchFields as $searchField) {
-            $fieldSelectorOptions .= '<option class="tx-dlf-search-field-option tx-dlf-search-field-' . $searchField . '" value="' . $searchField . '">' . Helper::translate($searchField, 'tx_dlf_metadata', $this->conf['pages']) . '</option>';
+            $fieldSelectorOptions .= '<option class="tx-dlf-search-field-option tx-dlf-search-field-'.$searchField.'" value="'.$searchField.'">'.Helper::translate($searchField, 'tx_dlf_metadata', $this->conf['pages']).'</option>';
         }
         for ($i = 0; $i < $this->conf['extendedSlotCount']; $i++) {
             $markerArray = [
-                '###EXT_SEARCH_OPERATOR###' => '<select class="tx-dlf-search-operator tx-dlf-search-operator-' . $i . '" name="' . $this->prefixId . '[extOperator][' . $i . ']">' . $operatorOptions . '</select>',
-                '###EXT_SEARCH_FIELDSELECTOR###' => '<select class="tx-dlf-search-field tx-dlf-search-field-' . $i . '" name="' . $this->prefixId . '[extField][' . $i . ']">' . $fieldSelectorOptions . '</select>',
-                '###EXT_SEARCH_FIELDQUERY###' => '<input class="tx-dlf-search-query tx-dlf-search-query-' . $i . '" type="text" name="' . $this->prefixId . '[extQuery][' . $i . ']" />'
+                '###EXT_SEARCH_OPERATOR###' => '<select class="tx-dlf-search-operator tx-dlf-search-operator-'.$i.'" name="'.$this->prefixId.'[extOperator]['.$i.']">'.$operatorOptions.'</select>',
+                '###EXT_SEARCH_FIELDSELECTOR###' => '<select class="tx-dlf-search-field tx-dlf-search-field-'.$i.'" name="'.$this->prefixId.'[extField]['.$i.']">'.$fieldSelectorOptions.'</select>',
+                '###EXT_SEARCH_FIELDQUERY###' => '<input class="tx-dlf-search-query tx-dlf-search-query-'.$i.'" type="text" name="'.$this->prefixId.'[extQuery]['.$i.']" />'
             ];
             $extendedSearch .= $this->templateService->substituteMarkerArray($this->templateService->getSubpart($this->template, '###EXT_SEARCH_ENTRY###'), $markerArray);
         }
@@ -217,12 +217,12 @@ 
         // Get facets from plugin configuration.
         $facets = [];
         foreach (GeneralUtility::trimExplode(',', $this->conf['facets'], true) as $facet) {
-            $facets[$facet . '_faceting'] = Helper::translate($facet, 'tx_dlf_metadata', $this->conf['pages']);
+            $facets[$facet.'_faceting'] = Helper::translate($facet, 'tx_dlf_metadata', $this->conf['pages']);
         }
         // Render facets menu.
         $TSconfig = [];
         $TSconfig['special'] = 'userfunction';
-        $TSconfig['special.']['userFunc'] = \Kitodo\Dlf\Plugin\Search::class . '->makeFacetsMenuArray';
+        $TSconfig['special.']['userFunc'] = \Kitodo\Dlf\Plugin\Search::class.'->makeFacetsMenuArray';
         $TSconfig['special.']['facets'] = $facets;
         $TSconfig['special.']['limit'] = max(intval($this->conf['limitFacets']), 1);
         $TSconfig = Helper::mergeRecursiveWithOverrule($this->conf['facetsConf.'], $TSconfig);
@@ -243,10 +243,10 @@ 
         $output = '';
         // Check for plugin configuration.
         if (!empty($this->conf['fulltext'])) {
-            $output .= ' <input class="tx-dlf-search-fulltext" id="tx-dlf-search-fulltext-no" type="radio" name="' . $this->prefixId . '[fulltext]" value="0" ' . ($isFulltextSearch == 0 ? 'checked="checked"' : '') . ' />';
-            $output .= ' <label for="tx-dlf-search-fulltext-no">' . htmlspecialchars($this->pi_getLL('label.inMetadata', '')) . '</label>';
-            $output .= ' <input class="tx-dlf-search-fulltext" id="tx-dlf-search-fulltext-yes" type="radio" name="' . $this->prefixId . '[fulltext]" value="1" ' . ($isFulltextSearch == 1 ? 'checked="checked"' : '') . '/>';
-            $output .= ' <label for="tx-dlf-search-fulltext-yes">' . htmlspecialchars($this->pi_getLL('label.inFulltext', '')) . '</label>';
+            $output .= ' <input class="tx-dlf-search-fulltext" id="tx-dlf-search-fulltext-no" type="radio" name="'.$this->prefixId.'[fulltext]" value="0" '.($isFulltextSearch == 0 ? 'checked="checked"' : '').' />';
+            $output .= ' <label for="tx-dlf-search-fulltext-no">'.htmlspecialchars($this->pi_getLL('label.inMetadata', '')).'</label>';
+            $output .= ' <input class="tx-dlf-search-fulltext" id="tx-dlf-search-fulltext-yes" type="radio" name="'.$this->prefixId.'[fulltext]" value="1" '.($isFulltextSearch == 1 ? 'checked="checked"' : '').'/>';
+            $output .= ' <label for="tx-dlf-search-fulltext-yes">'.htmlspecialchars($this->pi_getLL('label.inFulltext', '')).'</label>';
         }
         return $output;
     }
@@ -263,8 +263,8 @@ 
         $output = '';
         // Check for plugin configuration.
         if (!empty($this->conf['showLogicalPageField'])) {
-            $output .= ' <label for="tx-dlf-search-logical-page">' . htmlspecialchars($this->pi_getLL('label.logicalPage', '')) . ': </label>';
-            $output .= ' <input class="tx-dlf-search-logical-page" id="tx-dlf-search-logical-page" type="text" name="' . $this->prefixId . '[logicalPage]" />';
+            $output .= ' <label for="tx-dlf-search-logical-page">'.htmlspecialchars($this->pi_getLL('label.logicalPage', '')).': </label>';
+            $output .= ' <input class="tx-dlf-search-logical-page" id="tx-dlf-search-logical-page" type="text" name="'.$this->prefixId.'[logicalPage]" />';
         }
         return $output;
     }
@@ -305,7 +305,7 @@ 
         $entryArray['doNotLinkIt'] = 0;
         // Check if facet is already selected.
         $queryColumn = array_column($search['params']['filterquery'], 'query');
-        $index = array_search($field . ':("' . Solr::escapeQuery($value) . '")', $queryColumn);
+        $index = array_search($field.':("'.Solr::escapeQuery($value).'")', $queryColumn);
         if ($index !== false) {
             // Facet is selected, thus remove it from filter.
             unset($queryColumn[$index]);
@@ -322,7 +322,7 @@ 
             }
         } else {
             // Facet is not selected, thus add it to filter.
-            $queryColumn[] = $field . ':("' . Solr::escapeQuery($value) . '")';
+            $queryColumn[] = $field.':("'.Solr::escapeQuery($value).'")';
             $entryArray['ITEM_STATE'] = 'NO';
         }
         $entryArray['_OVERRIDE_HREF'] = $this->pi_linkTP_keepPIvars_url(['query' => $search['query'], 'fq' => $queryColumn]);
@@ -378,7 +378,7 @@ 
                 '###ACTION_URL###' => $this->cObj->typoLink_URL($linkConf),
                 '###LABEL_QUERY###' => (!empty($search['query']) ? htmlspecialchars($search['query']) : htmlspecialchars($this->pi_getLL('label.query'))),
                 '###LABEL_SUBMIT###' => htmlspecialchars($this->pi_getLL('label.submit')),
-                '###FIELD_QUERY###' => $this->prefixId . '[query]',
+                '###FIELD_QUERY###' => $this->prefixId.'[query]',
                 '###QUERY###' => (!empty($search['query']) ? htmlspecialchars($search['query']) : ''),
                 '###FULLTEXTSWITCH###' => $this->addFulltextSwitch($list->metadata['fulltextSearch']),
                 '###FIELD_DOC###' => ($this->conf['searchIn'] == 'document' || $this->conf['searchIn'] == 'all' ? $this->addCurrentDocument() : ''),
@@ -410,7 +410,7 @@ 
                 $this->piVars['query'] = empty($matches[1]) ? $this->piVars['query'] : $matches[1];
                 // Search in fulltext field if applicable. Query must not be empty!
                 if (!empty($this->piVars['query'])) {
-                    $query = 'fulltext:(' . Solr::escapeQuery(trim($this->piVars['query'])) . ')';
+                    $query = 'fulltext:('.Solr::escapeQuery(trim($this->piVars['query'])).')';
                 }
             } else {
                 // Retain given search field if valid.
@@ -431,9 +431,9 @@ 
                             && in_array($this->piVars['extField'][$i], $allowedFields)
                         ) {
                             if (!empty($query)) {
-                                $query .= ' ' . $this->piVars['extOperator'][$i] . ' ';
+                                $query .= ' '.$this->piVars['extOperator'][$i].' ';
                             }
-                            $query .= Indexer::getIndexFieldName($this->piVars['extField'][$i], $this->conf['pages']) . ':(' . Solr::escapeQuery($this->piVars['extQuery'][$i]) . ')';
+                            $query .= Indexer::getIndexFieldName($this->piVars['extField'][$i], $this->conf['pages']).':('.Solr::escapeQuery($this->piVars['extQuery'][$i]).')';
                         }
                     }
                 }
@@ -453,7 +453,7 @@ 
                     !empty($this->piVars['id'])
                     && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($this->piVars['id'])
                 ) {
-                    $params['filterquery'][]['query'] = 'uid:(' . $this->piVars['id'] . ') OR partof:(' . $this->piVars['id'] . ')';
+                    $params['filterquery'][]['query'] = 'uid:('.$this->piVars['id'].') OR partof:('.$this->piVars['id'].')';
                     $label .= htmlspecialchars(sprintf($this->pi_getLL('in', ''), Document::getTitle($this->piVars['id'])));
                 }
             }
@@ -467,7 +467,7 @@ 
                     && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($this->piVars['collection'])
                 ) {
                     $index_name = Helper::getIndexNameFromUid($this->piVars['collection'], 'tx_dlf_collections', $this->conf['pages']);
-                    $params['filterquery'][]['query'] = 'collection_faceting:("' . Solr::escapeQuery($index_name) . '")';
+                    $params['filterquery'][]['query'] = 'collection_faceting:("'.Solr::escapeQuery($index_name).'")';
                     $label .= sprintf($this->pi_getLL('in', '', true), Helper::translate($index_name, 'tx_dlf_collections', $this->conf['pages']));
                 }
             }
@@ -479,7 +479,7 @@ 
                     $collIndexNames[] = Solr::escapeQuery(Helper::getIndexNameFromUid(intval($collId), 'tx_dlf_collections', $this->conf['pages']));
                 }
                 // Last value is fake and used for distinction in $this->addCurrentCollection()
-                $params['filterquery'][]['query'] = 'collection_faceting:("' . implode('" OR "', $collIndexNames) . '" OR "FakeValueForDistinction")';
+                $params['filterquery'][]['query'] = 'collection_faceting:("'.implode('" OR "', $collIndexNames).'" OR "FakeValueForDistinction")';
             }
             // Set some query parameters.
             $params['query'] = !empty($query) ? $query : '*';
@@ -529,7 +529,7 @@ 
             $linkConf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
             $linkConf['additionalParams'] = GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', true, false);
             // Send headers.
-            header('Location: ' . GeneralUtility::locationHeaderUrl($this->cObj->typoLink_URL($linkConf)));
+            header('Location: '.GeneralUtility::locationHeaderUrl($this->cObj->typoLink_URL($linkConf)));
             exit;
         }
     }

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

@@ -150,7 +150,7 @@ 
             $name = Helper::encrypt($name);
         }
         // Add encrypted fields to search form.
-        if ($name !== false) {
+        if ($name !== FALSE) {
             return '<input type="hidden" name="' . $this->prefixId . '[encrypted]" value="' . $name . '" />';
         } else {
             return '';
@@ -181,7 +181,7 @@ 
         }
         // Get field selector options.
         $fieldSelectorOptions = '';
-        $searchFields = GeneralUtility::trimExplode(',', $this->conf['extendedFields'], true);
+        $searchFields = GeneralUtility::trimExplode(',', $this->conf['extendedFields'], TRUE);
         foreach ($searchFields as $searchField) {
             $fieldSelectorOptions .= '<option class="tx-dlf-search-field-option tx-dlf-search-field-' . $searchField . '" value="' . $searchField . '">' . Helper::translate($searchField, 'tx_dlf_metadata', $this->conf['pages']) . '</option>';
         }
@@ -216,7 +216,7 @@ 
         }
         // Get facets from plugin configuration.
         $facets = [];
-        foreach (GeneralUtility::trimExplode(',', $this->conf['facets'], true) as $facet) {
+        foreach (GeneralUtility::trimExplode(',', $this->conf['facets'], TRUE) as $facet) {
             $facets[$facet . '_faceting'] = Helper::translate($facet, 'tx_dlf_metadata', $this->conf['pages']);
         }
         // Render facets menu.
@@ -306,7 +306,7 @@ 
         // Check if facet is already selected.
         $queryColumn = array_column($search['params']['filterquery'], 'query');
         $index = array_search($field . ':("' . Solr::escapeQuery($value) . '")', $queryColumn);
-        if ($index !== false) {
+        if ($index !== FALSE) {
             // Facet is selected, thus remove it from filter.
             unset($queryColumn[$index]);
             $queryColumn = array_values($queryColumn);
@@ -315,7 +315,7 @@ 
             //Reset facets
             if ($this->conf['resetFacets']) {
                 //remove ($count) for selected facet in template
-                $entryArray['count'] = false;
+                $entryArray['count'] = FALSE;
                 //build link to delete selected facet
                 $entryArray['_OVERRIDE_HREF'] = $this->pi_linkTP_keepPIvars_url(['query' => $search['query'], 'fq' => $queryColumn]);
                 $entryArray['title'] = sprintf($this->pi_getLL('resetFacet', ''), $entryArray['title']);
@@ -343,7 +343,7 @@ 
     {
         $this->init($conf);
         // Disable caching for this plugin.
-        $this->setCache(false);
+        $this->setCache(FALSE);
         // Quit without doing anything if required variables are not set.
         if (empty($this->conf['solrcore'])) {
             Helper::devLog('Incomplete plugin configuration', DEVLOG_SEVERITY_WARNING);
@@ -422,7 +422,7 @@ 
                 && is_array($this->piVars['extQuery'])
             ) {
                 $allowedOperators = ['AND', 'OR', 'NOT'];
-                $allowedFields = GeneralUtility::trimExplode(',', $this->conf['extendedFields'], true);
+                $allowedFields = GeneralUtility::trimExplode(',', $this->conf['extendedFields'], TRUE);
                 $numberOfExtQueries = count($this->piVars['extQuery']);
                 for ($i = 0; $i < $numberOfExtQueries; $i++) {
                     if (!empty($this->piVars['extQuery'][$i])) {
@@ -468,7 +468,7 @@ 
                 ) {
                     $index_name = Helper::getIndexNameFromUid($this->piVars['collection'], 'tx_dlf_collections', $this->conf['pages']);
                     $params['filterquery'][]['query'] = 'collection_faceting:("' . Solr::escapeQuery($index_name) . '")';
-                    $label .= sprintf($this->pi_getLL('in', '', true), Helper::translate($index_name, 'tx_dlf_collections', $this->conf['pages']));
+                    $label .= sprintf($this->pi_getLL('in', '', TRUE), Helper::translate($index_name, 'tx_dlf_collections', $this->conf['pages']));
                 }
             }
             // Add filter query for collection restrictions.
@@ -527,7 +527,7 @@ 
             }
             $linkConf['forceAbsoluteUrl'] = !empty($this->conf['forceAbsoluteUrl']) ? 1 : 0;
             $linkConf['forceAbsoluteUrl.']['scheme'] = !empty($this->conf['forceAbsoluteUrl']) && !empty($this->conf['forceAbsoluteUrlHttps']) ? 'https' : 'http';
-            $linkConf['additionalParams'] = GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', true, false);
+            $linkConf['additionalParams'] = GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', TRUE, FALSE);
             // Send headers.
             header('Location: ' . GeneralUtility::locationHeaderUrl($this->cObj->typoLink_URL($linkConf)));
             exit;

Classes/Common/Solr.php

Spacing +13 added lines, -13 removed lines

@@ -128,7 +128,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);
@@ -224,13 +224,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);
             }
@@ -294,7 +294,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 {
@@ -335,7 +335,7 @@ 
                 $config['path'] .= 'solr/';
             }
             // Set connection timeout lower than PHP's max_execution_time.
-            $max_execution_time = intval(ini_get('max_execution_time')) ?: 30;
+            $max_execution_time = intval(ini_get('max_execution_time')) ? : 30;
             $config['timeout'] = MathUtility::forceIntegerInRange($conf['solrTimeout'], 1, $max_execution_time, 10);
             $this->config = $config;
         }
@@ -369,13 +369,13 @@ 
         // Extend filter query to get all documents with the same uids.
         foreach ($params['filterquery'] as $key => $value) {
             if (isset($value['query'])) {
-                $params['filterquery'][$key]['query'] = '{!join from=uid to=uid}' . $value['query'];
+                $params['filterquery'][$key]['query'] = '{!join from=uid to=uid}'.$value['query'];
             }
         }
         // 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);
@@ -432,7 +432,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) {
@@ -563,12 +563,12 @@ 
      */
     public function __get($var)
     {
-        $method = '_get' . ucfirst($var);
+        $method = '_get'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            Helper::devLog('There is no getter function for property "' . $var . '"', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('There is no getter function for property "'.$var.'"', DEVLOG_SEVERITY_WARNING);
             return;
         } else {
             return $this->$method();
@@ -601,12 +601,12 @@ 
      */
     public function __set($var, $value)
     {
-        $method = '_set' . ucfirst($var);
+        $method = '_set'.ucfirst($var);
         if (
             !property_exists($this, $var)
             || !method_exists($this, $method)
         ) {
-            Helper::devLog('There is no setter function for property "' . $var . '"', DEVLOG_SEVERITY_WARNING);
+            Helper::devLog('There is no setter function for property "'.$var.'"', DEVLOG_SEVERITY_WARNING);
         } else {
             $this->$method($value);
         }
@@ -643,7 +643,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'],

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

@@ -49,7 +49,7 @@ 
      * @var string|null
      * @access protected
      */
-    protected $core = null;
+    protected $core = NULL;
 
     /**
      * This holds the PID for the configuration
@@ -97,7 +97,7 @@ 
      * @var bool
      * @access protected
      */
-    protected $ready = false;
+    protected $ready = FALSE;
 
     /**
      * This holds the singleton search objects with their core as array key
@@ -249,7 +249,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)) {
@@ -258,7 +258,7 @@ 
         // Check if core is set or null.
         if (
             empty($core)
-            && $core !== null
+            && $core !== NULL
         ) {
             Helper::devLog('Invalid core UID or name given for Apache Solr', DEVLOG_SEVERITY_ERROR);
         }
@@ -406,7 +406,7 @@ 
                 'core' => $this->core,
                 'pid' => $this->cPid,
                 'order' => 'score',
-                'order.asc' => true,
+                'order.asc' => TRUE,
                 'numberOfHits' => $this->numberOfHits,
                 'numberOfToplevelHits' => $numberOfToplevelHits
             ]
@@ -432,10 +432,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) {
@@ -661,7 +661,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);
@@ -669,7 +669,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
@@ -683,7 +683,7 @@ 
                     }
                 }
                 // Instantiation successful!
-                $this->ready = true;
+                $this->ready = TRUE;
             }
         } catch (\Exception $e) {
             // Nothing to do here.

Classes/Common/Helper.php

Spacing +48 added lines, -48 removed lines

@@ -135,7 +135,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;
                 }
@@ -214,7 +214,7 @@ 
             $args = [];
             $data = [];
             if (!empty($stacktrace[1])) {
-                $caller = $stacktrace[1]['class'] . $stacktrace[1]['type'] . $stacktrace[1]['function'];
+                $caller = $stacktrace[1]['class'].$stacktrace[1]['type'].$stacktrace[1]['function'];
                 foreach ($stacktrace[1]['args'] as $arg) {
                     if (is_bool($arg)) {
                         $args[] = ($arg ? 'true' : 'false');
@@ -226,14 +226,14 @@ 
                         $args[] = '[data]';
                         $data[] = $arg;
                     } elseif (is_object($arg)) {
-                        $args[] = '[' . get_class($arg) . ']';
+                        $args[] = '['.get_class($arg).']';
                         $data[] = $arg;
                     }
                 }
             }
-            $arguments = '(' . implode(', ', $args) . ')';
+            $arguments = '('.implode(', ', $args).')';
             $additionalData = (empty($data) ? false : $data);
-            /** @scrutinizer ignore-deprecated */ \TYPO3\CMS\Core\Utility\GeneralUtility::devLog('[' . $caller . $arguments . '] ' . $message, self::$extKey, $severity, $additionalData);
+            /** @scrutinizer ignore-deprecated */ \TYPO3\CMS\Core\Utility\GeneralUtility::devLog('['.$caller.$arguments.'] '.$message, self::$extKey, $severity, $additionalData);
         }
     }
 
@@ -286,7 +286,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;
     }
@@ -340,8 +340,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[] = &\TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance($classRef);
             }
         }
@@ -367,7 +367,7 @@ 
             !$uid
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::devLog('Invalid UID "' . $uid . '" or table "' . $table . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Invalid UID "'.$uid.'" or table "'.$table.'"', DEVLOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -378,15 +378,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)
             )
@@ -396,7 +396,7 @@ 
         if ($resArray = $result->fetch()) {
             return $resArray['index_name'];
         } else {
-            self::devLog('No "index_name" with UID ' . $uid . ' and PID ' . $pid . ' found in table "' . $table . '"', DEVLOG_SEVERITY_WARNING);
+            self::devLog('No "index_name" with UID '.$uid.' and PID '.$pid.' found in table "'.$table.'"', DEVLOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -415,9 +415,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;
@@ -434,13 +434,13 @@ 
                 $lang = $GLOBALS['LANG']->getLLL($isoCode, $iso639);
             }
         } else {
-            self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             return $code;
         }
         if (!empty($lang)) {
             return $lang;
         } else {
-            self::devLog('Language code "' . $code . '" not found in ISO-639 table', DEVLOG_SEVERITY_NOTICE);
+            self::devLog('Language code "'.$code.'" not found in ISO-639 table', DEVLOG_SEVERITY_NOTICE);
             return $code;
         }
     }
@@ -468,7 +468,7 @@ 
             } elseif (\TYPO3_MODE === 'BE') {
                 self::$messages = $GLOBALS['LANG']->includeLLFile($file, false, true);
             } else {
-                self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+                self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             }
         }
         // Get translation.
@@ -478,7 +478,7 @@ 
             } elseif (\TYPO3_MODE === 'BE') {
                 $translated = $GLOBALS['LANG']->getLLL($key, self::$messages);
             } else {
-                self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+                self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             }
         }
         // Escape HTML characters if applicable.
@@ -505,7 +505,7 @@ 
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
         ) {
-            self::devLog('Invalid UID ' . $index_name . ' or table "' . $table . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Invalid UID '.$index_name.' or table "'.$table.'"', DEVLOG_SEVERITY_ERROR);
             return '';
         }
 
@@ -516,14 +516,14 @@ 
         // 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 . '.uid AS uid')
+            ->select($table.'.uid AS uid')
             ->from($table)
             ->where(
-                $queryBuilder->expr()->eq($table . '.index_name', $queryBuilder->expr()->literal($index_name)),
+                $queryBuilder->expr()->eq($table.'.index_name', $queryBuilder->expr()->literal($index_name)),
                 $where,
                 self::whereExpression($table)
             )
@@ -535,7 +535,7 @@ 
         if (count($allResults) == 1) {
             return $allResults[0]['uid'];
         } else {
-            self::devLog('No UID for given index_name "' . $index_name . '" and PID ' . $pid . ' found in table "' . $table . '"', DEVLOG_SEVERITY_WARNING);
+            self::devLog('No UID for given index_name "'.$index_name.'" and PID '.$pid.' found in table "'.$table.'"', DEVLOG_SEVERITY_WARNING);
             return '';
         }
     }
@@ -593,7 +593,7 @@ 
             '-' => 39,
             ':' => 17,
         ];
-        $urn = strtolower($base . $id);
+        $urn = strtolower($base.$id);
         if (preg_match('/[^a-z0-9:-]/', $urn)) {
             self::devLog('Invalid chars in given parameters', DEVLOG_SEVERITY_WARNING);
             return '';
@@ -607,7 +607,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;
     }
 
     /**
@@ -638,7 +638,7 @@ 
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
-            self::devLog('Invalid key "' . $key . '" for session data retrieval', DEVLOG_SEVERITY_WARNING);
+            self::devLog('Invalid key "'.$key.'" for session data retrieval', DEVLOG_SEVERITY_WARNING);
             return;
         }
         // Get the session data.
@@ -647,7 +647,7 @@ 
         } elseif (\TYPO3_MODE === 'BE') {
             return $GLOBALS['BE_USER']->getSessionData($key);
         } else {
-            self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             return;
         }
     }
@@ -756,7 +756,7 @@ 
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
-            self::devLog('Invalid key "' . $key . '" for session data saving', DEVLOG_SEVERITY_WARNING);
+            self::devLog('Invalid key "'.$key.'" for session data saving', DEVLOG_SEVERITY_WARNING);
             return false;
         }
         // Save value in session data.
@@ -768,7 +768,7 @@ 
             $GLOBALS['BE_USER']->setAndSaveSessionData($key, $value);
             return true;
         } else {
-            self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             return false;
         }
     }
@@ -791,7 +791,7 @@ 
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
-            self::devLog('Invalid PID ' . $pid . ' for translation', DEVLOG_SEVERITY_WARNING);
+            self::devLog('Invalid PID '.$pid.' for translation', DEVLOG_SEVERITY_WARNING);
             return $index_name;
         }
         // Check if "index_name" is an UID.
@@ -808,13 +808,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)
@@ -827,12 +827,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($GLOBALS['TSFE']->sys_language_content)),
+                    $queryBuilder->expr()->eq($table.'.pid', $pid),
+                    $queryBuilder->expr()->eq($table.'.uid', $resArray['l18n_parent']),
+                    $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content)),
                     self::whereExpression($table, true)
                 )
                 ->setMaxResults(1)
@@ -850,14 +850,14 @@ 
         if (empty($labels[$table][$pid][$GLOBALS['TSFE']->sys_language_content][$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 ($GLOBALS['TSFE']->sys_language_content > 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($GLOBALS['TSFE']->sys_language_content))
+                            $queryBuilder->expr()->in($table.'.sys_language_uid', [-1, 0]),
+                            $queryBuilder->expr()->eq($table.'.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content))
                         ),
-                        $queryBuilder->expr()->eq($table . '.l18n_parent', 0)
+                        $queryBuilder->expr()->eq($table.'.l18n_parent', 0)
                     );
                 }
 
@@ -866,7 +866,7 @@ 
                     ->select('*')
                     ->from($table)
                     ->where(
-                        $queryBuilder->expr()->eq($table . '.pid', $pid),
+                        $queryBuilder->expr()->eq($table.'.pid', $pid),
                         $additionalWhere,
                         self::whereExpression($table, true)
                     )
@@ -884,10 +884,10 @@ 
                         }
                     }
                 } else {
-                    self::devLog('No translation with PID ' . $pid . ' available in table "' . $table . '" or translation not accessible', DEVLOG_SEVERITY_NOTICE);
+                    self::devLog('No translation with PID '.$pid.' available in table "'.$table.'" or translation not accessible', DEVLOG_SEVERITY_NOTICE);
                 }
             } else {
-                self::devLog('No translations available for table "' . $table . '"', DEVLOG_SEVERITY_WARNING);
+                self::devLog('No translations available for table "'.$table.'"', DEVLOG_SEVERITY_WARNING);
             }
         }
 
@@ -926,9 +926,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::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
+            self::devLog('Unexpected TYPO3_MODE "'.\TYPO3_MODE.'"', DEVLOG_SEVERITY_ERROR);
             return '1=-1';
         }
     }

Braces +24 added lines, -48 removed lines

@@ -24,8 +24,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -73,8 +72,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 = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
@@ -99,8 +97,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++) {
@@ -164,8 +161,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))
@@ -205,8 +201,7 @@ 
      *
      * @return void
      */
-    public static function devLog($message, $severity = 0)
-    {
+    public static function devLog($message, $severity = 0) {
         if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_div.php']['devLog'])) {
             $stacktrace = debug_backtrace(0, 2);
             // Set some defaults.
@@ -246,8 +241,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::devLog('OpenSSL library doesn\'t support hash algorithm', DEVLOG_SEVERITY_ERROR);
             return false;
@@ -266,8 +260,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))
@@ -300,8 +293,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -315,8 +307,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.
@@ -337,8 +328,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) {
@@ -359,8 +349,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 (
@@ -410,8 +399,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)) {
@@ -456,8 +444,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.
@@ -499,8 +486,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'])
@@ -551,8 +537,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,
@@ -619,8 +604,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -633,8 +617,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) {
@@ -666,8 +649,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;
     }
@@ -684,8 +666,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()
@@ -731,8 +712,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();
@@ -751,8 +731,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) {
@@ -784,8 +763,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.
@@ -908,8 +886,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;
@@ -938,8 +915,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }

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

@@ -73,7 +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 = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
@@ -115,9 +115,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':
@@ -125,19 +125,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':
@@ -146,13 +146,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;
     }
 
     /**
@@ -167,28 +167,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::devLog('OpenSSL library doesn\'t support cipher and/or hash algorithm', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::devLog('No encryption key set in TYPO3 configuration', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (
             empty($encrypted)
             || strlen($encrypted) < openssl_cipher_iv_length(self::$cipherAlgorithm)
         ) {
             self::devLog('Invalid parameters given for decryption', DEVLOG_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;
@@ -232,7 +232,7 @@ 
                 }
             }
             $arguments = '(' . implode(', ', $args) . ')';
-            $additionalData = (empty($data) ? false : $data);
+            $additionalData = (empty($data) ? FALSE : $data);
             /** @scrutinizer ignore-deprecated */ \TYPO3\CMS\Core\Utility\GeneralUtility::devLog('[' . $caller . $arguments . '] ' . $message, self::$extKey, $severity, $additionalData);
         }
     }
@@ -248,9 +248,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::devLog('OpenSSL library doesn\'t support hash algorithm', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         // Hash string.
         $hashed = openssl_digest($string, self::$hashAlgorithm);
@@ -269,23 +269,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::devLog('OpenSSL library doesn\'t support cipher and/or hash algorithm', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::devLog('No encryption key set in TYPO3 configuration', DEVLOG_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;
@@ -429,7 +429,7 @@ 
                 $lang = $GLOBALS['TSFE']->getLLL($isoCode, $iso639);
             }
         } elseif (\TYPO3_MODE === 'BE') {
-            $iso639 = $GLOBALS['LANG']->includeLLFile($file, false, true);
+            $iso639 = $GLOBALS['LANG']->includeLLFile($file, FALSE, TRUE);
             if (!empty($iso639['default'][$isoCode])) {
                 $lang = $GLOBALS['LANG']->getLLL($isoCode, $iso639);
             }
@@ -456,7 +456,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;
@@ -466,7 +466,7 @@ 
             if (\TYPO3_MODE === 'FE') {
                 self::$messages = $GLOBALS['TSFE']->readLLfile($file);
             } elseif (\TYPO3_MODE === 'BE') {
-                self::$messages = $GLOBALS['LANG']->includeLLFile($file, false, true);
+                self::$messages = $GLOBALS['LANG']->includeLLFile($file, FALSE, TRUE);
             } else {
                 self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
             }
@@ -666,7 +666,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;
@@ -684,7 +684,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'
@@ -693,7 +693,7 @@ 
             // Instantiate TYPO3 core engine.
             $dataHandler = GeneralUtility::makeInstance(\TYPO3\CMS\Core\DataHandling\DataHandler::class);
             // We do not use workspaces and have to bypass restrictions in DataHandler.
-            $dataHandler->bypassWorkspaceRestrictions = true;
+            $dataHandler->bypassWorkspaceRestrictions = TRUE;
             // Load data and command arrays.
             $dataHandler->start($data, $cmd);
             // Process command map first if default order is reversed.
@@ -757,19 +757,19 @@ 
         $key = (string) $key;
         if (!$key) {
             self::devLog('Invalid key "' . $key . '" for session data saving', DEVLOG_SEVERITY_WARNING);
-            return false;
+            return FALSE;
         }
         // Save value in session data.
         if (\TYPO3_MODE === 'FE') {
             $GLOBALS['TSFE']->fe_user->setKey('ses', $key, $value);
             $GLOBALS['TSFE']->fe_user->storeSessionData();
-            return true;
+            return TRUE;
         } elseif (\TYPO3_MODE === 'BE') {
             $GLOBALS['BE_USER']->setAndSaveSessionData($key, $value);
-            return true;
+            return TRUE;
         } else {
             self::devLog('Unexpected TYPO3_MODE "' . \TYPO3_MODE . '"', DEVLOG_SEVERITY_ERROR);
-            return false;
+            return FALSE;
         }
     }
 
@@ -815,7 +815,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();
@@ -833,7 +833,7 @@ 
                     $queryBuilder->expr()->eq($table . '.pid', $pid),
                     $queryBuilder->expr()->eq($table . '.uid', $resArray['l18n_parent']),
                     $queryBuilder->expr()->eq($table . '.sys_language_uid', intval($GLOBALS['TSFE']->sys_language_content)),
-                    self::whereExpression($table, true)
+                    self::whereExpression($table, TRUE)
                 )
                 ->setMaxResults(1)
                 ->execute();
@@ -868,7 +868,7 @@ 
                     ->where(
                         $queryBuilder->expr()->eq($table . '.pid', $pid),
                         $additionalWhere,
-                        self::whereExpression($table, true)
+                        self::whereExpression($table, TRUE)
                     )
                     ->setMaxResults(10000)
                     ->execute();
@@ -908,7 +908,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?