kitodo / kitodo-presentation

ext_localconf.php

Braces +1 added lines, -2 removed lines

@@ -90,8 +90,7 @@
      *
      * @return boolean TRUE if document type matches, FALSE if not
      */
-    function user_dlf_docTypeCheck($type)
-    {
+    function user_dlf_docTypeCheck($type) {
         $hook = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\Kitodo\Dlf\Common\DocumentTypeCheck::class);
         return ($hook->getDocType() === $type);
     }

Classes/Common/Indexer.php

Braces +8 added lines, -16 removed lines

@@ -26,8 +26,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * The extension key
      *
@@ -88,8 +87,7 @@ 
      *
      * @return integer 0 on success or 1 on failure
      */
-    public static function add(Document &$doc, $core = 0)
-    {
+    public static function add(Document &$doc, $core = 0) {
         if (in_array($doc->uid, self::$processedDocs)) {
             return 0;
         } elseif (self::solrConnect($core, $doc->pid)) {
@@ -204,8 +202,7 @@ 
      *
      * @return integer 0 on success or 1 on failure
      */
-    public static function delete($uid)
-    {
+    public static function delete($uid) {
         // Sanitize input.
         $uid = max(intval($uid), 0);
         // Get Solr core for document.
@@ -278,8 +275,7 @@ 
      *
      * @return string The field's dynamic index name
      */
-    public static function getIndexFieldName($index_name, $pid = 0)
-    {
+    public static function getIndexFieldName($index_name, $pid = 0) {
         // Sanitize input.
         $pid = max(intval($pid), 0);
         if (!$pid) {
@@ -305,8 +301,7 @@ 
      *
      * @return void
      */
-    protected static function loadIndexConf($pid)
-    {
+    protected static function loadIndexConf($pid) {
         if (!self::$fieldsLoaded) {
             /** @var QueryBuilder $queryBuilder */
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
@@ -377,8 +372,7 @@ 
      *
      * @return integer 0 on success or 1 on failure
      */
-    protected static function processLogical(Document &$doc, array $logicalUnit)
-    {
+    protected static function processLogical(Document &$doc, array $logicalUnit) {
         $errors = 0;
         // Get metadata for logical unit.
         $metadata = $doc->metadataArray[$logicalUnit['id']];
@@ -495,8 +489,7 @@ 
      *
      * @return integer 0 on success or 1 on failure
      */
-    protected static function processPhysical(Document &$doc, $page, array $physicalUnit)
-    {
+    protected static function processPhysical(Document &$doc, $page, array $physicalUnit) {
         $errors = 0;
         // Read extension configuration.
         $extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
@@ -606,8 +599,7 @@ 
      *
      * @return boolean TRUE on success or FALSE on failure
      */
-    protected static function solrConnect($core, $pid = 0)
-    {
+    protected static function solrConnect($core, $pid = 0) {
         // Get Solr instance.
         if (!self::$solr) {
             // Connect to Solr server.

Classes/Common/Solr.php

Braces +19 added lines, -38 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Solr
-{
+class Solr {
     /**
      * This holds the core name
      *
@@ -108,8 +107,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQuery($query)
-    {
+    public static function escapeQuery($query) {
         $helper = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\Solarium\Core\Query\Helper::class);
         // Escape query phrase or term.
         if (preg_match('/^".*"$/', $query)) {
@@ -129,8 +127,7 @@ 
      *
      * @return string The escaped query string
      */
-    public static function escapeQueryKeepField($query, $pid)
-    {
+    public static function escapeQueryKeepField($query, $pid) {
         // Is there a field query?
         if (preg_match('/^[[:alnum:]]+_[tu][su]i:\(?.*\)?$/', $query)) {
             /** @var QueryBuilder $queryBuilder */
@@ -187,8 +184,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\Solr Instance of this class
      */
-    public static function getInstance($core)
-    {
+    public static function getInstance($core) {
         // Get core name if UID is given.
         if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($core)) {
             $core = Helper::getIndexNameFromUid($core, 'tx_dlf_solrcores');
@@ -226,8 +222,7 @@ 
      *
      * @return string The connection parameters for a specific Solr core
      */
-    public static function getSolrConnectionInfo()
-    {
+    public static function getSolrConnectionInfo() {
         $solrInfo = [];
         // Extract extension configuration.
         $conf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
@@ -256,8 +251,7 @@ 
      *
      * @return string The request URL for a specific Solr core
      */
-    public static function getSolrUrl($core = '')
-    {
+    public static function getSolrUrl($core = '') {
         // Get Solr connection information.
         $solrInfo = self::getSolrConnectionInfo();
         if (
@@ -281,8 +275,7 @@ 
      *
      * @return integer First unused core number found
      */
-    public static function solrGetCoreNumber($start = 0)
-    {
+    public static function solrGetCoreNumber($start = 0) {
         $start = max(intval($start), 0);
         // Check if core already exists.
         if (self::getInstance('dlfCore' . $start) === NULL) {
@@ -299,8 +292,7 @@ 
      *
      * @return \Kitodo\Dlf\Common\DocumentList The result list
      */
-    public function search()
-    {
+    public function search() {
         $toplevel = [];
         // Take over query parameters.
         $params = $this->params;
@@ -375,8 +367,7 @@ 
      *
      * @return array The Apache Solr Documents that were fetched
      */
-    public function search_raw($query = '', $parameters = [])
-    {
+    public function search_raw($query = '', $parameters = []) {
         // Set additional query parameters.
         $parameters['start'] = 0;
         $parameters['rows'] = $this->limit;
@@ -410,8 +401,7 @@ 
      *
      * @return integer The max number of results
      */
-    protected function _getLimit()
-    {
+    protected function _getLimit() {
         return $this->limit;
     }
 
@@ -422,8 +412,7 @@ 
      *
      * @return integer Total number of hits for last search
      */
-    protected function _getNumberOfHits()
-    {
+    protected function _getNumberOfHits() {
         return $this->numberOfHits;
     }
 
@@ -434,8 +423,7 @@ 
      *
      * @return boolean Is the search instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -446,8 +434,7 @@ 
      *
      * @return \Solarium\Client Apache Solr service object
      */
-    protected function _getService()
-    {
+    protected function _getService() {
         return $this->service;
     }
 
@@ -460,8 +447,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -474,8 +460,7 @@ 
      *
      * @return void
      */
-    protected function _setLimit($value)
-    {
+    protected function _setLimit($value) {
         $this->limit = max(intval($value), 0);
     }
 
@@ -488,8 +473,7 @@ 
      *
      * @return void
      */
-    protected function _setParams(array $value)
-    {
+    protected function _setParams(array $value) {
         $this->params = $value;
     }
 
@@ -502,8 +486,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -526,8 +509,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -548,8 +530,7 @@ 
      *
      * @return void
      */
-    protected function __construct($core)
-    {
+    protected function __construct($core) {
         $solrInfo = self::getSolrConnectionInfo();
         $config = [
             'endpoint' => [

Classes/Common/IiifUrlReader.php

Braces +3 added lines, -6 removed lines

@@ -23,8 +23,7 @@ 
  * @author Lutz Helm <helm@ub.uni-leipzig.de>
  *
  */
-class IiifUrlReader implements UrlReaderInterface
-{
+class IiifUrlReader implements UrlReaderInterface {
     /**
      * Singleton instance of the class
      *
@@ -38,8 +37,7 @@ 
      * {@inheritDoc}
      * @see \Ubl\Iiif\Tools\UrlReaderInterface::getContent()
      */
-    public function getContent($url)
-    {
+    public function getContent($url) {
         return GeneralUtility::getUrl($url);
     }
 
@@ -50,8 +48,7 @@ 
      *
      * @return IiifUrlReader
      */
-    public static function getInstance()
-    {
+    public static function getInstance() {
         if (!isset(self::$instance)) {
             self::$instance = new IiifUrlReader();
         }

Classes/Common/MetsDocument.php

Braces +32 added lines, -58 removed lines

@@ -27,8 +27,7 @@ 
  * @subpackage	tx_dlf
  * @access	public
  */
-final class MetsDocument extends Document
-{
+final class MetsDocument extends Document {
     /**
      * This holds the whole XML file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -129,8 +128,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::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'];
@@ -150,8 +148,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileMimeType = $this->getFileMimeType($id);
         $fileLocation = $this->getFileLocation($id);
         if ($fileMimeType == "application/vnd.kitodo.iiif") {
@@ -176,8 +173,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         if (
             !empty($id)
             && ($location = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/mets:FLocat[@LOCTYPE="URL"]'))
@@ -193,8 +189,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         if (
             !empty($id)
             && ($mimetype = $this->mets->xpath('./mets:fileSec/mets:fileGrp/mets:file[@ID="' . $id . '"]/@MIMETYPE'))
@@ -210,8 +205,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = FALSE)
-    {
+    public function getLogicalStructure($id, $recursive = FALSE) {
         $details = [];
         // Is the requested logical unit already loaded?
         if (
@@ -251,8 +245,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;
@@ -294,14 +287,16 @@ 
         } elseif (
             !empty($this->physicalStructure)
             && array_key_exists($details['id'], $this->smLinks['l2p'])
-        ) { // Are there any physical elements and is this logical unit linked to at least one of them?
+        ) {
+// Are there any physical elements and is this logical unit linked to at least one of them?
             $details['points'] = max(intval(array_search($this->smLinks['l2p'][$details['id']][0], $this->physicalStructure, TRUE)), 1);
             if (!empty($this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['files'][$extConf['fileGrpThumbs']])) {
                 $details['thumbnailId'] = $this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['files'][$extConf['fileGrpThumbs']];
             }
             // Get page/track number of the first page/track related to this structure element.
             $details['pagination'] = $this->physicalStructureInfo[$this->smLinks['l2p'][$details['id']][0]]['orderlabel'];
-        } elseif ($details['id'] == $this->_getToplevelId()) { // Is this the toplevel structure element?
+        } elseif ($details['id'] == $this->_getToplevelId()) {
+// Is this the toplevel structure element?
             // Yes. Point to itself.
             $details['points'] = 1;
             if (
@@ -341,8 +336,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::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.
@@ -533,8 +527,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getRawText()
      */
-    public function getRawText($id)
-    {
+    public function getRawText($id) {
         $rawText = '';
         // Get text from raw text array if available.
         if (!empty($this->rawTextArray[$id])) {
@@ -552,8 +545,7 @@ 
      * {@inheritDoc}
      * @see Document::getStructureDepth()
      */
-    public function getStructureDepth($logId)
-    {
+    public function getStructureDepth($logId) {
         return count($this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $logId . '"]/ancestor::*'));
     }
 
@@ -561,8 +553,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::init()
      */
-    protected function init()
-    {
+    protected function init() {
         // Get METS node from XML file.
         $this->registerNamespaces($this->xml);
         $mets = $this->xml->xpath('//mets:mets');
@@ -579,8 +570,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         // Turn off libxml's error logging.
         $libxmlErrors = libxml_use_internal_errors(TRUE);
         // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
@@ -604,8 +594,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -616,8 +605,7 @@ 
      * {@inheritDoc}
      * @see Document::getParentDocumentUid()
      */
-    protected function getParentDocumentUidForSaving($pid, $core)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core) {
         $partof = 0;
         // Get the closest ancestor of the current document which has a MPTR child.
         $parentMptr = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@ID="' . $this->_getToplevelId() . '"]/ancestor::mets:div[./mets:mptr][1]/mets:mptr');
@@ -640,8 +628,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -654,8 +641,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -666,8 +652,7 @@ 
      *
      * @return integer The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -678,8 +663,7 @@ 
      *
      * @return array Array of dmdSecs with their IDs as array key
      */
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         if (!$this->dmdSecLoaded) {
             // Get available data formats.
             $this->loadFormats();
@@ -715,8 +699,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 = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
@@ -759,8 +742,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         // Get all logical structure nodes with metadata.
         if (($ids = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID]/@ID'))) {
             foreach ($ids as $id) {
@@ -777,8 +759,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -786,8 +767,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_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"?
@@ -847,8 +827,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getSmLinks()
      */
-    protected function _getSmLinks()
-    {
+    protected function _getSmLinks() {
         if (!$this->smLinksLoaded) {
             $smLinks = $this->mets->xpath('./mets:structLink/mets:smLink');
             foreach ($smLinks as $smLink) {
@@ -864,8 +843,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = FALSE)
-    {
+    protected function _getThumbnail($forceReload = FALSE) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -939,8 +917,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             // Get all logical structure nodes with metadata, but without associated METS-Pointers.
             if (($divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID and not(./mets:mptr)]'))) {
@@ -971,8 +948,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'];
@@ -985,8 +961,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;
@@ -1001,8 +976,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         // Turn off libxml's error logging.
         $libxmlErrors = libxml_use_internal_errors(TRUE);
         // Reload XML from string.

Classes/Common/IiifManifest.php

Braces +28 added lines, -56 removed lines

@@ -38,8 +38,7 @@ 
  * @subpackage	tx_dlf
  * @access	public
  */
-final class IiifManifest extends Document
-{
+final class IiifManifest extends Document {
     /**
      * This holds the manifest file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -100,8 +99,7 @@ 
      * {@inheritDoc}
      * @see Document::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
@@ -141,8 +139,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->iiif;
     }
 
@@ -155,8 +152,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';
@@ -197,8 +193,7 @@ 
      *
      * @return array|string
      */
-    protected function getUseGroups($use)
-    {
+    protected function getUseGroups($use) {
         if (!$this->useGrpsLoaded) {
             // Get configured USE attributes.
             $extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
@@ -225,8 +220,7 @@ 
      * {@inheritDoc}
      * @see Document::_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)) {
@@ -347,8 +341,7 @@ 
      * {@inheritDoc}
      * @see Document::getDownloadLocation()
      */
-    public function getDownloadLocation($id)
-    {
+    public function getDownloadLocation($id) {
         $fileLocation = $this->getFileLocation($id);
         $resource = $this->iiif->getContainedResourceById($fileLocation);
         if ($resource instanceof AbstractImageService) {
@@ -361,8 +354,7 @@ 
      * {@inheritDoc}
      * @see Document::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         if ($id == NULL) {
             return NULL;
         }
@@ -386,8 +378,7 @@ 
      * {@inheritDoc}
      * @see Document::getFileMimeType()
      */
-    public function getFileMimeType($id)
-    {
+    public function getFileMimeType($id) {
         $fileResource = $this->iiif->getContainedResourceById($id);
         if ($fileResource instanceof CanvasInterface) {
             $format = "application/vnd.kitodo.iiif";
@@ -412,8 +403,7 @@ 
      * {@inheritDoc}
      * @see Document::getLogicalStructure()
      */
-    public function getLogicalStructure($id, $recursive = FALSE)
-    {
+    public function getLogicalStructure($id, $recursive = FALSE) {
         $details = [];
         if (!$recursive && !empty($this->logicalUnits[$id])) {
             return $this->logicalUnits[$id];
@@ -448,8 +438,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'] = '';
@@ -541,8 +530,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];
         }
@@ -584,8 +572,7 @@ 
      * {@inheritDoc}
      * @see Document::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];
         }
@@ -669,8 +656,7 @@ 
      * {@inheritDoc}
      * @see Document::_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) {
@@ -694,8 +680,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) {
@@ -718,8 +703,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();
@@ -734,8 +718,7 @@ 
      *
      * @see Document::getParentDocumentUidForSaving()
      */
-    protected function getParentDocumentUidForSaving($pid, $core)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core) {
         // Do nothing.
     }
 
@@ -743,8 +726,7 @@ 
      * {@inheritDoc}
      * @see Document::getRawText()
      */
-    public function getRawText($id)
-    {
+    public function getRawText($id) {
         $rawText = '';
         // Get text from raw text array if available.
         if (!empty($this->rawTextArray[$id])) {
@@ -797,8 +779,7 @@ 
      *
      * @return IiifResourceInterface
      */
-    public function getIiif()
-    {
+    public function getIiif() {
         return $this->iiif;
     }
 
@@ -806,8 +787,7 @@ 
      * {@inheritDoc}
      * @see Document::init()
      */
-    protected function init()
-    {
+    protected function init() {
         // Nothing to do here, at the moment
     }
 
@@ -815,8 +795,7 @@ 
      * {@inheritDoc}
      * @see Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $content = GeneralUtility::getUrl($location);
         $conf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
         IiifHelper::setUrlReader(IiifUrlReader::getInstance());
@@ -837,8 +816,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::prepareMetadataArray()
      */
-    protected function prepareMetadataArray($cPid)
-    {
+    protected function prepareMetadataArray($cPid) {
         $id = $this->iiif->getId();
         $this->metadataArray[(string) $id] = $this->getMetadata((string) $id, $cPid);
     }
@@ -847,8 +825,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
         if ($preloadedDocument instanceof ManifestInterface) {
             $this->iiif = $preloadedDocument;
             return TRUE;
@@ -860,8 +837,7 @@ 
      * {@inheritDoc}
      * @see Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         /*
          *  TODO Check annotations and annotation lists of canvas for ALTO documents.
          *  Example:
@@ -907,8 +883,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = FALSE)
-    {
+    protected function _getThumbnail($forceReload = FALSE) {
         return $this->iiif->getThumbnailUrl();
     }
 
@@ -916,8 +891,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getToplevelId()
      */
-    protected function _getToplevelId()
-    {
+    protected function _getToplevelId() {
         if (empty($this->toplevelId)) {
             if (isset($this->iiif)) {
                 $this->toplevelId = $this->iiif->getId();
@@ -934,8 +908,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $conf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][self::$extKey]);
         IiifHelper::setUrlReader(IiifUrlReader::getInstance());
         IiifHelper::setMaxThumbnailHeight($conf['iiifThumbnailHeight']);
@@ -954,8 +927,7 @@ 
      *
      * @return string[]
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         // TODO implement serializiation in IIIF library
         $jsonArray = $this->iiif->getOriginalJsonArray();
         $this->asJson = json_encode($jsonArray);

Classes/Common/Helper.php

Braces +23 added lines, -46 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Helper
-{
+class Helper {
     /**
      * The extension key
      *
@@ -56,8 +55,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 = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
         $flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier($queue);
         $flashMessage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(
@@ -82,8 +80,7 @@ 
      *
      * @return boolean 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++) {
@@ -148,8 +145,7 @@ 
      *
      * @return mixed The decrypted value or NULL on error
      */
-    public static function decrypt($encrypted, $hash)
-    {
+    public static function decrypt($encrypted, $hash) {
         $decrypted = NULL;
         if (
             empty($encrypted)
@@ -184,8 +180,7 @@ 
      *
      * @return void
      */
-    public static function devLog($message, $severity = 0)
-    {
+    public static function devLog($message, $severity = 0) {
         if (TYPO3_DLOG) {
             $stacktrace = debug_backtrace(0, 2);
             // Set some defaults.
@@ -225,8 +220,7 @@ 
      *
      * @return array Array with encrypted string and control hash
      */
-    public static function encrypt($string)
-    {
+    public static function encrypt($string) {
         if (empty($GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'])) {
             self::devLog('No encryption key set in TYPO3 configuration', DEVLOG_SEVERITY_ERROR);
             return;
@@ -247,8 +241,7 @@ 
      *
      * @return string The unqualified class name
      */
-    public static function getUnqualifiedClassName($qualifiedClassname)
-    {
+    public static function getUnqualifiedClassName($qualifiedClassname) {
         $nameParts = explode('\\', $qualifiedClassname);
         return end($nameParts);
     }
@@ -262,8 +255,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.
@@ -284,8 +276,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) {
@@ -306,8 +297,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 (
@@ -358,8 +348,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)) {
@@ -404,8 +393,7 @@ 
      *
      * @return string The translated string or the given key on failure
      */
-    public static function getMessage($key, $hsc = FALSE, $default = '')
-    {
+    public static function getMessage($key, $hsc = FALSE, $default = '') {
         // Set initial output to default value.
         $translated = (string) $default;
         // Load common messages file.
@@ -447,8 +435,7 @@ 
      *
      * @return string "uid" for the given index_name
      */
-    public static function getUidFromIndexName($index_name, $table, $pid = -1)
-    {
+    public static function getUidFromIndexName($index_name, $table, $pid = -1) {
         if (
             !$index_name
             || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
@@ -500,8 +487,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,
@@ -568,8 +554,7 @@ 
      *
      * @return boolean Is $id a valid PPN?
      */
-    public static function isPPN($id)
-    {
+    public static function isPPN($id) {
         return self::checkIdentifier($id, 'PPN');
     }
 
@@ -582,8 +567,7 @@ 
      *
      * @return mixed Session value for given key or NULL on failure
      */
-    public static function loadFromSession($key)
-    {
+    public static function loadFromSession($key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -615,8 +599,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;
     }
@@ -633,8 +616,7 @@ 
      *
      * @return array Array of substituted "NEW..." identifiers and their actual UIDs.
      */
-    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = FALSE, $cmdFirst = FALSE)
-    {
+    public static function processDBasAdmin(array $data = [], array $cmd = [], $reverseOrder = FALSE, $cmdFirst = FALSE) {
         if (
             TYPO3_MODE === 'BE'
             && $GLOBALS['BE_USER']->isAdmin()
@@ -678,8 +660,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);
         // \TYPO3\CMS\Core\Messaging\FlashMessage::getMessageAsMarkup() uses htmlspecialchars()
@@ -725,8 +706,7 @@ 
      *
      * @return boolean TRUE on success, FALSE on failure
      */
-    public static function saveToSession($value, $key)
-    {
+    public static function saveToSession($value, $key) {
         // Cast to string for security reasons.
         $key = (string) $key;
         if (!$key) {
@@ -758,8 +738,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.
@@ -883,8 +862,7 @@ 
      *
      * @return string Additional WHERE clause
      */
-    public static function whereClause($table, $showHidden = FALSE)
-    {
+    public static function whereClause($table, $showHidden = FALSE) {
         if (TYPO3_MODE === 'FE') {
             // Table "tx_dlf_formats" always has PID 0.
             if ($table == 'tx_dlf_formats') {
@@ -921,8 +899,7 @@ 
      *
      * @return string Additional WHERE expression
      */
-    public static function whereExpression($table, $showHidden = FALSE)
-    {
+    public static function whereExpression($table, $showHidden = FALSE) {
         $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable($table)
             ->expr();

Classes/Common/DocumentTypeCheck.php

Braces +4 added lines, -8 removed lines

@@ -25,8 +25,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class DocumentTypeCheck
-{
+class DocumentTypeCheck {
     /**
      * This holds the current document
      *
@@ -67,8 +66,7 @@ 
      *
      * @return string The type of the current document
      */
-    public function getDocType()
-    {
+    public function getDocType() {
         // Load current document.
         $this->loadDocument();
         if ($this->doc === NULL) {
@@ -151,8 +149,7 @@ 
      *
      * @return void
      */
-    protected function loadDocument()
-    {
+    protected function loadDocument() {
         // Check for required variable.
         if (!empty($this->piVars['id'])) {
             // Get instance of \Kitodo\Dlf\Common\Document.
@@ -199,8 +196,7 @@ 
      *
      * @return void
      */
-    public function __construct()
-    {
+    public function __construct() {
         // Load current plugin parameters.
         $this->piVars = GeneralUtility::_GPmerged($this->prefixId);
     }

Classes/Common/MetadataInterface.php

Braces +1 added lines, -2 removed lines

@@ -21,8 +21,7 @@
  * @access public
  * @abstract
  */
-interface MetadataInterface
-{
+interface MetadataInterface {
     /**
      * This extracts metadata from XML
      *