Erikmitk / kitodo-presentation

Classes/Common/Helper.php

Braces +24 added lines, -48 removed lines

@@ -32,8 +32,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -81,8 +80,7 @@ 
      *
      * @return \TYPO3\CMS\Core\Messaging\FlashMessageQueue The queue the message was added to
      */
-    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages')
-    {
+    public static function addMessage($message, $title, $severity, $session = false, $queue = 'kitodo.default.flashMessages') {
         $flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = GeneralUtility::makeInstance(
@@ -107,8 +105,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++) {
@@ -172,8 +169,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))
@@ -212,8 +208,7 @@ 
      *
      * @return \SimpleXMLElement|false
      */
-    public static function getXmlFileAsString($content)
-    {
+    public static function getXmlFileAsString($content) {
         // Don't make simplexml_load_string throw (when $content is an array
         // or object)
         if (!is_string($content)) {
@@ -244,8 +239,7 @@ 
      *
      * @return void
      */
-    public static function log($message, $severity = 0)
-    {
+    public static function log($message, $severity = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_called_class());
 
         switch ($severity) {
@@ -275,8 +269,7 @@ 
      *
      * @return mixed Hashed string or false on error
      */
-    public static function digest($string)
-    {
+    public static function digest($string) {
         if (!in_array(self::$hashAlgorithm, openssl_get_md_methods(true))) {
             self::log('OpenSSL library doesn\'t support hash algorithm', LOG_SEVERITY_ERROR);
             return false;
@@ -295,8 +288,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))
@@ -329,8 +321,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -344,8 +335,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.
@@ -366,8 +356,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) {
@@ -388,8 +377,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 (
@@ -447,8 +435,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)) {
@@ -475,8 +462,7 @@ 
      *
      * @return array
      */
-    public static function getDocumentStructures($pid = -1)
-    {
+    public static function getDocumentStructures($pid = -1) {
         // TODO: Against redundancy with getIndexNameFromUid
 
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
@@ -518,8 +504,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,
@@ -586,8 +571,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -598,8 +582,7 @@ 
      *
      * @return bool
      */
-    public static function isValidHttpUrl($url)
-    {
+    public static function isValidHttpUrl($url) {
         if (!GeneralUtility::isValidUrl($url)) {
             return false;
         }
@@ -625,8 +608,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;
     }
@@ -640,8 +622,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();
@@ -661,8 +642,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.
@@ -790,8 +770,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;
@@ -823,8 +802,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 
@@ -850,8 +828,7 @@ 
      *
      * @access public
      */
-    public static function polyfillExtbaseClassesForTYPO3v9()
-    {
+    public static function polyfillExtbaseClassesForTYPO3v9() {
         $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
@@ -888,8 +865,7 @@ 
      *
      * @return string|bool
      */
-    public static function getUrl(string $url)
-    {
+    public static function getUrl(string $url) {
         if (!Helper::isValidHttpUrl($url)) {
             return false;
         }

Classes/Common/SolrSearchQuery.php

Braces +8 added lines, -16 removed lines

@@ -10,10 +10,8 @@ 
 /**
  * Targeted towards being used in ``PaginateController`` (``<f:widget.paginate>``).
  */
-class SolrSearchQuery implements QueryInterface
-{
-    public function __construct($solrSearch)
-    {
+class SolrSearchQuery implements QueryInterface {
+    public function __construct($solrSearch) {
         $this->solrSearch = $solrSearch;
 
         $this->offset = 0;
@@ -22,8 +20,7 @@ 
 
     public function getSource() {}
 
-    public function execute($returnRawQueryResult = false)
-    {
+    public function execute($returnRawQueryResult = false) {
         $this->solrSearch->submit($this->offset, $this->limit);
 
         // solrSearch now only contains the results in range, indexed in [0, n)
@@ -37,14 +34,12 @@ 
 
     public function setOrderings(array $orderings) {}
 
-    public function setLimit($limit)
-    {
+    public function setLimit($limit) {
         $this->limit = $limit;
         return $this;
     }
 
-    public function setOffset($offset)
-    {
+    public function setOffset($offset) {
         $this->offset = $offset;
         return $this;
     }
@@ -65,20 +60,17 @@ 
     public function setQuerySettings(QuerySettingsInterface $querySettings) {}
     public function getQuerySettings() {}
 
-    public function count()
-    {
+    public function count() {
         // TODO?
     }
 
     public function getOrderings() {}
 
-    public function getLimit()
-    {
+    public function getLimit() {
         return $this->limit;
     }
 
-    public function getOffset()
-    {
+    public function getOffset() {
         return $this->offset;
     }
 

Classes/Domain/Repository/DocumentRepository.php

Braces +13 added lines, -26 removed lines

@@ -48,8 +48,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOneByParameters($parameters)
-    {
+    public function findOneByParameters($parameters) {
         $doc = null;
         $document = null;
 
@@ -93,8 +92,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOldestDocument()
-    {
+    public function findOldestDocument() {
         $query = $this->createQuery();
 
         $query->setOrderings(['tstamp' => QueryInterface::ORDER_ASCENDING]);
@@ -108,8 +106,7 @@ 
      * @param  \Kitodo\Dlf\Domain\Model\Structure $structure
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function getChildrenOfYearAnchor($partOf, $structure)
-    {
+    public function getChildrenOfYearAnchor($partOf, $structure) {
         $query = $this->createQuery();
 
         $query->matching($query->equals('structure', $structure));
@@ -130,8 +127,7 @@ 
      *
      * @return \Kitodo\Dlf\Domain\Model\Document|null
      */
-    public function findOneByIdAndSettings($uid, $settings = [])
-    {
+    public function findOneByIdAndSettings($uid, $settings = []) {
         $settings = ['documentSets' => $uid];
 
         return $this->findDocumentsBySettings($settings)->getFirst();
@@ -144,8 +140,7 @@ 
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findDocumentsBySettings($settings = [])
-    {
+    public function findDocumentsBySettings($settings = []) {
         $query = $this->createQuery();
 
         $constraints = [];
@@ -175,8 +170,7 @@ 
      *
      * @return array|\TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function findAllByCollectionsLimited($collections, $limit = 50)
-    {
+    public function findAllByCollectionsLimited($collections, $limit = 50) {
         $query = $this->createQuery();
 
         // order by start_date -> start_time...
@@ -213,8 +207,7 @@ 
      *
      * @return array
      */
-    public function getStatisticsForSelectedCollection($settings)
-    {
+    public function getStatisticsForSelectedCollection($settings) {
         if ($settings['collections']) {
             // Include only selected collections.
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -348,8 +341,7 @@ 
      *
      * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface
      */
-    public function getTableOfContentsFromDb($uid, $pid, $settings)
-    {
+    public function getTableOfContentsFromDb($uid, $pid, $settings) {
         // Build table of contents from database.
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
@@ -397,8 +389,7 @@ 
      *
      * @return array The found document object
      */
-    public function getOaiRecord($settings, $parameters)
-    {
+    public function getOaiRecord($settings, $parameters) {
         $where = '';
 
         if (!$settings['show_userdefined']) {
@@ -438,8 +429,7 @@ 
      *
      * @return array The found document objects
      */
-    public function getOaiDocumentList($settings, $documentsToProcess)
-    {
+    public function getOaiDocumentList($settings, $documentsToProcess) {
         $connection = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getConnectionForTable('tx_dlf_documents');
 
@@ -474,8 +464,7 @@ 
      *
      * @return array
      */
-    public function findAllByUids($uids, $checkPartof = false)
-    {
+    public function findAllByUids($uids, $checkPartof = false) {
         // get all documents from db we are talking about
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
         $queryBuilder = $connectionPool->getQueryBuilderForTable('tx_dlf_documents');
@@ -524,8 +513,7 @@ 
      *
      * @return array
      */
-    public function findChildrenOfEach(array $uids)
-    {
+    public function findChildrenOfEach(array $uids) {
         $allDocuments = $this->findAllByUids($uids, true);
 
         $result = [];
@@ -546,8 +534,7 @@ 
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\QueryResult $listedMetadata
      * @return array
      */
-    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null)
-    {
+    public function findSolrByCollection($collection, $settings, $searchParams, $listedMetadata = null) {
         // set settings global inside this repository
         // (may be necessary when SolrSearch calls back)
         $this->settings = $settings;

Tests/Functional/Common/HelperTest.php

Braces +4 added lines, -8 removed lines

@@ -6,8 +6,7 @@ 
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Core\Localization\LanguageService;
 
-class HelperTest extends FunctionalTestCase
-{
+class HelperTest extends FunctionalTestCase {
     public function setUp(): void
     {
         parent::setUp();
@@ -19,8 +18,7 @@ 
     /**
      * @test
      */
-    public function canGetIndexNameFromUid()
-    {
+    public function canGetIndexNameFromUid() {
         // Repeat to make sure caching isn't broken
         for ($n = 0; $n < 2; $n++) {
             // Good UID, no PID
@@ -69,8 +67,7 @@ 
      * @test
      * @group getLanguageName
      */
-    public function canTranslateLanguageNameToEnglish()
-    {
+    public function canTranslateLanguageNameToEnglish() {
         // NOTE: This only tests in BE mode
 
         $this->initLanguageService('default');
@@ -84,8 +81,7 @@ 
      * @test
      * @group getLanguageName
      */
-    public function canTranslateLanguageNameToGerman()
-    {
+    public function canTranslateLanguageNameToGerman() {
         // NOTE: This only tests in BE mode
 
         $this->initLanguageService('de');

Tests/Functional/Common/MetsDocumentTest.php

Braces +7 added lines, -14 removed lines

@@ -5,8 +5,7 @@ 
 use Kitodo\Dlf\Common\Doc;
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 
-class MetsDocumentTest extends FunctionalTestCase
-{
+class MetsDocumentTest extends FunctionalTestCase {
     public function setUp(): void
     {
         parent::setUp();
@@ -15,8 +14,7 @@ 
         $this->importDataSet(__DIR__ . '/../../Fixtures/MetsDocument/metadata_mets.xml');
     }
 
-    protected function doc(string $file)
-    {
+    protected function doc(string $file) {
         $url = 'http://web:8001/Tests/Fixtures/MetsDocument/' . $file;
         $doc = Doc::getInstance($url);
         $this->assertNotNull($doc);
@@ -26,8 +24,7 @@ 
     /**
      * @test
      */
-    public function canParseDmdAndAmdSec()
-    {
+    public function canParseDmdAndAmdSec() {
         $doc = $this->doc('av_beispiel.xml');
 
         $titledata = $doc->getTitledata(20000);
@@ -45,8 +42,7 @@ 
     /**
      * @test
      */
-    public function canReadFileMetadata()
-    {
+    public function canReadFileMetadata() {
         $doc = $this->doc('av_beispiel.xml');
 
         $thumbsMeta = $doc->getMetadata('FILE_0000_THUMBS', 20000);
@@ -61,8 +57,7 @@ 
     /**
      * @test
      */
-    public function canGetLogicalStructure()
-    {
+    public function canGetLogicalStructure() {
         $doc = $this->doc('av_beispiel.xml');
 
         $toc = $doc->tableOfContents[0] ?? [];
@@ -98,8 +93,7 @@ 
     /**
      * @test
      */
-    public function doesNotOverwriteFirstDmdSec()
-    {
+    public function doesNotOverwriteFirstDmdSec() {
         $doc = $this->doc('two_dmdsec.xml');
 
         $titledata = $doc->getTitledata(20000);
@@ -112,8 +106,7 @@ 
     /**
      * @test
      */
-    public function returnsEmptyMetadataWhenNoDmdSec()
-    {
+    public function returnsEmptyMetadataWhenNoDmdSec() {
         $doc = $this->doc('two_dmdsec.xml');
 
         // DMD and AMD works

Tests/Functional/FunctionalTestCase.php

Braces +7 added lines, -14 removed lines

@@ -67,8 +67,7 @@ 
      */
     protected $httpClient;
 
-    public function __construct()
-    {
+    public function __construct() {
         parent::__construct();
 
         $this->configurationToUseInTestInstance['EXTENSIONS']['dlf'] = $this->getDlfConfiguration();
@@ -95,8 +94,7 @@ 
         $this->addSiteConfig('dlf-testing', $this->baseUrl);
     }
 
-    protected function getDlfConfiguration()
-    {
+    protected function getDlfConfiguration() {
         return [
             'fileGrpImages' => 'DEFAULT,MAX',
             'fileGrpThumbs' => 'THUMBS',
@@ -134,8 +132,7 @@ 
         ];
     }
 
-    protected function addSiteConfig($identifier, $baseUrl)
-    {
+    protected function addSiteConfig($identifier, $baseUrl) {
         $siteConfig = Yaml::parseFile(__DIR__ . '/../Fixtures/siteconfig.yaml');
         $siteConfig['base'] = $baseUrl;
         $siteConfig['languages'][0]['base'] = $baseUrl;
@@ -145,8 +142,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);
@@ -156,8 +152,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();
@@ -176,8 +171,7 @@ 
         $solr->service->update($updateQuery);
     }
 
-    protected function initLanguageService(string $locale)
-    {
+    protected function initLanguageService(string $locale) {
         if (class_exists(\TYPO3\CMS\Core\Localization\LanguageServiceFactory::class)) {
             $GLOBALS['LANG'] = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Localization\LanguageServiceFactory::class)->create($locale);
         } else {
@@ -193,8 +187,7 @@ 
     /**
      * 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 = '') {
         $this->assertEquals($sub, ArrayUtility::intersectRecursive($super, $sub), $message);
     }
 }

Classes/Hooks/ItemsProcFunc.php

Braces +4 added lines, -8 removed lines

@@ -28,8 +28,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class ItemsProcFunc implements LoggerAwareInterface
-{
+class ItemsProcFunc implements LoggerAwareInterface {
     use LoggerAwareTrait;
 
     /**
@@ -46,8 +45,7 @@ 
      *
      * @return void
      */
-    public function toolList(&$params)
-    {
+    public function toolList(&$params) {
         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['dlf/Classes/Plugin/Toolbox.php']['tools'] as $class => $label) {
             $params['items'][] = [Helper::getLanguageService()->sL($label), $class];
         }
@@ -97,8 +95,7 @@ 
      *
      * @return void
      */
-    public function extendedSearchList(&$params)
-    {
+    public function extendedSearchList(&$params) {
         $this->generateList(
             $params,
             'label,index_name',
@@ -139,8 +136,7 @@ 
      *
      * @return void
      */
-    protected function generateList(&$params, $fields, $table, $sorting, $andWhere = '')
-    {
+    protected function generateList(&$params, $fields, $table, $sorting, $andWhere = '') {
         $this->getTyposcriptConfigFromPluginSiteRoot($params);
 
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)