Passed
Pull Request — master (#123)
by Sebastian
09:10
created
Classes/Common/SolrSearchQuery.php 1 patch
Braces   +8 added lines, -16 removed lines patch added patch discarded remove patch
@@ -10,10 +10,8 @@  discard block
 block discarded – undo
10 10
 /**
11 11
  * Targeted towards being used in ``PaginateController`` (``<f:widget.paginate>``).
12 12
  */
13
-class SolrSearchQuery implements QueryInterface
14
-{
15
-    public function __construct($solrSearch)
16
-    {
13
+class SolrSearchQuery implements QueryInterface {
14
+    public function __construct($solrSearch) {
17 15
         $this->solrSearch = $solrSearch;
18 16
 
19 17
         $this->offset = 0;
@@ -22,8 +20,7 @@  discard block
 block discarded – undo
22 20
 
23 21
     public function getSource() {}
24 22
 
25
-    public function execute($returnRawQueryResult = false)
26
-    {
23
+    public function execute($returnRawQueryResult = false) {
27 24
         $this->solrSearch->submit($this->offset, $this->limit);
28 25
 
29 26
         // solrSearch now only contains the results in range, indexed in [0, n)
@@ -37,14 +34,12 @@  discard block
 block discarded – undo
37 34
 
38 35
     public function setOrderings(array $orderings) {}
39 36
 
40
-    public function setLimit($limit)
41
-    {
37
+    public function setLimit($limit) {
42 38
         $this->limit = $limit;
43 39
         return $this;
44 40
     }
45 41
 
46
-    public function setOffset($offset)
47
-    {
42
+    public function setOffset($offset) {
48 43
         $this->offset = $offset;
49 44
         return $this;
50 45
     }
@@ -65,20 +60,17 @@  discard block
 block discarded – undo
65 60
     public function setQuerySettings(QuerySettingsInterface $querySettings) {}
66 61
     public function getQuerySettings() {}
67 62
 
68
-    public function count()
69
-    {
63
+    public function count() {
70 64
         // TODO?
71 65
     }
72 66
 
73 67
     public function getOrderings() {}
74 68
 
75
-    public function getLimit()
76
-    {
69
+    public function getLimit() {
77 70
         return $this->limit;
78 71
     }
79 72
 
80
-    public function getOffset()
81
-    {
73
+    public function getOffset() {
82 74
         return $this->offset;
83 75
     }
84 76
 
Please login to merge, or discard this patch.
Classes/Domain/Repository/DocumentRepository.php 1 patch
Braces   +13 added lines, -26 removed lines patch added patch discarded remove patch
@@ -48,8 +48,7 @@  discard block
 block discarded – undo
48 48
      *
49 49
      * @return \Kitodo\Dlf\Domain\Model\Document|null
50 50
      */
51
-    public function findOneByParameters($parameters)
52
-    {
51
+    public function findOneByParameters($parameters) {
53 52
         $doc = null;
54 53
         $document = null;
55 54
 
@@ -93,8 +92,7 @@  discard block
 block discarded – undo
93 92
      *
94 93
      * @return \Kitodo\Dlf\Domain\Model\Document|null
95 94
      */
96
-    public function findOldestDocument()
97
-    {
95
+    public function findOldestDocument() {
98 96
         $query = $this->createQuery();
99 97
 
100 98
         $query->setOrderings(['tstamp' => QueryInterface::ORDER_ASCENDING]);
@@ -108,8 +106,7 @@  discard block
 block discarded – undo
108 106
      * @param  \Kitodo\Dlf\Domain\Model\Structure $structure
109 107
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
110 108
      */
111
-    public function getChildrenOfYearAnchor($partOf, $structure)
112
-    {
109
+    public function getChildrenOfYearAnchor($partOf, $structure) {
113 110
         $query = $this->createQuery();
114 111
 
115 112
         $query->matching($query->equals('structure', $structure));
@@ -130,8 +127,7 @@  discard block
 block discarded – undo
130 127
      *
131 128
      * @return \Kitodo\Dlf\Domain\Model\Document|null
132 129
      */
133
-    public function findOneByIdAndSettings($uid, $settings = [])
134
-    {
130
+    public function findOneByIdAndSettings($uid, $settings = []) {
135 131
         $settings = ['documentSets' => $uid];
136 132
 
137 133
         return $this->findDocumentsBySettings($settings)->getFirst();
@@ -144,8 +140,7 @@  discard block
 block discarded – undo
144 140
      *
145 141
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
146 142
      */
147
-    public function findDocumentsBySettings($settings = [])
148
-    {
143
+    public function findDocumentsBySettings($settings = []) {
149 144
         $query = $this->createQuery();
150 145
 
151 146
         $constraints = [];
@@ -175,8 +170,7 @@  discard block
 block discarded – undo
175 170
      *
176 171
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
177 172
      */
178
-    public function findAllByCollectionsLimited($collections, $limit = 50)
179
-    {
173
+    public function findAllByCollectionsLimited($collections, $limit = 50) {
180 174
         $query = $this->createQuery();
181 175
 
182 176
         // order by start_date -> start_time...
@@ -213,8 +207,7 @@  discard block
 block discarded – undo
213 207
      *
214 208
      * @return array
215 209
      */
216
-    public function getStatisticsForSelectedCollection($settings)
217
-    {
210
+    public function getStatisticsForSelectedCollection($settings) {
218 211
         if ($settings['collections']) {
219 212
             // Include only selected collections.
220 213
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -348,8 +341,7 @@  discard block
 block discarded – undo
348 341
      *
349 342
      * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface
350 343
      */
351
-    public function getTableOfContentsFromDb($uid, $pid, $settings)
352
-    {
344
+    public function getTableOfContentsFromDb($uid, $pid, $settings) {
353 345
         // Build table of contents from database.
354 346
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
355 347
             ->getQueryBuilderForTable('tx_dlf_documents');
@@ -397,8 +389,7 @@  discard block
 block discarded – undo
397 389
      *
398 390
      * @return array The found document object
399 391
      */
400
-    public function getOaiRecord($settings, $parameters)
401
-    {
392
+    public function getOaiRecord($settings, $parameters) {
402 393
         $where = '';
403 394
 
404 395
         if (!$settings['show_userdefined']) {
@@ -438,8 +429,7 @@  discard block
 block discarded – undo
438 429
      *
439 430
      * @return array The found document objects
440 431
      */
441
-    public function getOaiDocumentList($settings, $documentsToProcess)
442
-    {
432
+    public function getOaiDocumentList($settings, $documentsToProcess) {
443 433
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)
444 434
             ->getConnectionForTable('tx_dlf_documents');
445 435
 
@@ -474,8 +464,7 @@  discard block
 block discarded – undo
474 464
      *
475 465
      * @return array
476 466
      */
477
-    public function findAllByUids($uids, $checkPartof = false)
478
-    {
467
+    public function findAllByUids($uids, $checkPartof = false) {
479 468
         // get all documents from db we are talking about
480 469
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
481 470
         $queryBuilder = $connectionPool->getQueryBuilderForTable('tx_dlf_documents');
@@ -524,8 +513,7 @@  discard block
 block discarded – undo
524 513
      *
525 514
      * @return array
526 515
      */
527
-    public function findChildrenOfEach(array $uids)
528
-    {
516
+    public function findChildrenOfEach(array $uids) {
529 517
         $allDocuments = $this->findAllByUids($uids, true);
530 518
 
531 519
         $result = [];
@@ -546,8 +534,7 @@  discard block
 block discarded – undo
546 534
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\QueryResult $listedMetadata
547 535
      * @return array
548 536
      */
549
-    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null)
550
-    {
537
+    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null) {
551 538
         // set settings global inside this repository
552 539
         // (may be necessary when SolrSearch calls back)
553 540
         $this->settings = $settings;
Please login to merge, or discard this patch.
Tests/Functional/Common/HelperTest.php 1 patch
Braces   +4 added lines, -8 removed lines patch added patch discarded remove patch
@@ -6,8 +6,7 @@  discard block
 block discarded – undo
6 6
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
7 7
 use TYPO3\CMS\Core\Localization\LanguageService;
8 8
 
9
-class HelperTest extends FunctionalTestCase
10
-{
9
+class HelperTest extends FunctionalTestCase {
11 10
     public function setUp(): void
12 11
     {
13 12
         parent::setUp();
@@ -19,8 +18,7 @@  discard block
 block discarded – undo
19 18
     /**
20 19
      * @test
21 20
      */
22
-    public function canGetIndexNameFromUid()
23
-    {
21
+    public function canGetIndexNameFromUid() {
24 22
         // Repeat to make sure caching isn't broken
25 23
         for ($n = 0; $n < 2; $n++) {
26 24
             // Good UID, no PID
@@ -69,8 +67,7 @@  discard block
 block discarded – undo
69 67
      * @test
70 68
      * @group getLanguageName
71 69
      */
72
-    public function canTranslateLanguageNameToEnglish()
73
-    {
70
+    public function canTranslateLanguageNameToEnglish() {
74 71
         // NOTE: This only tests in BE mode
75 72
 
76 73
         $this->initLanguageService('default');
@@ -84,8 +81,7 @@  discard block
 block discarded – undo
84 81
      * @test
85 82
      * @group getLanguageName
86 83
      */
87
-    public function canTranslateLanguageNameToGerman()
88
-    {
84
+    public function canTranslateLanguageNameToGerman() {
89 85
         // NOTE: This only tests in BE mode
90 86
 
91 87
         $this->initLanguageService('de');
Please login to merge, or discard this patch.
Tests/Functional/Common/MetsDocumentTest.php 1 patch
Braces   +7 added lines, -14 removed lines patch added patch discarded remove patch
@@ -5,8 +5,7 @@  discard block
 block discarded – undo
5 5
 use Kitodo\Dlf\Common\Doc;
6 6
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
7 7
 
8
-class MetsDocumentTest extends FunctionalTestCase
9
-{
8
+class MetsDocumentTest extends FunctionalTestCase {
10 9
     public function setUp(): void
11 10
     {
12 11
         parent::setUp();
@@ -15,8 +14,7 @@  discard block
 block discarded – undo
15 14
         $this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
16 15
     }
17 16
 
18
-    protected function doc(string $file)
19
-    {
17
+    protected function doc(string $file) {
20 18
         $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
21 19
         $doc = Doc::getInstance($url);
22 20
         $this->assertNotNull($doc);
@@ -26,8 +24,7 @@  discard block
 block discarded – undo
26 24
     /**
27 25
      * @test
28 26
      */
29
-    public function canParseDmdAndAmdSec()
30
-    {
27
+    public function canParseDmdAndAmdSec() {
31 28
         $doc = $this->doc('av_beispiel.xml');
32 29
 
33 30
         $titledata = $doc->getTitledata(20000);
@@ -45,8 +42,7 @@  discard block
 block discarded – undo
45 42
     /**
46 43
      * @test
47 44
      */
48
-    public function canReadFileMetadata()
49
-    {
45
+    public function canReadFileMetadata() {
50 46
         $doc = $this->doc('av_beispiel.xml');
51 47
 
52 48
         $thumbsMeta = $doc->getMetadata('FILE_0000_THUMBS', 20000);
@@ -61,8 +57,7 @@  discard block
 block discarded – undo
61 57
     /**
62 58
      * @test
63 59
      */
64
-    public function canGetLogicalStructure()
65
-    {
60
+    public function canGetLogicalStructure() {
66 61
         $doc = $this->doc('av_beispiel.xml');
67 62
 
68 63
         $toc = $doc->tableOfContents[0] ?? [];
@@ -98,8 +93,7 @@  discard block
 block discarded – undo
98 93
     /**
99 94
      * @test
100 95
      */
101
-    public function doesNotOverwriteFirstDmdSec()
102
-    {
96
+    public function doesNotOverwriteFirstDmdSec() {
103 97
         $doc = $this->doc('two_dmdsec.xml');
104 98
 
105 99
         $titledata = $doc->getTitledata(20000);
@@ -112,8 +106,7 @@  discard block
 block discarded – undo
112 106
     /**
113 107
      * @test
114 108
      */
115
-    public function returnsEmptyMetadataWhenNoDmdSec()
116
-    {
109
+    public function returnsEmptyMetadataWhenNoDmdSec() {
117 110
         $doc = $this->doc('two_dmdsec.xml');
118 111
 
119 112
         // DMD and AMD works
Please login to merge, or discard this patch.
Tests/Functional/FunctionalTestCase.php 1 patch
Braces   +7 added lines, -14 removed lines patch added patch discarded remove patch
@@ -67,8 +67,7 @@  discard block
 block discarded – undo
67 67
      */
68 68
     protected $httpClient;
69 69
 
70
-    public function __construct()
71
-    {
70
+    public function __construct() {
72 71
         parent::__construct();
73 72
 
74 73
         $this->configurationToUseInTestInstance['EXTENSIONS']['dlf'] = $this->getDlfConfiguration();
@@ -95,8 +94,7 @@  discard block
 block discarded – undo
95 94
         $this->addSiteConfig('dlf-testing', $this->baseUrl);
96 95
     }
97 96
 
98
-    protected function getDlfConfiguration()
99
-    {
97
+    protected function getDlfConfiguration() {
100 98
         return [
101 99
             'fileGrpImages' => 'DEFAULT,MAX',
102 100
             'fileGrpThumbs' => 'THUMBS',
@@ -134,8 +132,7 @@  discard block
 block discarded – undo
134 132
         ];
135 133
     }
136 134
 
137
-    protected function addSiteConfig($identifier, $baseUrl)
138
-    {
135
+    protected function addSiteConfig($identifier, $baseUrl) {
139 136
         $siteConfig = Yaml::parseFile(__DIR__ . '/../Fixtures/siteconfig.yaml');
140 137
         $siteConfig['base'] = $baseUrl;
141 138
         $siteConfig['languages'][0]['base'] = $baseUrl;
@@ -145,8 +142,7 @@  discard block
 block discarded – undo
145 142
         file_put_contents($siteConfigPath . '/config.yaml', Yaml::dump($siteConfig));
146 143
     }
147 144
 
148
-    protected function initializeRepository(string $className, int $storagePid)
149
-    {
145
+    protected function initializeRepository(string $className, int $storagePid) {
150 146
         $repository = $this->objectManager->get($className);
151 147
 
152 148
         $querySettings = $this->objectManager->get(Typo3QuerySettings::class);
@@ -156,8 +152,7 @@  discard block
 block discarded – undo
156 152
         return $repository;
157 153
     }
158 154
 
159
-    protected function importSolrDocuments(Solr $solr, string $path)
160
-    {
155
+    protected function importSolrDocuments(Solr $solr, string $path) {
161 156
         $jsonDocuments = json_decode(file_get_contents($path), true);
162 157
 
163 158
         $updateQuery = $solr->service->createUpdate();
@@ -176,8 +171,7 @@  discard block
 block discarded – undo
176 171
         $solr->service->update($updateQuery);
177 172
     }
178 173
 
179
-    protected function initLanguageService(string $locale)
180
-    {
174
+    protected function initLanguageService(string $locale) {
181 175
         if (class_exists(\TYPO3\CMS\Core\Localization\LanguageServiceFactory::class)) {
182 176
             $GLOBALS['LANG'] = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Localization\LanguageServiceFactory::class)->create($locale);
183 177
         } else {
@@ -193,8 +187,7 @@  discard block
 block discarded – undo
193 187
     /**
194 188
      * Assert that $sub is recursively contained within $super.
195 189
      */
196
-    protected function assertArrayMatches(array $sub, array $super, string $message = '')
197
-    {
190
+    protected function assertArrayMatches(array $sub, array $super, string $message = '') {
198 191
         $this->assertEquals($sub, ArrayUtility::intersectRecursive($super, $sub), $message);
199 192
     }
200 193
 }
Please login to merge, or discard this patch.
Classes/Hooks/ItemsProcFunc.php 1 patch
Braces   +4 added lines, -8 removed lines patch added patch discarded remove patch
@@ -28,8 +28,7 @@  discard block
 block discarded – undo
28 28
  * @subpackage dlf
29 29
  * @access public
30 30
  */
31
-class ItemsProcFunc implements LoggerAwareInterface
32
-{
31
+class ItemsProcFunc implements LoggerAwareInterface {
33 32
     use LoggerAwareTrait;
34 33
 
35 34
     /**
@@ -46,8 +45,7 @@  discard block
 block discarded – undo
46 45
      *
47 46
      * @return void
48 47
      */
49
-    public function toolList(&$params)
50
-    {
48
+    public function toolList(&$params) {
51 49
         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'] as $class => $label) {
52 50
             $params['items'][] = [Helper::getLanguageService()->sL($label), $class];
53 51
         }
@@ -97,8 +95,7 @@  discard block
 block discarded – undo
97 95
      *
98 96
      * @return void
99 97
      */
100
-    public function extendedSearchList(&$params)
101
-    {
98
+    public function extendedSearchList(&$params) {
102 99
         $this->generateList(
103 100
             $params,
104 101
             'label,index_name',
@@ -139,8 +136,7 @@  discard block
 block discarded – undo
139 136
      *
140 137
      * @return void
141 138
      */
142
-    protected function generateList(&$params, $fields, $table, $sorting, $andWhere = '')
143
-    {
139
+    protected function generateList(&$params, $fields, $table, $sorting, $andWhere = '') {
144 140
         $this->getTyposcriptConfigFromPluginSiteRoot($params);
145 141
 
146 142
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
Please login to merge, or discard this patch.
Classes/Controller/TableOfContentsController.php 1 patch
Braces   +8 added lines, -16 removed lines patch added patch discarded remove patch
@@ -24,8 +24,7 @@  discard block
 block discarded – undo
24 24
  * @subpackage dlf
25 25
  * @access public
26 26
  */
27
-class TableOfContentsController extends AbstractController
28
-{
27
+class TableOfContentsController extends AbstractController {
29 28
     /**
30 29
      * This holds the active entries according to the currently selected page
31 30
      *
@@ -45,8 +44,7 @@  discard block
 block discarded – undo
45 44
      *
46 45
      * @return void
47 46
      */
48
-    public function filterAction()
49
-    {
47
+    public function filterAction() {
50 48
         // if filter was triggered, get filter parameters from POST variables
51 49
         $this->filterParams = $this->getParametersSafely('filterParameter');
52 50
 
@@ -59,8 +57,7 @@  discard block
 block discarded – undo
59 57
      *
60 58
      * @return void
61 59
      */
62
-    public function mainAction()
63
-    {
60
+    public function mainAction() {
64 61
         // Load current document.
65 62
         $this->loadDocument($this->requestData);
66 63
         if (
@@ -91,8 +88,7 @@  discard block
 block discarded – undo
91 88
      * @access protected
92 89
      * @return array HMENU array
93 90
      */
94
-    protected function makeMenuArray()
95
-    {
91
+    protected function makeMenuArray() {
96 92
         // Set default values for page if not set.
97 93
         // $this->requestData['page'] may be integer or string (physical structure @ID)
98 94
         if (
@@ -168,8 +164,7 @@  discard block
 block discarded – undo
168 164
      *
169 165
      * @return array HMENU array
170 166
      */
171
-    protected function makeMenuFor3DObjects()
172
-    {
167
+    protected function makeMenuFor3DObjects() {
173 168
         $menuArray = [];
174 169
 
175 170
         // Go through table of contents and create all menu entries.
@@ -192,8 +187,7 @@  discard block
 block discarded – undo
192 187
      *
193 188
      * @return array HMENU array for menu entry
194 189
      */
195
-    protected function getMenuEntry(array $entry, $recursive = false)
196
-    {
190
+    protected function getMenuEntry(array $entry, $recursive = false) {
197 191
         $entry = $this->resolveMenuEntry($entry);
198 192
 
199 193
         $entryArray = [];
@@ -287,8 +281,7 @@  discard block
 block discarded – undo
287 281
      * @param array $entry
288 282
      * @return array
289 283
      */
290
-    protected function resolveMenuEntry($entry)
291
-    {
284
+    protected function resolveMenuEntry($entry) {
292 285
         // If the menu entry points to the parent document,
293 286
         // resolve to the parent UID set on indexation.
294 287
         $doc = $this->document->getDoc();
@@ -304,8 +297,7 @@  discard block
 block discarded – undo
304 297
         return $entry;
305 298
     }
306 299
 
307
-    protected function getMenuEntryWithImage(array $entry, $recursive = false)
308
-    {
300
+    protected function getMenuEntryWithImage(array $entry, $recursive = false) {
309 301
         $entryArray = [];
310 302
 
311 303
         // don't filter if the entry type is collection or search params are empty
Please login to merge, or discard this patch.