Erikmitk / kitodo-presentation

Tests/Functional/Common/SolrIndexingTest.php

Spacing +6 added lines, -6 removed lines

@@ -45,9 +45,9 @@ 
         $this->documentRepository = $this->initializeRepository(DocumentRepository::class, 20000);
         $this->solrCoreRepository = $this->initializeRepository(SolrCoreRepository::class, 20000);
 
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/documents_1.csv');
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/libraries.csv');
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/metadata.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/documents_1.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/libraries.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/metadata.csv');
     }
 
     /**
@@ -128,9 +128,9 @@ 
     {
         $core = $this->createSolrCore();
 
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/documents_fulltext.csv');
-        $this->importSolrDocuments($core->solr, __DIR__ . '/../../Fixtures/Common/documents_1.solr.json');
-        $this->importSolrDocuments($core->solr, __DIR__ . '/../../Fixtures/Common/documents_fulltext.solr.json');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/documents_fulltext.csv');
+        $this->importSolrDocuments($core->solr, __DIR__.'/../../Fixtures/Common/documents_1.solr.json');
+        $this->importSolrDocuments($core->solr, __DIR__.'/../../Fixtures/Common/documents_fulltext.solr.json');
 
         $collections = $this->collectionRepository->findCollectionsBySettings([
             'index_name' => ['Musik', 'Projekt: Dresdner Hefte'],

Braces +5 added lines, -10 removed lines

@@ -23,8 +23,7 @@ 
 use TYPO3\CMS\Core\Core\Bootstrap;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-class SolrIndexingTest extends FunctionalTestCase
-{
+class SolrIndexingTest extends FunctionalTestCase {
     /** @var CollectionRepository */
     protected $collectionRepository;
 
@@ -53,8 +52,7 @@ 
     /**
      * @test
      */
-    public function canCreateCore()
-    {
+    public function canCreateCore() {
         $coreName = uniqid('testCore');
         $solr = Solr::getInstance($coreName);
         self::assertNull($solr->core);
@@ -69,8 +67,7 @@ 
     /**
      * @test
      */
-    public function canIndexAndSearchDocument()
-    {
+    public function canIndexAndSearchDocument() {
         $core = $this->createSolrCore();
 
         $document = $this->documentRepository->findByUid(1001);
@@ -124,8 +121,7 @@ 
     /**
      * @test
      */
-    public function canSearchInCollections()
-    {
+    public function canSearchInCollections() {
         $core = $this->createSolrCore();
 
         $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/documents_fulltext.csv');
@@ -165,8 +161,7 @@ 
     /**
      * @test
      */
-    public function canGetIndexFieldName()
-    {
+    public function canGetIndexFieldName() {
         $this->assertEquals('title_usi', Indexer::getIndexFieldName('title', 20000));
         $this->assertEquals('year_uuu', Indexer::getIndexFieldName('year', 20000));
         $this->assertEquals('', Indexer::getIndexFieldName('title'));

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

@@ -94,11 +94,11 @@
         self::assertEquals(15, $solrSearch->getNumFound());
 
         // Check that the title stored in Solr matches the title of database entry
-        $docTitleInSolr = false;
+        $docTitleInSolr = FALSE;
         foreach ($solrSearch->getSolrResults()['documents'] as $solrDoc) {
             if ($solrDoc['toplevel'] && intval($solrDoc['uid']) === intval($document->getUid())) {
                 self::assertEquals($document->getTitle(), $solrDoc['title']);
-                $docTitleInSolr = true;
+                $docTitleInSolr = TRUE;
                 break;
             }
         }

Tests/Functional/Common/SolrSearchQueryTest.php

Spacing +4 added lines, -4 removed lines

@@ -23,13 +23,13 @@
     private $solrCoreRepository;
 
     private static array $databaseFixtures = [
-        __DIR__ . '/../../Fixtures/Common/documents_1.csv',
-        __DIR__ . '/../../Fixtures/Common/pages.csv',
-        __DIR__ . '/../../Fixtures/Common/solrcores.csv'
+        __DIR__.'/../../Fixtures/Common/documents_1.csv',
+        __DIR__.'/../../Fixtures/Common/pages.csv',
+        __DIR__.'/../../Fixtures/Common/solrcores.csv'
     ];
 
     private static array $solrFixtures = [
-        __DIR__ . '/../../Fixtures/Common/documents_1.solr.json'
+        __DIR__.'/../../Fixtures/Common/documents_1.solr.json'
     ];
 
     public function setUp(): void

Braces +3 added lines, -6 removed lines

@@ -18,8 +18,7 @@ 
 use Kitodo\Dlf\Domain\Repository\SolrCoreRepository;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 
-class SolrSearchQueryTest extends FunctionalTestCase
-{
+class SolrSearchQueryTest extends FunctionalTestCase {
     private $solrCoreRepository;
 
     private static array $databaseFixtures = [
@@ -43,8 +42,7 @@ 
      * @test
      * @ignore
      */
-    public function canExecute()
-    {
+    public function canExecute() {
         $documentRepository = $this->initializeRepository(DocumentRepository::class, 0);
         $settings = ['solrcore' => 4, 'storagePid' => 0];
 
@@ -68,8 +66,7 @@ 
         $this->initializeRepository(DocumentRepository::class, 0);
     }
 
-    protected function setUpSolr($uid, $storagePid, $solrFixtures)
-    {
+    protected function setUpSolr($uid, $storagePid, $solrFixtures) {
         $this->solrCoreRepository = $this->initializeRepository(SolrCoreRepository::class, $storagePid);
 
         // Setup Solr only once for all tests in this suite

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

@@ -73,9 +73,9 @@
         $this->solrCoreRepository = $this->initializeRepository(SolrCoreRepository::class, $storagePid);
 
         // Setup Solr only once for all tests in this suite
-        static $solr = null;
+        static $solr = NULL;
 
-        if ($solr === null) {
+        if ($solr === NULL) {
             $coreName = Solr::createCore();
             $solr = Solr::getInstance($coreName);
             foreach ($solrFixtures as $filePath) {

Tests/Functional/Common/SolrTest.php

Spacing +4 added lines, -4 removed lines

@@ -21,13 +21,13 @@
 {
 
     private static array $databaseFixtures = [
-        __DIR__ . '/../../Fixtures/Common/documents_1.csv',
-        __DIR__ . '/../../Fixtures/Common/pages.csv',
-        __DIR__ . '/../../Fixtures/Common/solrcores.csv'
+        __DIR__.'/../../Fixtures/Common/documents_1.csv',
+        __DIR__.'/../../Fixtures/Common/pages.csv',
+        __DIR__.'/../../Fixtures/Common/solrcores.csv'
     ];
 
     private static array $solrFixtures = [
-        __DIR__ . '/../../Fixtures/Common/documents_1.solr.json'
+        __DIR__.'/../../Fixtures/Common/documents_1.solr.json'
     ];
 
     /**

Braces +7 added lines, -14 removed lines

@@ -17,8 +17,7 @@ 
 use Kitodo\Dlf\Domain\Repository\SolrCoreRepository;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 
-class SolrTest extends FunctionalTestCase
-{
+class SolrTest extends FunctionalTestCase {
 
     private static array $databaseFixtures = [
         __DIR__ . '/../../Fixtures/Common/documents_1.csv',
@@ -33,8 +32,7 @@ 
     /**
      * @test
      */
-    public function canCreateCore()
-    {
+    public function canCreateCore() {
         $this->assertEquals('newCoreName', Solr::createCore('newCoreName'));
         $this->assertEquals('newCoreName', Solr::getInstance('newCoreName')->core);
     }
@@ -42,8 +40,7 @@ 
     /**
      * @test
      */
-    public function canEscapeQuery()
-    {
+    public function canEscapeQuery() {
         $query1 = Solr::escapeQuery('"custom query with special characters: "testvalue"\n"');
         $this->assertEquals('"custom query with special characters\: "testvalue"\\\\n"', $query1);
 
@@ -54,8 +51,7 @@ 
     /**
      * @test
      */
-    public function canEscapeQueryKeepField()
-    {
+    public function canEscapeQueryKeepField() {
         $query1 = Solr::escapeQueryKeepField('abc_uui:(abc)', 0);
         $this->assertEquals('abc_uui\:(abc)', $query1);
     }
@@ -63,8 +59,7 @@ 
     /**
      * @test
      */
-    public function canGetNextCoreNumber()
-    {
+    public function canGetNextCoreNumber() {
         $this->assertEquals(5, Solr::getNextCoreNumber());
         $this->assertEquals(5, Solr::getNextCoreNumber());
         Solr::createCore();
@@ -74,8 +69,7 @@ 
     /**
      * @test
      */
-    public function canSearchRaw()
-    {
+    public function canSearchRaw() {
         $this->setUpData(self::$databaseFixtures);
         $solr = $this->setUpSolr(4, 0, self::$solrFixtures);
         $resultSet = $solr->searchRaw(['core' => 4, 'collection' => 1]);
@@ -92,8 +86,7 @@ 
         $this->initializeRepository(DocumentRepository::class, 0);
     }
 
-    protected function setUpSolr($uid, $storagePid, $solrFixtures)
-    {
+    protected function setUpSolr($uid, $storagePid, $solrFixtures) {
         $solrCoreRepository = $this->initializeRepository(SolrCoreRepository::class, $storagePid);
 
         // Setup Solr only once for all tests in this suite

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

@@ -97,9 +97,9 @@
         $solrCoreRepository = $this->initializeRepository(SolrCoreRepository::class, $storagePid);
 
         // Setup Solr only once for all tests in this suite
-        static $solr = null;
+        static $solr = NULL;
 
-        if ($solr === null) {
+        if ($solr === NULL) {
             $coreName = Solr::createCore();
             $solr = Solr::getInstance($coreName);
             foreach ($solrFixtures as $filePath) {

Tests/Functional/FunctionalTestCase.php

Spacing +7 added lines, -7 removed lines

@@ -98,7 +98,7 @@ 
         $this->configurationToUseInTestInstance['EXTENSIONS']['dlf'] = $this->getDlfConfiguration();
 
         if ($this->disableJsonWrappedResponse) {
-            $this->frameworkExtensionsToLoad = array_filter($this->frameworkExtensionsToLoad, function ($ext) {
+            $this->frameworkExtensionsToLoad = array_filter($this->frameworkExtensionsToLoad, function($ext) {
                 return $ext !== 'Resources/Core/Functional/Extensions/json_response';
             });
         }
@@ -111,9 +111,9 @@ 
         $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
         $this->persistenceManager = GeneralUtility::makeInstance(PersistenceManager::class);
 
-        $this->baseUrl = 'http://web:8000/public/typo3temp/var/tests/functional-' . $this->identifier . '/';
+        $this->baseUrl = 'http://web:8000/public/typo3temp/var/tests/functional-'.$this->identifier.'/';
         $this->httpClient = new HttpClient([
-            'base_uri' => $this->baseUrl . 'index.php',
+            'base_uri' => $this->baseUrl.'index.php',
             'http_errors' => false,
         ]);
 
@@ -164,13 +164,13 @@ 
 
     protected function addSiteConfig($identifier)
     {
-        $siteConfig = Yaml::parseFile(__DIR__ . '/../Fixtures/siteconfig.yaml');
+        $siteConfig = Yaml::parseFile(__DIR__.'/../Fixtures/siteconfig.yaml');
         $siteConfig['base'] = $this->baseUrl;
         $siteConfig['languages'][0]['base'] = $this->baseUrl;
 
-        $siteConfigPath = $this->instancePath . '/typo3conf/sites/' . $identifier;
+        $siteConfigPath = $this->instancePath.'/typo3conf/sites/'.$identifier;
         @mkdir($siteConfigPath, 0775, true);
-        file_put_contents($siteConfigPath . '/config.yaml', Yaml::dump($siteConfig));
+        file_put_contents($siteConfigPath.'/config.yaml', Yaml::dump($siteConfig));
     }
 
     protected function initializeRepository(string $className, int $storagePid)
@@ -189,7 +189,7 @@ 
         $jsonDocuments = json_decode(file_get_contents($path), true);
 
         $updateQuery = $solr->service->createUpdate();
-        $documents = array_map(function ($jsonDoc) use ($updateQuery) {
+        $documents = array_map(function($jsonDoc) use ($updateQuery) {
             $document = $updateQuery->createDocument();
             foreach ($jsonDoc as $key => $value) {
                 $document->setField($key, $value);

Braces +7 added lines, -14 removed lines

@@ -91,8 +91,7 @@ 
      */
     protected $httpClient;
 
-    public function __construct()
-    {
+    public function __construct() {
         parent::__construct();
 
         $this->configurationToUseInTestInstance['EXTENSIONS']['dlf'] = $this->getDlfConfiguration();
@@ -120,8 +119,7 @@ 
         $this->addSiteConfig('dlf-testing');
     }
 
-    protected function getDlfConfiguration()
-    {
+    protected function getDlfConfiguration() {
         $dotenv = Dotenv::createImmutable('/home/runner/work/kitodo-presentation/kitodo-presentation/Build/Test/', 'test.env');
         $dotenv->load();
 
@@ -162,8 +160,7 @@ 
         ];
     }
 
-    protected function addSiteConfig($identifier)
-    {
+    protected function addSiteConfig($identifier) {
         $siteConfig = Yaml::parseFile(__DIR__ . '/../Fixtures/siteconfig.yaml');
         $siteConfig['base'] = $this->baseUrl;
         $siteConfig['languages'][0]['base'] = $this->baseUrl;
@@ -173,8 +170,7 @@ 
         file_put_contents($siteConfigPath . '/config.yaml', Yaml::dump($siteConfig));
     }
 
-    protected function initializeRepository(string $className, int $storagePid)
-    {
+    protected function initializeRepository(string $className, int $storagePid) {
         $repository = $this->objectManager->get($className);
 
         $querySettings = $this->objectManager->get(Typo3QuerySettings::class);
@@ -184,8 +180,7 @@ 
         return $repository;
     }
 
-    protected function importSolrDocuments(Solr $solr, string $path)
-    {
+    protected function importSolrDocuments(Solr $solr, string $path) {
         $jsonDocuments = json_decode(file_get_contents($path), true);
 
         $updateQuery = $solr->service->createUpdate();
@@ -204,16 +199,14 @@ 
         $solr->service->update($updateQuery);
     }
 
-    protected function initLanguageService(string $locale)
-    {
+    protected function initLanguageService(string $locale) {
         $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->create($locale);
     }
 
     /**
      * Assert that $sub is recursively contained within $super.
      */
-    protected function assertArrayMatches(array $sub, array $super, string $message = '')
-    {
+    protected function assertArrayMatches(array $sub, array $super, string $message = '') {
         self::assertEquals($sub, ArrayUtility::intersectRecursive($super, $sub), $message);
     }
 }

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

@@ -49,7 +49,7 @@ 
         ],
         'FE' => [
             'cacheHash' => [
-                'enforceValidation' => false,
+                'enforceValidation' => FALSE,
             ],
         ],
         'DB' => [
@@ -69,7 +69,7 @@ 
      *
      * @var bool
      */
-    protected $disableJsonWrappedResponse = false;
+    protected $disableJsonWrappedResponse = FALSE;
 
     /**
      * @var ObjectManager
@@ -114,7 +114,7 @@ 
         $this->baseUrl = 'http://web:8000/public/typo3temp/var/tests/functional-' . $this->identifier . '/';
         $this->httpClient = new HttpClient([
             'base_uri' => $this->baseUrl . 'index.php',
-            'http_errors' => false,
+            'http_errors' => FALSE,
         ]);
 
         $this->addSiteConfig('dlf-testing');
@@ -169,7 +169,7 @@ 
         $siteConfig['languages'][0]['base'] = $this->baseUrl;
 
         $siteConfigPath = $this->instancePath . '/typo3conf/sites/' . $identifier;
-        @mkdir($siteConfigPath, 0775, true);
+        @mkdir($siteConfigPath, 0775, TRUE);
         file_put_contents($siteConfigPath . '/config.yaml', Yaml::dump($siteConfig));
     }
 
@@ -186,7 +186,7 @@ 
 
     protected function importSolrDocuments(Solr $solr, string $path)
     {
-        $jsonDocuments = json_decode(file_get_contents($path), true);
+        $jsonDocuments = json_decode(file_get_contents($path), TRUE);
 
         $updateQuery = $solr->service->createUpdate();
         $documents = array_map(function ($jsonDoc) use ($updateQuery) {

Classes/Command/DeleteCommand.php

Braces +1 added lines, -2 removed lines

@@ -31,8 +31,7 @@
  *
  * @access public
  */
-class DeleteCommand extends BaseCommand
-{
+class DeleteCommand extends BaseCommand {
 
     /**
      * Configure the command by defining the name, options and arguments

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

@@ -146,7 +146,7 @@ 
     {
         $document = $this->getDocument($input);
 
-        if ($document === null) {
+        if ($document === NULL) {
             $io->info('INFO: Document with UID "' . $input->getOption('doc') . '" could not be found on PID ' . $this->storagePid . '. It is probably already deleted from DB.');
         } else {
             if ($io->isVerbose()) {
@@ -177,7 +177,7 @@ 
             $io->section('Deleting ' . $input->getOption('doc') . ' on Solr core ' . $solrCoreUid . '.');
         }
 
-        $isDeleted = false;
+        $isDeleted = FALSE;
         if (MathUtility::canBeInterpretedAsInteger($input->getOption('doc'))) {
             $isDeleted = Indexer::delete($input, 'uid', $solrCoreUid);
 
@@ -206,12 +206,12 @@ 
      */
     private function getDocument($input): ?Document
     {
-        $document = null;
+        $document = NULL;
 
         if (MathUtility::canBeInterpretedAsInteger($input->getOption('doc'))) {
             $document = $this->documentRepository->findByUid($input->getOption('doc'));
         } elseif (GeneralUtility::isValidUrl($input->getOption('doc'))) {
-            $doc = AbstractDocument::getInstance($input->getOption('doc'), ['storagePid' => $this->storagePid], true);
+            $doc = AbstractDocument::getInstance($input->getOption('doc'), ['storagePid' => $this->storagePid], TRUE);
 
             if ($doc->recordId) {
                 $document = $this->documentRepository->findOneByRecordId($doc->recordId);

Spacing +9 added lines, -9 removed lines

@@ -84,7 +84,7 @@ 
         $this->initializeRepositories((int) $input->getOption('pid'));
 
         if ($this->storagePid == 0) {
-            $io->error('ERROR: No valid PID (' . $this->storagePid . ') given.');
+            $io->error('ERROR: No valid PID ('.$this->storagePid.') given.');
             return BaseCommand::FAILURE;
         }
 
@@ -99,13 +99,13 @@ 
             if (empty($solrCoreUid) || !in_array($solrCoreUid, $allSolrCores)) {
                 $outputSolrCores = [];
                 foreach ($allSolrCores as $indexName => $uid) {
-                    $outputSolrCores[] = $uid . ' : ' . $indexName;
+                    $outputSolrCores[] = $uid.' : '.$indexName;
                 }
                 if (empty($outputSolrCores)) {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. No valid cores found on PID ' . $this->storagePid . ".\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. No valid cores found on PID '.$this->storagePid.".\n");
                     return BaseCommand::FAILURE;
                 } else {
-                    $io->error('ERROR: No valid Solr core ("' . $input->getOption('solr') . '") given. ' . "Valid cores are (<uid>:<index_name>):\n" . implode("\n", $outputSolrCores) . "\n");
+                    $io->error('ERROR: No valid Solr core ("'.$input->getOption('solr').'") given. '."Valid cores are (<uid>:<index_name>):\n".implode("\n", $outputSolrCores)."\n");
                     return BaseCommand::FAILURE;
                 }
             }
@@ -147,15 +147,15 @@ 
         $document = $this->getDocument($input);
 
         if ($document === null) {
-            $io->info('INFO: Document with UID "' . $input->getOption('doc') . '" could not be found on PID ' . $this->storagePid . '. It is probably already deleted from DB.');
+            $io->info('INFO: Document with UID "'.$input->getOption('doc').'" could not be found on PID '.$this->storagePid.'. It is probably already deleted from DB.');
         } else {
             if ($io->isVerbose()) {
-                $io->section('Deleting ' . $document->getUid() . ' ("' . $document->getLocation() . '") on PID ' . $this->storagePid . '.');
+                $io->section('Deleting '.$document->getUid().' ("'.$document->getLocation().'") on PID '.$this->storagePid.'.');
             }
             $this->documentRepository->remove($document);
             $this->persistenceManager->persistAll();
             if ($io->isVerbose()) {
-                $io->success('Deleted ' . $document->getUid() . ' ("' . $document->getLocation() . '") on PID ' . $this->storagePid . '.');
+                $io->success('Deleted '.$document->getUid().' ("'.$document->getLocation().'") on PID '.$this->storagePid.'.');
             }
         }
     }
@@ -174,7 +174,7 @@ 
     private function deleteFromSolr($input, $io, $solrCoreUid): void
     {
         if ($io->isVerbose()) {
-            $io->section('Deleting ' . $input->getOption('doc') . ' on Solr core ' . $solrCoreUid . '.');
+            $io->section('Deleting '.$input->getOption('doc').' on Solr core '.$solrCoreUid.'.');
         }
 
         $isDeleted = false;
@@ -187,7 +187,7 @@ 
 
         if ($isDeleted) {
             if ($io->isVerbose()) {
-                $io->success('Deleted ' . $input->getOption('doc') . ' on Solr core ' . $solrCoreUid . '.');
+                $io->success('Deleted '.$input->getOption('doc').' on Solr core '.$solrCoreUid.'.');
             }
             $io->success('All done!');
         } else {

Classes/Common/MetsDocument.php

Braces +5 added lines, -10 removed lines

@@ -63,8 +63,7 @@ 
  * @property-read \SimpleXMLElement $mets this holds the XML file's METS part as \SimpleXMLElement object
  * @property-read string $parentHref URL of the parent document (determined via mptr element), or empty string if none is available
  */
-final class MetsDocument extends AbstractDocument
-{
+final class MetsDocument extends AbstractDocument {
     /**
      * @access protected
      * @var string[] Subsections / tags that may occur within `<mets:amdSec>`
@@ -397,8 +396,7 @@ 
      *
      * @return ?string thumbnail or null if not found
      */
-    private function getThumbnail(string $id = '')
-    {
+    private function getThumbnail(string $id = '') {
         // Load plugin configuration.
         $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
         $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
@@ -726,8 +724,7 @@ 
      *
      * @return bool true if extraction successful, false otherwise
      */
-    private function extractMetadataIfTypeSupported(string $dmdId, string $mdSectionType, array &$metadata)
-    {
+    private function extractMetadataIfTypeSupported(string $dmdId, string $mdSectionType, array &$metadata) {
         // Is this metadata format supported?
         if (!empty($this->formats[$this->mdSec[$dmdId]['type']])) {
             if (!empty($this->formats[$this->mdSec[$dmdId]['type']]['class'])) {
@@ -759,8 +756,7 @@ 
      *
      * @return array additional metadata data queried from database
      */
-    private function getAdditionalMetadataFromDatabase(int $cPid, string $dmdId)
-    {
+    private function getAdditionalMetadataFromDatabase(int $cPid, string $dmdId) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_metadata');
         // Get hidden records, too.
@@ -905,8 +901,7 @@ 
     /**
      * @see AbstractDocument::getStructureDepth()
      */
-    public function getStructureDepth(string $logId)
-    {
+    public function getStructureDepth(string $logId) {
         $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);

Spacing +30 added lines, -30 removed lines

@@ -188,7 +188,7 @@ 
     {
         $file = $this->getFileInfo($id);
         if ($file['mimeType'] === 'application/vnd.kitodo.iiif') {
-            $file['location'] = (strrpos($file['location'], 'info.json') === strlen($file['location']) - 9) ? $file['location'] : (strrpos($file['location'], '/') === strlen($file['location']) ? $file['location'] . 'info.json' : $file['location'] . '/info.json');
+            $file['location'] = (strrpos($file['location'], 'info.json') === strlen($file['location']) - 9) ? $file['location'] : (strrpos($file['location'], '/') === strlen($file['location']) ? $file['location'].'info.json' : $file['location'].'/info.json');
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'iiif');
             IiifHelper::setUrlReader(IiifUrlReader::getInstance());
             IiifHelper::setMaxThumbnailHeight($conf['thumbnailHeight']);
@@ -198,9 +198,9 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($file['mimeType'] === 'application/vnd.netfpx') {
-            $baseURL = $file['location'] . (strpos($file['location'], '?') === false ? '?' : '');
+            $baseURL = $file['location'].(strpos($file['location'], '?') === false ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
-            return $baseURL . '&CVT=jpeg';
+            return $baseURL.'&CVT=jpeg';
         }
         return $file['location'];
     }
@@ -229,14 +229,14 @@ 
      */
     public function getFileLocation(string $id): string
     {
-        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
+        $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
             && !empty($location)
         ) {
             return (string) $location[0]->attributes('http://www.w3.org/1999/xlink')->href;
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '"');
+            $this->logger->warning('There is no file node with @ID "'.$id.'"');
             return '';
         }
     }
@@ -246,14 +246,14 @@ 
      */
     public function getFileMimeType(string $id): string
     {
-        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
+        $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="'.$id.'"]/@MIMETYPE');
         if (
             !empty($id)
             && !empty($mimetype)
         ) {
             return (string) $mimetype[0];
         } else {
-            $this->logger->warning('There is no file node with @ID "' . $id . '" or no MIME type specified');
+            $this->logger->warning('There is no file node with @ID "'.$id.'" or no MIME type specified');
             return '';
         }
     }
@@ -273,7 +273,7 @@ 
             return $this->logicalUnits[$id];
         } elseif (!empty($id)) {
             // Get specified logical unit.
-            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]');
+            $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]');
         } else {
             // Get all logical units at top level.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div');
@@ -461,7 +461,7 @@ 
         $cPid = max($cPid, 0);
         if ($cPid == 0 && ($this->cPid || $this->pid)) {
             // Retain current PID.
-            $cPid = $this->cPid ?: $this->pid;
+            $cPid = $this->cPid ? : $this->pid;
         }
         return $cPid;
     }
@@ -528,7 +528,7 @@ 
         if (isset($this->fileInfos[$id]) || in_array('dmdSec', $metadataSections)) {
             return $metadata;
         } else {
-            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "' . $id . '"');
+            $this->logger->warning('No supported descriptive metadata found for logical structure with @ID "'.$id.'"');
             return [];
         }
     }
@@ -547,7 +547,7 @@ 
         if (!empty($this->logicalUnits[$id])) {
             return [$this->logicalUnits[$id]['type']];
         } else {
-            $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]/@TYPE');
+            $struct = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]/@TYPE');
             if (!empty($struct)) {
                 return [(string) $struct[0]];
             }
@@ -690,13 +690,13 @@ 
             if ($resArray['format'] > 0 && !empty($resArray['xpath_sorting'])) {
                 $values = $domXPath->evaluate($resArray['xpath_sorting'], $domNode);
                 if ($values instanceof \DOMNodeList && $values->length > 0) {
-                    $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values->item(0)->nodeValue);
+                    $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values->item(0)->nodeValue);
                 } elseif (!($values instanceof \DOMNodeList)) {
-                    $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values);
+                    $metadata[$resArray['index_name'].'_sorting'][0] = trim((string) $values);
                 }
             }
-            if (empty($metadata[$resArray['index_name'] . '_sorting'][0])) {
-                $metadata[$resArray['index_name'] . '_sorting'][0] = $metadata[$resArray['index_name']][0];
+            if (empty($metadata[$resArray['index_name'].'_sorting'][0])) {
+                $metadata[$resArray['index_name'].'_sorting'][0] = $metadata[$resArray['index_name']][0];
             }
         }
     }
@@ -756,11 +756,11 @@ 
                         return true;
                     }
                 } else {
-                    $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
+                    $this->logger->warning('Invalid class/method "'.$class.'->extractMetadata()" for metadata format "'.$this->mdSec[$dmdId]['type'].'"');
                 }
             }
         } else {
-            $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
+            $this->logger->notice('Unsupported metadata format "'.$this->mdSec[$dmdId]['type'].'" in '.$mdSectionType.' with @ID "'.$dmdId.'"');
         }
         return false;
     }
@@ -867,7 +867,7 @@ 
             $dmdIds = $this->logicalUnits[$id]['dmdId'] ?? '';
             $admIds = $this->logicalUnits[$id]['admId'] ?? '';
         } else {
-            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $id . '"]')[0];
+            $mdSec = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$id.'"]')[0];
             if ($mdSec) {
                 $dmdIds = (string) $mdSec->attributes()->DMDID;
                 $admIds = (string) $mdSec->attributes()->ADMID;
@@ -897,7 +897,7 @@ 
 
         return array_filter(
             $allMdIds,
-            function ($element) {
+            function($element) {
                 return !empty($element);
             }
         );
@@ -923,7 +923,7 @@ 
      */
     public function getStructureDepth(string $logId)
     {
-        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
+        $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$logId.'"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
         } else {
@@ -947,9 +947,9 @@ 
             $this->registerNamespaces($this->mets);
         } else {
             if (!empty($location)) {
-                $this->logger->error('No METS part found in document with location "' . $location . '".');
+                $this->logger->error('No METS part found in document with location "'.$location.'".');
             } elseif (!empty($this->recordId)) {
-                $this->logger->error('No METS part found in document with recordId "' . $this->recordId . '".');
+                $this->logger->error('No METS part found in document with recordId "'.$this->recordId.'".');
             } else {
                 $this->logger->error('No METS part found in current document.');
             }
@@ -970,7 +970,7 @@ 
                 return true;
             }
         }
-        $this->logger->error('Could not load XML file from "' . $location . '"');
+        $this->logger->error('Could not load XML file from "'.$location.'"');
         return false;
     }
 
@@ -1093,10 +1093,10 @@ 
 
         if (!empty($mdType) && !empty($this->formats[(string) $mdType[0]])) {
             $type = (string) $mdType[0];
-            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
         } elseif (!empty($otherMdType) && !empty($this->formats[(string) $otherMdType[0]])) {
             $type = (string) $otherMdType[0];
-            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="' . $type . '"]/mets:xmlData/' . strtolower($type) . ':' . $this->formats[$type]['rootElement']);
+            $xml = $element->xpath('./mets:mdWrap[@MDTYPE="OTHER"][@OTHERMDTYPE="'.$type.'"]/mets:xmlData/'.strtolower($type).':'.$this->formats[$type]['rootElement']);
         }
 
         if (empty($xml)) {
@@ -1289,9 +1289,9 @@ 
             || $forceReload
         ) {
             // Retain current PID.
-            $cPid = $this->cPid ?: $this->pid;
+            $cPid = $this->cPid ? : $this->pid;
             if (!$cPid) {
-                $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
+                $this->logger->error('Invalid PID '.$cPid.' for structure definitions');
                 $this->thumbnailLoaded = true;
                 return $this->thumbnail;
             }
@@ -1328,7 +1328,7 @@ 
                 if (!empty($resArray['thumbnail'])) {
                     $strctType = Helper::getIndexNameFromUid($resArray['thumbnail'], 'tx_dlf_structures', $cPid);
                     // Check if this document has a structure element of the desired type.
-                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="' . $strctType . '"]/@ID');
+                    $strctIds = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="'.$strctType.'"]/@ID');
                     if (!empty($strctIds)) {
                         $strctId = (string) $strctIds[0];
                     }
@@ -1351,7 +1351,7 @@ 
                     }
                 }
             } else {
-                $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
+                $this->logger->error('No structure of type "'.$metadata['type'][0].'" found in database');
             }
             $this->thumbnailLoaded = true;
         }
@@ -1397,7 +1397,7 @@ 
     {
         if (empty($this->parentHref)) {
             // Get the closest ancestor of the current document which has a MPTR child.
-            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $this->toplevelId . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
+            $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="'.$this->toplevelId.'"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
             if (!empty($parentMptr)) {
                 $this->parentHref = (string) $parentMptr[0]->attributes('http://www.w3.org/1999/xlink')->href;
             }

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

@@ -100,7 +100,7 @@ 
      *
      * @see MetsDocument::$mdSec
      */
-    protected bool $mdSecLoaded = false;
+    protected bool $mdSecLoaded = FALSE;
 
     /**
      * @access protected
@@ -122,7 +122,7 @@ 
      *
      * @see $fileGrps
      */
-    protected bool $fileGrpsLoaded = false;
+    protected bool $fileGrpsLoaded = FALSE;
 
     /**
      * @access protected
@@ -198,7 +198,7 @@ 
                 return $service->getImageUrl();
             }
         } elseif ($file['mimeType'] === 'application/vnd.netfpx') {
-            $baseURL = $file['location'] . (strpos($file['location'], '?') === false ? '?' : '');
+            $baseURL = $file['location'] . (strpos($file['location'], '?') === FALSE ? '?' : '');
             // TODO CVT is an optional IIP server capability; in theory, capabilities should be determined in the object request with '&obj=IIP-server'
             return $baseURL . '&CVT=jpeg';
         }
@@ -221,7 +221,7 @@ 
             $this->fileInfos[$id]['mimeType'] = $this->getFileMimeType($id);
         }
 
-        return $this->fileInfos[$id] ?? null;
+        return $this->fileInfos[$id] ?? NULL;
     }
 
     /**
@@ -261,7 +261,7 @@ 
     /**
      * @see AbstractDocument::getLogicalStructure()
      */
-    public function getLogicalStructure(string $id, bool $recursive = false): array
+    public function getLogicalStructure(string $id, bool $recursive = FALSE): array
     {
         $details = [];
         // Is the requested logical unit already loaded?
@@ -302,7 +302,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, bool $recursive = false): array
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, bool $recursive = FALSE): array
     {
         $attributes = $structure->attributes();
 
@@ -320,7 +320,7 @@ 
             'pagination' => '',
             'type' => isset($attributes['TYPE']) ? (string) $attributes['TYPE'] : '',
             'description' => '',
-            'thumbnailId' => null,
+            'thumbnailId' => NULL,
             'files' => [],
         ];
 
@@ -351,7 +351,7 @@ 
             && array_key_exists($details['id'], $this->smLinks['l2p'])
         ) {
             // Link logical structure to the first corresponding physical page/track.
-            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, true), 1);
+            $details['points'] = max((int) array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE), 1);
             $details['thumbnailId'] = $this->getThumbnail();
             // Get page/track number of the first page/track related to this structure element.
             $details['pagination'] = $this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['orderlabel'];
@@ -360,7 +360,7 @@ 
             $details['points'] = 1;
             $details['thumbnailId'] = $this->getThumbnail();
         }
-        if ($details['thumbnailId'] === null) {
+        if ($details['thumbnailId'] === NULL) {
             unset($details['thumbnailId']);
         }
         // Get the files this structure element is pointing at.
@@ -382,7 +382,7 @@ 
             $details['children'] = [];
             foreach ($structure->children('http://www.loc.gov/METS/')->div as $child) {
                 // Repeat for all children.
-                $details['children'][] = $this->getLogicalStructureInfo($child, true);
+                $details['children'][] = $this->getLogicalStructureInfo($child, TRUE);
             }
         }
         return $details;
@@ -403,14 +403,14 @@ 
         $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
         $fileGrpsThumb = GeneralUtility::trimExplode(',', $extConf['fileGrpThumbs']);
 
-        $thumbnail = null;
+        $thumbnail = NULL;
 
         while ($fileGrpThumb = array_shift($fileGrpsThumb)) {
             if (empty($id)) {
-                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? null;
+                $thumbnail = $this->physicalStructureInfo[$this->physicalStructure[1]]['files'][$fileGrpThumb] ?? NULL;
             } else {
-                $parentId = $this->smLinks['l2p'][$id][0] ?? null;
-                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? null;
+                $parentId = $this->smLinks['l2p'][$id][0] ?? NULL;
+                $thumbnail = $this->physicalStructureInfo[$parentId]['files'][$fileGrpThumb] ?? NULL;
             }
 
             if (!empty($thumbnail)) {
@@ -571,13 +571,13 @@ 
     private function extractAndProcessMetadata(string $dmdId, string $mdSectionType, array &$metadata, int $cPid, array $metadataSections): bool
     {
         if ($this->hasMetadataSection($metadataSections, $mdSectionType, 'dmdSec')) {
-            return true;
+            return TRUE;
         }
 
         $metadataExtracted = $this->extractMetadataIfTypeSupported($dmdId, $mdSectionType, $metadata);
 
         if (!$metadataExtracted) {
-            return false;
+            return FALSE;
         }
 
         $additionalMetadata = $this->getAdditionalMetadataFromDatabase($cPid, $dmdId);
@@ -588,7 +588,7 @@ 
 
         $this->processAdditionalMetadata($additionalMetadata, $domXPath, $domNode, $metadata);
 
-        return true;
+        return TRUE;
     }
 
     /**
@@ -753,7 +753,7 @@ 
                     $obj = GeneralUtility::makeInstance($class);
                     if ($obj instanceof MetadataInterface) {
                         $obj->extractMetadata($this->mdSec[$dmdId]['xml'], $metadata, GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'general')['useExternalApisForMetadata']);
-                        return true;
+                        return TRUE;
                     }
                 } else {
                     $this->logger->warning('Invalid class/method "' . $class . '->extractMetadata()" for metadata format "' . $this->mdSec[$dmdId]['type'] . '"');
@@ -762,7 +762,7 @@ 
         } else {
             $this->logger->notice('Unsupported metadata format "' . $this->mdSec[$dmdId]['type'] . '" in ' . $mdSectionType . ' with @ID "' . $dmdId . '"');
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -962,16 +962,16 @@ 
     protected function loadLocation(string $location): bool
     {
         $fileResource = Helper::getUrl($location);
-        if ($fileResource !== false) {
+        if ($fileResource !== FALSE) {
             $xml = Helper::getXmlFileAsString($fileResource);
             // Set some basic properties.
-            if ($xml !== false) {
+            if ($xml !== FALSE) {
                 $this->xml = $xml;
-                return true;
+                return TRUE;
             }
         }
         $this->logger->error('Could not load XML file from "' . $location . '"');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -993,9 +993,9 @@ 
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
-            return true;
+            return TRUE;
         }
-        return false;
+        return FALSE;
     }
 
     /**
@@ -1021,7 +1021,7 @@ 
             foreach ($this->mets->xpath('./mets:dmdSec') as $dmdSecTag) {
                 $dmdSec = $this->processMdSec($dmdSecTag);
 
-                if ($dmdSec !== null) {
+                if ($dmdSec !== NULL) {
                     $this->mdSec[$dmdSec['id']] = $dmdSec;
                     $this->dmdSec[$dmdSec['id']] = $dmdSec;
                 }
@@ -1038,7 +1038,7 @@ 
                     // TODO: Should we check that the format may occur within this type (e.g., to ignore VIDEOMD within rightsMD)?
                     $mdSec = $this->processMdSec($mdSecTag);
 
-                    if ($mdSec !== null) {
+                    if ($mdSec !== NULL) {
                         $this->mdSec[$mdSec['id']] = $mdSec;
 
                         $childIds[] = $mdSec['id'];
@@ -1051,7 +1051,7 @@ 
                 }
             }
 
-            $this->mdSecLoaded = true;
+            $this->mdSecLoaded = TRUE;
         }
         return $this->mdSec;
     }
@@ -1082,7 +1082,7 @@ 
     {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($element);
@@ -1100,7 +1100,7 @@ 
         }
 
         if (empty($xml)) {
-            return null;
+            return NULL;
         }
 
         $this->registerNamespaces($xml[0]);
@@ -1161,9 +1161,9 @@ 
                 !empty($extConf['fileGrpFulltext'])
                 && array_intersect(GeneralUtility::trimExplode(',', $extConf['fileGrpFulltext']), $this->fileGrps) !== []
             ) {
-                $this->hasFulltext = true;
+                $this->hasFulltext = TRUE;
             }
-            $this->fileGrpsLoaded = true;
+            $this->fileGrpsLoaded = TRUE;
         }
         return $this->fileGrps;
     }
@@ -1256,7 +1256,7 @@ 
                 array_unshift($elements, $id);
                 $this->physicalStructure = $elements;
             }
-            $this->physicalStructureLoaded = true;
+            $this->physicalStructureLoaded = TRUE;
         }
         return $this->physicalStructure;
     }
@@ -1274,7 +1274,7 @@ 
                     $this->smLinks['p2l'][(string) $smLink->attributes('http://www.w3.org/1999/xlink')->to][] = (string) $smLink->attributes('http://www.w3.org/1999/xlink')->from;
                 }
             }
-            $this->smLinksLoaded = true;
+            $this->smLinksLoaded = TRUE;
         }
         return $this->smLinks;
     }
@@ -1282,7 +1282,7 @@ 
     /**
      * @see AbstractDocument::magicGetThumbnail()
      */
-    protected function magicGetThumbnail(bool $forceReload = false): string
+    protected function magicGetThumbnail(bool $forceReload = FALSE): string
     {
         if (
             !$this->thumbnailLoaded
@@ -1292,14 +1292,14 @@ 
             $cPid = $this->cPid ?: $this->pid;
             if (!$cPid) {
                 $this->logger->error('Invalid PID ' . $cPid . ' for structure definitions');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             // Load extension configuration.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey, 'files');
             if (empty($extConf['fileGrpThumbs'])) {
                 $this->logger->warning('No fileGrp for thumbnails specified');
-                $this->thumbnailLoaded = true;
+                $this->thumbnailLoaded = TRUE;
                 return $this->thumbnail;
             }
             $strctId = $this->magicGetToplevelId();
@@ -1353,7 +1353,7 @@ 
             } else {
                 $this->logger->error('No structure of type "' . $metadata['type'][0] . '" found in database');
             }
-            $this->thumbnailLoaded = true;
+            $this->thumbnailLoaded = TRUE;
         }
         return $this->thumbnail;
     }
@@ -1431,8 +1431,8 @@ 
     public function __toString(): string
     {
         $xml = new \DOMDocument('1.0', 'utf-8');
-        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
-        $xml->formatOutput = true;
+        $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), TRUE));
+        $xml->formatOutput = TRUE;
         return $xml->saveXML();
     }
 
@@ -1447,7 +1447,7 @@ 
     public function __wakeup(): void
     {
         $xml = Helper::getXmlFileAsString($this->asXML);
-        if ($xml !== false) {
+        if ($xml !== FALSE) {
             $this->asXML = '';
             $this->xml = $xml;
             // Rebuild the unserializable properties.

ext_localconf.php

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

@@ -78,7 +78,7 @@
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'][] = \Kitodo\Dlf\Hooks\DataHandler::class;
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Common/MetsDocument.php']['hookClass'][] = \Kitodo\Dlf\Hooks\KitodoProductionHacks::class;
 // Register AJAX eID handlers.
-if ($GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['dlf']['general']['enableInternalProxy'] ?? false) {
+if ($GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['dlf']['general']['enableInternalProxy'] ?? FALSE) {
     $GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']['tx_dlf_pageview_proxy'] = \Kitodo\Dlf\Eid\PageViewProxy::class . '::main';
 }
 // Use Caching Framework for Solr queries

Spacing +8 added lines, -8 removed lines

@@ -66,20 +66,20 @@
 $_EXTKEY = 'dlf';
 // Register tools for toolbox plugin.
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'] = [];
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_fulltexttool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.fulltexttool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_annotationtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.annotationtool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_fulltextdownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.fulltextdownloadtool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_imagedownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.imagedownloadtool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_imagemanipulationtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.imagemanipulationtool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_pdfdownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.pdfdownloadtool';
-$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY) . '_searchindocumenttool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.searchindocumenttool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_fulltexttool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.fulltexttool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_annotationtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.annotationtool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_fulltextdownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.fulltextdownloadtool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_imagedownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.imagedownloadtool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_imagemanipulationtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.imagemanipulationtool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_pdfdownloadtool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.pdfdownloadtool';
+$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'][\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getCN($_EXTKEY).'_searchindocumenttool'] = 'LLL:EXT:dlf/Resources/Private/Language/locallang_labels.xlf:tx_dlf_toolbox.searchindocumenttool';
 // Register hooks.
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass'][] = \Kitodo\Dlf\Hooks\DataHandler::class;
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processCmdmapClass'][] = \Kitodo\Dlf\Hooks\DataHandler::class;
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Common/MetsDocument.php']['hookClass'][] = \Kitodo\Dlf\Hooks\KitodoProductionHacks::class;
 // Register AJAX eID handlers.
 if ($GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['dlf']['general']['enableInternalProxy'] ?? false) {
-    $GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']['tx_dlf_pageview_proxy'] = \Kitodo\Dlf\Eid\PageViewProxy::class . '::main';
+    $GLOBALS['TYPO3_CONF_VARS']['FE']['eID_include']['tx_dlf_pageview_proxy'] = \Kitodo\Dlf\Eid\PageViewProxy::class.'::main';
 }
 // Use Caching Framework for Solr queries
 $GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['tx_dlf_solr'] ??= [];

Tests/Functional/Common/MetsDocumentTest.php

Spacing +4 added lines, -4 removed lines

@@ -21,14 +21,14 @@
     {
         parent::setUp();
 
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/documents_1.csv');
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/Common/metadata.csv');
-        $this->importCSVDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/documents_1.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/Common/metadata.csv');
+        $this->importCSVDataSet(__DIR__.'/../../Fixtures/MetsDocument/metadata_mets.csv');
     }
 
     protected function doc(string $file)
     {
-        $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
+        $url = 'http://web:8001/Tests/Fixtures/MetsDocument/'.$file;
         $doc = AbstractDocument::getInstance($url, ['general' => ['useExternalApisForMetadata' => 0]]);
         self::assertNotNull($doc);
         return $doc;

Braces +14 added lines, -28 removed lines

@@ -15,8 +15,7 @@ 
 use Kitodo\Dlf\Common\AbstractDocument;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 
-class MetsDocumentTest extends FunctionalTestCase
-{
+class MetsDocumentTest extends FunctionalTestCase {
     public function setUp(): void
     {
         parent::setUp();
@@ -26,8 +25,7 @@ 
         $this->importCSVDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.csv');
     }
 
-    protected function doc(string $file)
-    {
+    protected function doc(string $file) {
         $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
         $doc = AbstractDocument::getInstance($url, ['general' => ['useExternalApisForMetadata' => 0]]);
         self::assertNotNull($doc);
@@ -37,8 +35,7 @@ 
     /**
      * @test
      */
-    public function canParseDmdAndAmdSec()
-    {
+    public function canParseDmdAndAmdSec() {
         $doc = $this->doc('av_beispiel.xml');
 
         $toplevelMetadata = $doc->getToplevelMetadata(20000);
@@ -56,8 +53,7 @@ 
     /**
      * @test
      */
-    public function canReadFileMetadata()
-    {
+    public function canReadFileMetadata() {
         $doc = $this->doc('av_beispiel.xml');
 
         $thumbsMeta = $doc->getMetadata('FILE_0000_THUMBS', 20000);
@@ -72,8 +68,7 @@ 
     /**
      * @test
      */
-    public function canGetLogicalStructure()
-    {
+    public function canGetLogicalStructure() {
         $doc = $this->doc('av_beispiel.xml');
 
         $toc = $doc->tableOfContents[0] ?? [];
@@ -109,8 +104,7 @@ 
     /**
      * @test
      */
-    public function doesNotOverwriteFirstDmdSec()
-    {
+    public function doesNotOverwriteFirstDmdSec() {
         $doc = $this->doc('two_dmdsec.xml');
 
         $toplevelMetadata = $doc->getToplevelMetadata(20000);
@@ -123,8 +117,7 @@ 
     /**
      * @test
      */
-    public function returnsEmptyMetadataWhenNoDmdSec()
-    {
+    public function returnsEmptyMetadataWhenNoDmdSec() {
         $doc = $this->doc('two_dmdsec.xml');
 
         // DMD and AMD works
@@ -143,8 +136,7 @@ 
     /**
      * @test
      */
-    public function canGetDownloadLocation()
-    {
+    public function canGetDownloadLocation() {
         $doc = $this->doc('two_dmdsec.xml');
 
         $correct = $doc->getDownloadLocation('FILE_0000_DOWNLOAD');
@@ -162,8 +154,7 @@ 
     /**
      * @test
      */
-    public function canGetFileLocation()
-    {
+    public function canGetFileLocation() {
         $doc = $this->doc('two_dmdsec.xml');
 
         $correct = $doc->getFileLocation('FILE_0000_DEFAULT');
@@ -176,8 +167,7 @@ 
     /**
      * @test
      */
-    public function canGetFileMimeType()
-    {
+    public function canGetFileMimeType() {
         $doc = $this->doc('two_dmdsec.xml');
 
         $correct = $doc->getFileMimeType('FILE_0000_DEFAULT');
@@ -191,8 +181,7 @@ 
     /**
      * @test
      */
-    public function canGetPhysicalPage()
-    {
+    public function canGetPhysicalPage() {
         $doc = $this->doc('mets_with_pages.xml');
 
         // pass orderlabel and retrieve order
@@ -203,8 +192,7 @@ 
     /**
      * @test
      */
-    public function canGetTitle()
-    {
+    public function canGetTitle() {
         $doc = $this->doc('mets_with_pages.xml');
 
         $correct = $doc->getTitle(1001);
@@ -217,8 +205,7 @@ 
     /**
      * @test
      */
-    public function canGetFullText()
-    {
+    public function canGetFullText() {
         $doc = $this->doc('mets_with_pages.xml');
 
         $fulltext = $doc->getFullText('PHYS_0003');
@@ -234,8 +221,7 @@ 
     /**
      * @test
      */
-    public function canGetStructureDepth()
-    {
+    public function canGetStructureDepth() {
         $doc = $this->doc('mets_with_pages.xml');
 
         $correct = $doc->getStructureDepth('LOG_0001');

Classes/Validation/DocumentValidator.php

Indentation +4 added lines, -4 removed lines

@@ -29,10 +29,10 @@
  */
 class DocumentValidator
 {
-     /**
-     * @access protected
-     * @var Logger This holds the logger
-     */
+        /**
+         * @access protected
+         * @var Logger This holds the logger
+         */
     protected Logger $logger;
 
     /**

Spacing +3 added lines, -3 removed lines

@@ -82,7 +82,7 @@ 
     {
         foreach ($this->requiredMetadataFields as $requiredMetadataField) {
             if (empty($this->metadata[$requiredMetadataField][0])) {
-                $this->logger->error('Missing required metadata field "' . $requiredMetadataField . '".');
+                $this->logger->error('Missing required metadata field "'.$requiredMetadataField.'".');
                 return false;
             }
         }
@@ -100,14 +100,14 @@ 
      */
     public function hasCorrectLogicalStructure(string $type): bool
     {
-        $expectedNodes = $this->xml->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div[@TYPE="' . $type . '"]');
+        $expectedNodes = $this->xml->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div[@TYPE="'.$type.'"]');
         if ($expectedNodes) {
             return true;
         }
 
         $existingNodes = $this->xml->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div');
         if ($existingNodes) {
-            $this->logger->error('Document contains logical structure but @TYPE="' . $type . '" is missing.');
+            $this->logger->error('Document contains logical structure but @TYPE="'.$type.'" is missing.');
             return false;
         }
 

Braces +2 added lines, -4 removed lines

@@ -27,8 +27,7 @@ 
  *
  * @access public
  */
-class DocumentValidator
-{
+class DocumentValidator {
      /**
      * @access protected
      * @var Logger This holds the logger
@@ -63,8 +62,7 @@ 
      *
      * @return void
      */
-    public function __construct(array $metadata = [], array $requiredMetadataFields = [], ?\SimpleXMLElement $xml = null)
-    {
+    public function __construct(array $metadata = [], array $requiredMetadataFields = [], ?\SimpleXMLElement $xml = null) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(static::class);
         $this->metadata = $metadata;
         $this->requiredMetadataFields = $requiredMetadataFields;

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

@@ -63,7 +63,7 @@ 
      *
      * @return void
      */
-    public function __construct(array $metadata = [], array $requiredMetadataFields = [], ?\SimpleXMLElement $xml = null)
+    public function __construct(array $metadata = [], array $requiredMetadataFields = [], ?\SimpleXMLElement $xml = NULL)
     {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(static::class);
         $this->metadata = $metadata;
@@ -83,10 +83,10 @@ 
         foreach ($this->requiredMetadataFields as $requiredMetadataField) {
             if (empty($this->metadata[$requiredMetadataField][0])) {
                 $this->logger->error('Missing required metadata field "' . $requiredMetadataField . '".');
-                return false;
+                return FALSE;
             }
         }
-        return true;
+        return TRUE;
     }
 
     /**
@@ -102,17 +102,17 @@ 
     {
         $expectedNodes = $this->xml->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div[@TYPE="' . $type . '"]');
         if ($expectedNodes) {
-            return true;
+            return TRUE;
         }
 
         $existingNodes = $this->xml->xpath('./mets:structMap[@TYPE="LOGICAL"]/mets:div');
         if ($existingNodes) {
             $this->logger->error('Document contains logical structure but @TYPE="' . $type . '" is missing.');
-            return false;
+            return FALSE;
         }
 
         $this->logger->error('Document does not contain logical structure.');
-        return false;
+        return FALSE;
     }
 
     /**
@@ -126,16 +126,16 @@ 
     {
         $physSequenceNodes = $this->xml->xpath('./mets:structMap[@TYPE="PHYSICAL"]/mets:div[@TYPE="physSequence"]');
         if ($physSequenceNodes) {
-            return true;
+            return TRUE;
         }
 
         $physicalStructureNodes = $this->xml->xpath('./mets:structMap[@TYPE="PHYSICAL"]/mets:div');
         if ($physicalStructureNodes) {
             $this->logger->error('Document contains physical structure but @TYPE="physSequence" is missing.');
-            return false;
+            return FALSE;
         }
 
         $this->logger->error('Document does not contain physical structure.');
-        return false;
+        return FALSE;
     }
 }