Erikmitk / kitodo-presentation

Classes/Common/Helper.php

Braces +24 added lines, -48 removed lines

@@ -31,8 +31,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -80,8 +79,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(
@@ -106,8 +104,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++) {
@@ -171,8 +168,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))
@@ -211,8 +207,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)) {
@@ -243,8 +238,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) {
@@ -274,8 +268,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;
@@ -294,8 +287,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))
@@ -328,8 +320,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -343,8 +334,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.
@@ -365,8 +355,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) {
@@ -387,8 +376,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 (
@@ -438,8 +426,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)) {
@@ -481,8 +468,7 @@ 
      *
      * @return array
      */
-    public static function getDocumentStructures($pid = -1)
-    {
+    public static function getDocumentStructures($pid = -1) {
         $connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
         $queryBuilder = $connectionPool->getQueryBuilderForTable('tx_dlf_structures');
 
@@ -522,8 +508,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,
@@ -590,8 +575,7 @@ 
      *
      * @return bool Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -602,8 +586,7 @@ 
      *
      * @return bool
      */
-    public static function isValidHttpUrl($url)
-    {
+    public static function isValidHttpUrl($url) {
         if (!GeneralUtility::isValidUrl($url)) {
             return false;
         }
@@ -629,8 +612,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;
     }
@@ -644,8 +626,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();
@@ -665,8 +646,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.
@@ -794,8 +774,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;
@@ -827,8 +806,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 
@@ -854,8 +832,7 @@ 
      *
      * @access public
      */
-    public static function polyfillExtbaseClassesForTYPO3v9()
-    {
+    public static function polyfillExtbaseClassesForTYPO3v9() {
         $classes = require __DIR__ . '/../../Configuration/Extbase/Persistence/Classes.php';
 
         $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
@@ -892,8 +869,7 @@ 
      *
      * @return string|bool
      */
-    public static function getUrl(string $url)
-    {
+    public static function getUrl(string $url) {
         if (!Helper::isValidHttpUrl($url)) {
             return false;
         }

Classes/Controller/SearchController.php

Braces +9 added lines, -18 removed lines

@@ -32,8 +32,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class SearchController extends AbstractController
-{
+class SearchController extends AbstractController {
     /**
      * @var CollectionRepository
      */
@@ -42,8 +41,7 @@ 
     /**
      * @param CollectionRepository $collectionRepository
      */
-    public function injectCollectionRepository(CollectionRepository $collectionRepository)
-    {
+    public function injectCollectionRepository(CollectionRepository $collectionRepository) {
         $this->collectionRepository = $collectionRepository;
     }
 
@@ -55,8 +53,7 @@ 
     /**
      * @param MetadataRepository $metadataRepository
      */
-    public function injectMetadataRepository(MetadataRepository $metadataRepository)
-    {
+    public function injectMetadataRepository(MetadataRepository $metadataRepository) {
         $this->metadataRepository = $metadataRepository;
     }
 
@@ -71,8 +68,7 @@ 
      *
      * @return void
      */
-    public function searchAction()
-    {
+    public function searchAction() {
         // if search was triggered, get search parameters from POST variables
         $this->searchParams = $this->getParametersSafely('searchParameter');
 
@@ -87,8 +83,7 @@ 
      *
      * @return void
      */
-    public function mainAction()
-    {
+    public function mainAction() {
         $listViewSearch = false;
         // Quit without doing anything if required variables are not set.
         if (empty($this->settings['solrcore'])) {
@@ -174,8 +169,7 @@ 
      *
      * @return string HTML output of facets menu
      */
-    protected function addFacetsMenu()
-    {
+    protected function addFacetsMenu() {
         // Quit without doing anything if no facets are configured.
         if (empty($this->settings['facets']) && empty($this->settings['facetCollections'])) {
             return '';
@@ -200,8 +194,7 @@ 
      *
      * @return array HMENU array
      */
-    public function makeFacetsMenuArray($facets)
-    {
+    public function makeFacetsMenuArray($facets) {
         $menuArray = [];
         // Set default value for facet search.
         $search = [
@@ -360,8 +353,7 @@ 
      *
      * @return array The array for the facet's menu entry
      */
-    protected function getFacetsMenuEntry($field, $value, $count, $search, &$state)
-    {
+    protected function getFacetsMenuEntry($field, $value, $count, $search, &$state) {
         $entryArray = [];
         // Translate value.
         if ($field == 'owner_faceting') {
@@ -412,8 +404,7 @@ 
      *
      * @return string The extended search form or an empty string
      */
-    protected function addExtendedSearch()
-    {
+    protected function addExtendedSearch() {
         // Quit without doing anything if no fields for extended search are selected.
         if (
             empty($this->settings['extendedSlotCount'])

Tests/Unit/Common/HelperTest.php

Braces +2 added lines, -4 removed lines

@@ -5,10 +5,8 @@
 use Kitodo\Dlf\Common\Helper;
 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
-class HelperTest extends UnitTestCase
-{
-    public function assertInvalidXml($xml)
-    {
+class HelperTest extends UnitTestCase {
+    public function assertInvalidXml($xml) {
         $result = Helper::getXmlFileAsString($xml);
         $this->assertEquals(false, $result);
     }

Tests/Functional/Api/PageViewProxyTest.php

Braces +3 added lines, -6 removed lines

@@ -6,19 +6,16 @@
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-class PageViewProxyTest extends FunctionalTestCase
-{
+class PageViewProxyTest extends FunctionalTestCase {
     protected $disableJsonWrappedResponse = true;
 
-    protected function getDlfConfiguration()
-    {
+    protected function getDlfConfiguration() {
         return array_merge(parent::getDlfConfiguration(), [
             'enableInternalProxy' => true,
         ]);
     }
 
-    protected function queryProxy(array $query, string $method = 'GET')
-    {
+    protected function queryProxy(array $query, string $method = 'GET') {
         $query['eID'] = 'tx_dlf_pageview_proxy';
 
         return $this->httpClient->request($method, '', [

Tests/Functional/Api/PageViewProxyDisabledTest.php

Braces +2 added lines, -4 removed lines

@@ -5,12 +5,10 @@
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
-class PageViewProxyDisabledTest extends FunctionalTestCase
-{
+class PageViewProxyDisabledTest extends FunctionalTestCase {
     protected $disableJsonWrappedResponse = true;
 
-    protected function queryProxy(array $query, string $method = 'GET')
-    {
+    protected function queryProxy(array $query, string $method = 'GET') {
         $query['eID'] = 'tx_dlf_pageview_proxy';
 
         return $this->httpClient->request($method, '', [

Tests/Functional/Repository/DocumentRepositoryTest.php

Braces +1 added lines, -2 removed lines

@@ -8,8 +8,7 @@
 use Kitodo\Dlf\Tests\Functional\FunctionalTestCase;
 use TYPO3\CMS\Extbase\Persistence\Generic\LazyObjectStorage;
 
-class DocumentRepositoryTest extends FunctionalTestCase
-{
+class DocumentRepositoryTest extends FunctionalTestCase {
     /**
      * @var DocumentRepository
      */

Classes/Common/Doc.php

Braces +32 added lines, -64 removed lines

@@ -49,8 +49,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's "@ID" (METS) or the manifest's "@id" (IIIF)
  * @abstract
  */
-abstract class Doc
-{
+abstract class Doc {
     /**
      * This holds the logger
      *
@@ -326,8 +325,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -505,8 +503,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -551,8 +548,7 @@ 
      *
      * @return string The OCR full text
      */
-    protected function getFullTextFromXml($id)
-    {
+    protected function getFullTextFromXml($id) {
         $fullText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -614,8 +610,7 @@ 
      *
      * @return string The format of the OCR full text
      */
-    private function getTextFormat($fileContent)
-    {
+    private function getTextFormat($fileContent) {
         $xml = Helper::getXmlFileAsString($fileContent);
 
         if ($xml !== false) {
@@ -638,8 +633,7 @@ 
      *
      * @return string The title of the document itself or a parent document
      */
-    public static function getTitle($uid, $recursive = false)
-    {
+    public static function getTitle($uid, $recursive = false) {
         $title = '';
         // Sanitize input.
         $uid = max(intval($uid), 0);
@@ -691,8 +685,7 @@ 
      *
      * @return array The logical structure node's / resource's parsed metadata array
      */
-    public function getTitledata($cPid = 0)
-    {
+    public function getTitledata($cPid = 0) {
         $titledata = $this->getMetadata($this->_getToplevelId(), $cPid);
         // Add information from METS structural map to titledata array.
         if ($this instanceof MetsDocument) {
@@ -725,8 +718,7 @@ 
      * @return int|bool: false if structure with $logId is not a child of this substructure,
      * or the actual depth.
      */
-    protected function getTreeDepth($structure, $depth, $logId)
-    {
+    protected function getTreeDepth($structure, $depth, $logId) {
         foreach ($structure as $element) {
             if ($element['id'] == $logId) {
                 return $depth;
@@ -748,8 +740,7 @@ 
      * @param string $logId: The id of the logical structure element whose depth is requested
      * @return int|bool tree depth as integer or false if no element with $logId exists within the TOC.
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         return $this->getTreeDepth($this->_getTableOfContents(), 1, $logId);
     }
 
@@ -801,8 +792,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function load($location)
-    {
+    protected function load($location) {
         // Load XML / JSON-LD file.
         if (GeneralUtility::isValidUrl($location)) {
             // the actual loading is format specific
@@ -829,8 +819,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -870,8 +859,7 @@ 
      *
      * @return void
      */
-    public function registerNamespaces(&$obj)
-    {
+    public function registerNamespaces(&$obj) {
         // TODO Check usage. XML specific method does not seem to be used anywhere outside this class within the project, but it is public and may be used by extensions.
         $this->loadFormats();
         // Do we have a \SimpleXMLElement or \DOMXPath object?
@@ -896,8 +884,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -908,8 +895,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -921,8 +907,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -944,8 +929,7 @@ 
      *
      * @return array Array of metadata with their corresponding logical structure node ID as key
      */
-    protected function _getMetadataArray()
-    {
+    protected function _getMetadataArray() {
         // Set metadata definitions' PID.
         $cPid = ($this->cPid ? $this->cPid : $this->pid);
         if (!$cPid) {
@@ -970,8 +954,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -983,8 +966,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1007,8 +989,7 @@ 
      *
      * @return array Array of elements' type, label and file representations ordered by "@ID" attribute / Canvas order
      */
-    protected function _getPhysicalStructureInfo()
-    {
+    protected function _getPhysicalStructureInfo() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Build physical structure array.
@@ -1024,8 +1005,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1036,8 +1016,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1048,8 +1027,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1060,8 +1038,7 @@ 
      *
      * @return int The UID of the root document or zero if not applicable
      */
-    protected function _getRootId()
-    {
+    protected function _getRootId() {
         if (!$this->rootIdLoaded) {
             if ($this->parentId) {
                 $parent = self::getInstance($this->parentId, ['storagePid' => $this->pid]);
@@ -1091,8 +1068,7 @@ 
      *
      * @return array Array of structure nodes' id, label, type and physical page indexes/mptr / Canvas link with original hierarchy preserved
      */
-    protected function _getTableOfContents()
-    {
+    protected function _getTableOfContents() {
         // Is there no logical structure array yet?
         if (!$this->tableOfContentsLoaded) {
             // Get all logical structures.
@@ -1133,8 +1109,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1147,8 +1122,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1165,8 +1139,7 @@ 
      *
      * @return void
      */
-    protected function __construct($location, $pid, $preloadedDocument)
-    {
+    protected function __construct($location, $pid, $preloadedDocument) {
         $this->setPreloadedDocument($preloadedDocument);
         $this->init($location);
         $this->establishRecordId($pid);
@@ -1182,8 +1155,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1205,8 +1177,7 @@ 
      *
      * @return bool true if variable is set and not empty, false otherwise
      */
-    public function __isset($var)
-    {
+    public function __isset($var) {
         return !empty($this->__get($var));
     }
 
@@ -1220,8 +1191,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1239,8 +1209,7 @@ 
      * @param string $location
      * @return Doc|false
      */
-    private static function getDocCache(string $location)
-    {
+    private static function getDocCache(string $location) {
         $cacheIdentifier = md5($location);
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_doc');
         $cacheHit = $cache->get($cacheIdentifier);
@@ -1255,8 +1224,7 @@ 
      * @param Doc $doc
      * @return void
      */
-    private static function setDocCache(string $location, Doc $doc)
-    {
+    private static function setDocCache(string $location, Doc $doc) {
         $cacheIdentifier = md5($location);
         $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('tx_dlf_doc');
 

Classes/Common/IiifManifest.php

Braces +27 added lines, -54 removed lines

@@ -56,8 +56,7 @@ 
  * @property-read string $thumbnail This holds the document's thumbnail location
  * @property-read string $toplevelId This holds the toplevel manifest's @id
  */
-final class IiifManifest extends Doc
-{
+final class IiifManifest extends Doc {
     /**
      * This holds the manifest file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -118,8 +117,7 @@ 
      * {@inheritDoc}
      * @see Doc::establishRecordId()
      */
-    protected function establishRecordId($pid)
-    {
+    protected function establishRecordId($pid) {
         if ($this->iiif !== null) {
             /*
              *  FIXME This will not consistently work because we can not be sure to have the pid at hand. It may miss
@@ -174,8 +172,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->iiif;
     }
 
@@ -188,8 +185,7 @@ 
      * @return string 'IIIF1' if the resource is a Metadata API 1 resource, 'IIIF2' / 'IIIF3' if
      * the resource is a Presentation API 2 / 3 resource
      */
-    public function getIiifVersion()
-    {
+    public function getIiifVersion() {
         if (!isset($this->iiifVersion)) {
             if ($this->iiif instanceof AbstractIiifResource1) {
                 $this->iiifVersion = 'IIIF1';
@@ -230,8 +226,7 @@ 
      *
      * @return array|string
      */
-    protected function getUseGroups($use)
-    {
+    protected function getUseGroups($use) {
         if (!$this->useGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -259,8 +254,7 @@ 
      * {@inheritDoc}
      * @see Doc::_getPhysicalStructure()
      */
-    protected function _getPhysicalStructure()
-    {
+    protected function _getPhysicalStructure() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             if ($this->iiif == null || !($this->iiif instanceof ManifestInterface)) {
@@ -373,8 +367,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileLocation = $this->getFileLocation($id);
         $resource = $this->iiif->getContainedResourceById($fileLocation);
         if ($resource instanceof AbstractImageService) {
@@ -387,8 +380,7 @@ 
      * {@inheritDoc}
      * @see Doc::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         if ($id == null) {
             return null;
         }
@@ -412,8 +404,7 @@ 
      * {@inheritDoc}
      * @see Doc::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $fileResource = $this->iiif->getContainedResourceById($id);
         if ($fileResource instanceof CanvasInterface) {
             $format = "application/vnd.kitodo.iiif";
@@ -438,8 +429,7 @@ 
      * {@inheritDoc}
      * @see Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         if (!$recursive && !empty($this->logicalUnits[$id])) {
             return $this->logicalUnits[$id];
@@ -474,8 +464,7 @@ 
      * @param array $processedStructures: IIIF resources that already have been processed
      * @return array Logical structure array
      */
-    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = false, &$processedStructures = [])
-    {
+    protected function getLogicalStructureInfo(IiifResourceInterface $resource, $recursive = false, &$processedStructures = []) {
         $details = [];
         $details['id'] = $resource->getId();
         $details['dmdId'] = '';
@@ -567,8 +556,7 @@ 
      *
      * @todo This method is still in experimental; the method signature may change.
      */
-    public function getManifestMetadata($id, $cPid = 0, $withDescription = true, $withRights = true, $withRelated = true)
-    {
+    public function getManifestMetadata($id, $cPid = 0, $withDescription = true, $withRights = true, $withRelated = true) {
         if (!empty($this->originalMetadataArray[$id])) {
             return $this->originalMetadataArray[$id];
         }
@@ -610,8 +598,7 @@ 
      * {@inheritDoc}
      * @see Doc::getMetadata()
      */
-    public function getMetadata($id, $cPid = 0)
-    {
+    public function getMetadata($id, $cPid = 0) {
         if (!empty($this->metadataArray[$id]) && $this->metadataArray[0] == $cPid) {
             return $this->metadataArray[$id];
         }
@@ -718,8 +705,7 @@ 
      * {@inheritDoc}
      * @see Doc::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded && isset($this->iiif) && $this->iiif instanceof ManifestInterface) {
             if (!empty($this->iiif->getDefaultCanvases())) {
                 foreach ($this->iiif->getDefaultCanvases() as $canvas) {
@@ -743,8 +729,7 @@ 
      *
      * @param RangeInterface $range: Current range whose canvases shall be linked
      */
-    private function smLinkRangeCanvasesRecursively(RangeInterface $range)
-    {
+    private function smLinkRangeCanvasesRecursively(RangeInterface $range) {
         // map range's canvases including all child ranges' canvases
         if (!$range->isTopRange()) {
             foreach ($range->getAllCanvasesRecursively() as $canvas) {
@@ -767,8 +752,7 @@ 
      * @param CanvasInterface $canvas
      * @param IiifResourceInterface $resource
      */
-    private function smLinkCanvasToResource(CanvasInterface $canvas, IiifResourceInterface $resource)
-    {
+    private function smLinkCanvasToResource(CanvasInterface $canvas, IiifResourceInterface $resource) {
         $this->smLinks['l2p'][$resource->getId()][] = $canvas->getId();
         if (!is_array($this->smLinks['p2l'][$canvas->getId()]) || !in_array($resource->getId(), $this->smLinks['p2l'][$canvas->getId()])) {
             $this->smLinks['p2l'][$canvas->getId()][] = $resource->getId();
@@ -780,8 +764,7 @@ 
      * @see Doc::getFullText()
      */
     //TODO: rewrite it to get full OCR
-    public function getFullText($id)
-    {
+    public function getFullText($id) {
         $rawText = '';
         // Get text from raw text array if available.
         if (!empty($this->rawTextArray[$id])) {
@@ -838,8 +821,7 @@ 
      *
      * @return IiifResourceInterface
      */
-    public function getIiif()
-    {
+    public function getIiif() {
         return $this->iiif;
     }
 
@@ -847,8 +829,7 @@ 
      * {@inheritDoc}
      * @see Doc::init()
      */
-    protected function init($location)
-    {
+    protected function init($location) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(static::class);
     }
 
@@ -856,8 +837,7 @@ 
      * {@inheritDoc}
      * @see Doc::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = GeneralUtility::getUrl($location);
         if ($fileResource !== false) {
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -880,8 +860,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $id = $this->iiif->getId();
         $this->metadataArray[(string) $id] = $this->getMetadata((string) $id, $cPid);
     }
@@ -890,8 +869,7 @@ 
      * {@inheritDoc}
      * @see Doc::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
         if ($preloadedDocument instanceof ManifestInterface) {
             $this->iiif = $preloadedDocument;
             return true;
@@ -903,8 +881,7 @@ 
      * {@inheritDoc}
      * @see Docu::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         /*
          *  TODO Check annotations and annotation lists of canvas for ALTO documents.
          *  Example:
@@ -950,8 +927,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         return $this->iiif->getThumbnailUrl();
     }
 
@@ -959,8 +935,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             if (isset($this->iiif)) {
                 $this->toplevelId = $this->iiif->getId();
@@ -977,8 +952,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
         IiifHelper::setUrlReader(IiifUrlReader::getInstance());
         IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
@@ -998,8 +972,7 @@ 
      *
      * @return string[]
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // TODO implement serializiation in IIIF library
         $jsonArray = $this->iiif->getOriginalJsonArray();
         $this->asJson = json_encode($jsonArray);

Build/Documentation/dbdocs/Generator.php

Braces +4 added lines, -8 removed lines

@@ -32,8 +32,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Generator
-{
+class Generator {
     /**
      * @var ObjectManager
      */
@@ -49,8 +48,7 @@ 
      */
     protected $dataMapper;
 
-    public function __construct()
-    {
+    public function __construct() {
         $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
         $this->languageService = $this->objectManager->get(LanguageService::class);
         $this->dataMapper = $this->objectManager->get(DataMapper::class);
@@ -167,8 +165,7 @@ 
         return $result;
     }
 
-    protected function parseDocComment($docComment)
-    {
+    protected function parseDocComment($docComment) {
         // TODO: Consider using phpDocumentor (though that splits the docblock into summary and description)
 
         // Adopted from DocCommentParser in TYPO3 v9
@@ -193,8 +190,7 @@ 
     /**
      * Transform table structure into .rst page.
      */
-    public function generatePage(array $tables)
-    {
+    public function generatePage(array $tables) {
         $page = new RstSection();
         $page->setHeader('Database Tables');
         $page->addText(<<<RST