Erikmitk / kitodo-presentation

Tests/Functional/Common/SolrIndexingTest.php

Braces +4 added lines, -8 removed lines

@@ -16,8 +16,7 @@ 
 use TYPO3\CMS\Extbase\Object\ObjectManager;
 use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
 
-class SolrIndexingTest extends FunctionalTestCase
-{
+class SolrIndexingTest extends FunctionalTestCase {
     /** @var PersistenceManager */
     protected $persistenceManager;
 
@@ -51,8 +50,7 @@ 
     /**
      * @test
      */
-    public function canCreateCore()
-    {
+    public function canCreateCore() {
         $coreName = uniqid('testCore');
         $solr = Solr::getInstance($coreName);
         $this->assertNull($solr->core);
@@ -67,8 +65,7 @@ 
     /**
      * @test
      */
-    public function canIndexAndSearchDocument()
-    {
+    public function canIndexAndSearchDocument() {
         $core = $this->createSolrCore();
 
         $document = $this->documentRepository->findByUid(1001);
@@ -108,8 +105,7 @@ 
     /**
      * @test
      */
-    public function canSearchInCollections()
-    {
+    public function canSearchInCollections() {
         $core = $this->createSolrCore();
 
         $this->importDataSet(__DIR__ . '/../../Fixtures/Common/documents_fulltext.xml');

Classes/Controller/CalendarController.php

Braces +6 added lines, -12 removed lines

@@ -26,8 +26,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class CalendarController extends AbstractController
-{
+class CalendarController extends AbstractController {
     /**
      * @var StructureRepository
      */
@@ -36,8 +35,7 @@ 
     /**
      * @param StructureRepository $structureRepository
      */
-    public function injectStructureRepository(StructureRepository $structureRepository)
-    {
+    public function injectStructureRepository(StructureRepository $structureRepository) {
         $this->structureRepository = $structureRepository;
     }
 
@@ -54,8 +52,7 @@ 
      *
      * @return void
      */
-    public function mainAction()
-    {
+    public function mainAction() {
         // Set initial document (anchor or year file) if configured.
         if (empty($this->requestData['id']) && !empty($this->settings['initialDocument'])) {
             $this->requestData['id'] = $this->settings['initialDocument'];
@@ -100,8 +97,7 @@ 
      *
      * @return void
      */
-    public function calendarAction()
-    {
+    public function calendarAction() {
         // access arguments passed by the mainAction()
         $mainrequestData = $this->request->getArguments();
 
@@ -206,8 +202,7 @@ 
      *
      * @return void
      */
-    public function yearsAction()
-    {
+    public function yearsAction() {
         // access arguments passed by the mainAction()
         $mainrequestData = $this->request->getArguments();
 
@@ -262,8 +257,7 @@ 
      *
      * @return string Content for template subpart
      */
-    protected function getCalendarYear(&$calendarData, $calendarIssuesByMonth, $year, $firstMonth = 1, $lastMonth = 12)
-    {
+    protected function getCalendarYear(&$calendarData, $calendarIssuesByMonth, $year, $firstMonth = 1, $lastMonth = 12) {
         for ($i = $firstMonth; $i <= $lastMonth; $i++) {
             $key = $year . '-' . $i;
 

Classes/Controller/View3DController.php

Braces +2 added lines, -4 removed lines

@@ -21,13 +21,11 @@
  * @subpackage dlf
  * @access public
  */
-class View3DController extends AbstractController
-{
+class View3DController extends AbstractController {
     /**
      * @return string|void
      */
-    public function mainAction()
-    {
+    public function mainAction() {
         $this->cObj = $this->configurationManager->getContentObject();
         // Load current document.
         $this->loadDocument($this->requestData);

Classes/Format/AudioVideoMD.php

Braces +1 added lines, -2 removed lines

@@ -35,8 +35,7 @@
      *
      * @return void
      */
-    public function extractMetadata(\SimpleXMLElement $xml, array &$metadata)
-    {
+    public function extractMetadata(\SimpleXMLElement $xml, array &$metadata) {
         $xml->registerXPathNamespace('audiomd', 'http://www.loc.gov/audioMD/');
         $xml->registerXPathNamespace('videomd', 'http://www.loc.gov/videoMD/');
 

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->pid = $pid;
         $this->setPreloadedDocument($preloadedDocument);
         $this->init($location);
@@ -1183,8 +1156,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1206,8 +1178,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));
     }
 
@@ -1221,8 +1192,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1240,8 +1210,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);
@@ -1256,8 +1225,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/MetsDocument.php

Braces +32 added lines, -64 removed lines

@@ -50,8 +50,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
  * @property-read string $parentHref URL of the parent document (determined via mptr element), or empty string if none is available
  */
-final class MetsDocument extends Doc
-{
+final class MetsDocument extends Doc {
     /**
      * Subsections / tags that may occur within `<mets:amdSec>`.
      *
@@ -176,8 +175,7 @@ 
      *
      * @return  void
      */
-    public function addMetadataFromMets(&$metadata, $id)
-    {
+    public function addMetadataFromMets(&$metadata, $id) {
         $details = $this->getLogicalStructure($id);
         if (!empty($details)) {
             $metadata['mets_order'][0] = $details['order'];
@@ -191,8 +189,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::establishRecordId()
      */
-    protected function establishRecordId($pid)
-    {
+    protected function establishRecordId($pid) {
         // Check for METS object @ID.
         if (!empty($this->mets['OBJID'])) {
             $this->recordId = (string) $this->mets['OBJID'];
@@ -212,8 +209,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType === 'application/vnd.kitodo.iiif') {
@@ -238,8 +234,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         $location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]');
         if (
             !empty($id)
@@ -256,8 +251,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE');
         if (
             !empty($id)
@@ -274,8 +268,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = false)
-    {
+    public function getLogicalStructure($id, $recursive = false) {
         $details = [];
         // Is the requested logical unit already loaded?
         if (
@@ -315,8 +308,7 @@ 
      *
      * @return array Array of the element's id, label, type and physical page indexes/mptr link
      */
-    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false)
-    {
+    protected function getLogicalStructureInfo(\SimpleXMLElement $structure, $recursive = false) {
         // Get attributes.
         foreach ($structure->attributes() as $attribute => $value) {
             $attributes[$attribute] = (string) $value;
@@ -415,8 +407,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getMetadata()
      */
-    public function getMetadata($id, $cPid = 0)
-    {
+    public function getMetadata($id, $cPid = 0) {
         // Make sure $cPid is a non-negative integer.
         $cPid = max(intval($cPid), 0);
         // If $cPid is not given, try to get it elsewhere.
@@ -659,8 +650,7 @@ 
      * @param string $id: The "@ID" attribute of the file node
      * @return void
      */
-    protected function getMetadataIds($id)
-    {
+    protected function getMetadataIds($id) {
         // ­Load amdSecChildIds concordance
         $this->_getMdSec();
         $this->_getFileInfos();
@@ -707,8 +697,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::getFullText()
      */
-    public function getFullText($id)
-    {
+    public function getFullText($id) {
         $fullText = '';
 
         // Load fileGrps and check for full text files.
@@ -723,8 +712,7 @@ 
      * {@inheritDoc}
      * @see Doc::getStructureDepth()
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         $ancestors = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*');
         if (!empty($ancestors)) {
             return count($ancestors);
@@ -737,8 +725,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::init()
      */
-    protected function init($location)
-    {
+    protected function init($location) {
         $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(get_class($this));
         // Get METS node from XML file.
         $this->registerNamespaces($this->xml);
@@ -762,8 +749,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = Helper::getUrl($location);
         if ($fileResource !== false) {
             $xml = Helper::getXmlFileAsString($fileResource);
@@ -781,8 +767,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -793,8 +778,7 @@ 
      * {@inheritDoc}
      * @see Doc::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -807,8 +791,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -819,8 +802,7 @@ 
      *
      * @return array Array of metadata sections with their IDs as array key
      */
-    protected function _getMdSec()
-    {
+    protected function _getMdSec() {
         if (!$this->mdSecLoaded) {
             $this->loadFormats();
 
@@ -862,8 +844,7 @@ 
         return $this->mdSec;
     }
 
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         $this->_getMdSec();
         return $this->dmdSec;
     }
@@ -877,8 +858,7 @@ 
      *
      * @return array|null The processed metadata section
      */
-    protected function processMdSec($element)
-    {
+    protected function processMdSec($element) {
         $mdId = (string) $element->attributes()->ID;
         if (empty($mdId)) {
             return null;
@@ -918,8 +898,7 @@ 
      *
      * @return array Array of file use groups with file IDs
      */
-    protected function _getFileGrps()
-    {
+    protected function _getFileGrps() {
         if (!$this->fileGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -971,8 +950,7 @@ 
      * @access protected
      * @return array
      */
-    protected function _getFileInfos()
-    {
+    protected function _getFileInfos() {
         $this->_getFileGrps();
         return $this->fileInfos;
     }
@@ -981,8 +959,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $ids = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID]/@ID');
         // Get all logical structure nodes with metadata.
         if (!empty($ids)) {
@@ -1000,8 +977,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -1009,8 +985,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getPhysicalStructure()
      */
-    protected function _getPhysicalStructure()
-    {
+    protected function _getPhysicalStructure() {
         // Is there no physical structure array yet?
         if (!$this->physicalStructureLoaded) {
             // Does the document have a structMap node of type "PHYSICAL"?
@@ -1072,8 +1047,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded) {
             $smLinks = $this->mets->xpath('./mets:structLink/mets:smLink');
             if (!empty($smLinks)) {
@@ -1091,8 +1065,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1171,8 +1144,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             // Get all logical structure nodes with metadata, but without associated METS-Pointers.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID and not(./mets:mptr)]');
@@ -1201,8 +1173,7 @@ 
      *
      * @return string|null
      */
-    public function _getParentHref()
-    {
+    public function _getParentHref() {
         if ($this->parentHref === null) {
             $this->parentHref = '';
 
@@ -1224,8 +1195,7 @@ 
      *
      * @return array Properties to be serialized
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // \SimpleXMLElement objects can't be serialized, thus save the XML as string for serialization
         $this->asXML = $this->xml->asXML();
         return ['uid', 'pid', 'recordId', 'parentId', 'asXML'];
@@ -1238,8 +1208,7 @@ 
      *
      * @return string String representing the METS object
      */
-    public function __toString()
-    {
+    public function __toString() {
         $xml = new \DOMDocument('1.0', 'utf-8');
         $xml->appendChild($xml->importNode(dom_import_simplexml($this->mets), true));
         $xml->formatOutput = true;
@@ -1254,8 +1223,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $xml = Helper::getXmlFileAsString($this->asXML);
         if ($xml !== false) {
             $this->asXML = '';

Classes/Common/SolrSearch.php

Braces +22 added lines, -44 removed lines

@@ -33,8 +33,7 @@ 
      * @param array $searchParams
      * @param QueryResult $listedMetadata
      */
-    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = null)
-    {
+    public function __construct($documentRepository, $collection, $settings, $searchParams, $listedMetadata = null) {
         $this->documentRepository = $documentRepository;
         $this->collection = $collection;
         $this->settings = $settings;
@@ -42,13 +41,11 @@ 
         $this->listedMetadata = $listedMetadata;
     }
 
-    public function getNumLoadedDocuments()
-    {
+    public function getNumLoadedDocuments() {
         return count($this->result['documents']);
     }
 
-    public function count()
-    {
+    public function count() {
         if ($this->result === null) {
             return 0;
         }
@@ -56,39 +53,32 @@ 
         return $this->result['numberOfToplevels'];
     }
 
-    public function current()
-    {
+    public function current() {
         return $this[$this->position];
     }
 
-    public function key()
-    {
+    public function key() {
         return $this->position;
     }
 
-    public function next()
-    {
+    public function next() {
         $this->position++;
     }
 
-    public function rewind()
-    {
+    public function rewind() {
         $this->position = 0;
     }
 
-    public function valid()
-    {
+    public function valid() {
         return isset($this[$this->position]);
     }
 
-    public function offsetExists($offset)
-    {
+    public function offsetExists($offset) {
         $idx = $this->result['document_keys'][$offset];
         return isset($this->result['documents'][$idx]);
     }
 
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         $idx = $this->result['document_keys'][$offset];
         $document = $this->result['documents'][$idx] ?? null;
 
@@ -116,38 +106,31 @@ 
         return $document;
     }
 
-    public function offsetSet($offset, $value)
-    {
+    public function offsetSet($offset, $value) {
         throw new \Exception("SolrSearch: Modifying result list is not supported");
     }
 
-    public function offsetUnset($offset)
-    {
+    public function offsetUnset($offset) {
         throw new \Exception("SolrSearch: Modifying result list is not supported");
     }
 
-    public function getSolrResults()
-    {
+    public function getSolrResults() {
         return $this->result['solrResults'];
     }
 
-    public function getByUid($uid)
-    {
+    public function getByUid($uid) {
         return $this->result['documents'][$uid];
     }
 
-    public function getQuery()
-    {
+    public function getQuery() {
         return new SolrSearchQuery($this);
     }
 
-    public function getFirst()
-    {
+    public function getFirst() {
         return $this[0];
     }
 
-    public function toArray()
-    {
+    public function toArray() {
         return array_values($this->result['documents']);
     }
 
@@ -156,13 +139,11 @@ 
      *
      * This can be accessed in Fluid template using `.numFound`.
      */
-    public function getNumFound()
-    {
+    public function getNumFound() {
         return $this->result['numFound'];
     }
 
-    public function prepare()
-    {
+    public function prepare() {
         // Prepare query parameters.
         $params = [];
         $matches = [];
@@ -285,8 +266,7 @@ 
         $this->submit(0, 1, false);
     }
 
-    public function submit($start, $rows, $processResults = true)
-    {
+    public function submit($start, $rows, $processResults = true) {
         $params = $this->params;
         $params['start'] = $start;
         $params['rows'] = $rows;
@@ -383,8 +363,7 @@ 
      * @param int $queryParams
      * @return array
      */
-    protected function fetchToplevelMetadataFromSolr($queryParams)
-    {
+    protected function fetchToplevelMetadataFromSolr($queryParams) {
         // Prepare query parameters.
         $params = $queryParams;
         $metadataArray = [];
@@ -427,8 +406,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    protected function searchSolr($parameters = [], $enableCache = true)
-    {
+    protected function searchSolr($parameters = [], $enableCache = true) {
         // Set query.
         $parameters['query'] = isset($parameters['query']) ? $parameters['query'] : '*';
         $parameters['filterquery'] = isset($parameters['filterquery']) ? $parameters['filterquery'] : [];

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;
     }