Erikmitk / kitodo-presentation

Classes/Plugin/Tools/SearchInDocumentTool.php

Braces +5 added lines, -10 removed lines

@@ -26,8 +26,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class SearchInDocumentTool extends \Kitodo\Dlf\Common\AbstractPlugin
-{
+class SearchInDocumentTool extends \Kitodo\Dlf\Common\AbstractPlugin {
     public $scriptRelPath = 'Classes/Plugin/Tools/SearchInDocumentTool.php';
 
     /**
@@ -40,8 +39,7 @@ 
      *
      * @return string The content that is displayed on the website
      */
-    public function main($content, $conf)
-    {
+    public function main($content, $conf) {
 
         $this->init($conf);
 
@@ -126,8 +124,7 @@ 
      *
      * @return string with action url for search form
      */
-    protected function getActionUrl()
-    {
+    protected function getActionUrl() {
         // Configure @action URL for form.
         $linkConf = [
             'parameter' => $GLOBALS['TSFE']->id,
@@ -152,8 +149,7 @@ 
      *
      * @return string with current document id
      */
-    protected function getCurrentDocumentId()
-    {
+    protected function getCurrentDocumentId() {
         $id = $this->doc->uid;
 
         // example: https://host.de/items/*id*/record
@@ -177,8 +173,7 @@ 
      *
      * @return string with encrypted core name
      */
-    protected function getEncryptedCoreName()
-    {
+    protected function getEncryptedCoreName() {
         // Get core name.
         $name = Helper::getIndexNameFromUid($this->conf['solrcore'], 'tx_dlf_solrcores');
         // Encrypt core name.

Classes/Plugin/Eid/SearchInDocument.php

Braces +4 added lines, -8 removed lines

@@ -28,16 +28,14 @@ 
  * @subpackage dlf
  * @access public
  */
-class SearchInDocument
-{
+class SearchInDocument {
     /**
      * The main method of the eID script
      *
      * @param ServerRequestInterface $request
      * @return ResponseInterface JSON response of search suggestions
      */
-    public function main(ServerRequestInterface $request)
-    {
+    public function main(ServerRequestInterface $request) {
         $output = [
             'documents' => [],
             'numFound' => 0
@@ -118,8 +116,7 @@ 
      *
      * @return string SOLR query
      */
-    private function getQuery($fields, $parameters)
-    {
+    private function getQuery($fields, $parameters) {
         return $fields['fulltext'] . ':(' . Solr::escapeQuery((string) $parameters['q']) . ') AND ' . $fields['uid'] . ':' . $this->getUid($parameters['uid']);
     }
 
@@ -133,8 +130,7 @@ 
      *
      * @return int|string uid of the document
      */
-    private function getUid($uid)
-    {
+    private function getUid($uid) {
         return is_numeric($uid) ? intval($uid) : $uid;
     }
 }

Classes/Common/Document.php

Braces +33 added lines, -66 removed lines

@@ -48,8 +48,7 @@ 
  * @property-read mixed $uid This holds the UID or the URL of the document
  * @abstract
  */
-abstract class Document
-{
+abstract class Document {
     /**
      * This holds the logger
      *
@@ -341,8 +340,7 @@ 
      *
      * @return void
      */
-    public static function clearRegistry()
-    {
+    public static function clearRegistry() {
         // Reset registry array.
         self::$registry = [];
     }
@@ -617,8 +615,7 @@ 
      *
      * @return int The physical page number
      */
-    public function getPhysicalPage($logicalPage)
-    {
+    public function getPhysicalPage($logicalPage) {
         if (
             !empty($this->lastSearchedPhysicalPage['logicalPage'])
             && $this->lastSearchedPhysicalPage['logicalPage'] == $logicalPage
@@ -663,8 +660,7 @@ 
      *
      * @return string The OCR full text
      */
-    protected function getFullTextFromXml($id)
-    {
+    protected function getFullTextFromXml($id) {
         $fullText = '';
         // Load available text formats, ...
         $this->loadFormats();
@@ -726,8 +722,7 @@ 
      *
      * @return string The format of the OCR full text
      */
-    private function getTextFormat($fileContent)
-    {
+    private function getTextFormat($fileContent) {
         // Get the root element's name as text format.
         return strtoupper($this->getXmlObject($fileContent)->getName());
     }
@@ -741,8 +736,7 @@ 
      *
      * @return \SimpleXMLElement The OCR full text as object
      */
-    private function getXmlObject($fileContent)
-    {
+    private function getXmlObject($fileContent) {
         // 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.
@@ -769,8 +763,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) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         $title = '';
@@ -824,8 +817,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) {
@@ -858,8 +850,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;
@@ -881,8 +872,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);
     }
 
@@ -932,8 +922,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)) {
             // Load extension configuration
@@ -966,8 +955,7 @@ 
      *
      * @return void
      */
-    protected function loadFormats()
-    {
+    protected function loadFormats() {
         if (!$this->formatsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_formats');
@@ -1007,8 +995,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?
@@ -1037,8 +1024,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public function save($pid = 0, $core = 0, $owner = null)
-    {
+    public function save($pid = 0, $core = 0, $owner = null) {
         if (\TYPO3_MODE !== 'BE') {
             $this->logger->error('Saving a document is only allowed in the backend');
             return false;
@@ -1366,8 +1352,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -1378,8 +1363,7 @@ 
      *
      * @return bool Are there any fulltext files available?
      */
-    protected function _getHasFulltext()
-    {
+    protected function _getHasFulltext() {
         $this->ensureHasFulltextIsSet();
         return $this->hasFulltext;
     }
@@ -1391,8 +1375,7 @@ 
      *
      * @return string The location of the document
      */
-    protected function _getLocation()
-    {
+    protected function _getLocation() {
         return $this->location;
     }
 
@@ -1414,8 +1397,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) {
@@ -1440,8 +1422,7 @@ 
      *
      * @return int The total number of pages and/or tracks
      */
-    protected function _getNumPages()
-    {
+    protected function _getNumPages() {
         $this->_getPhysicalStructure();
         return $this->numPages;
     }
@@ -1453,8 +1434,7 @@ 
      *
      * @return int The UID of the parent document or zero if not applicable
      */
-    protected function _getParentId()
-    {
+    protected function _getParentId() {
         return $this->parentId;
     }
 
@@ -1477,8 +1457,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.
@@ -1494,8 +1473,7 @@ 
      *
      * @return int The PID of the document or zero if not in database
      */
-    protected function _getPid()
-    {
+    protected function _getPid() {
         return $this->pid;
     }
 
@@ -1506,8 +1484,7 @@ 
      *
      * @return bool Is the document instantiated successfully?
      */
-    protected function _getReady()
-    {
+    protected function _getReady() {
         return $this->ready;
     }
 
@@ -1518,8 +1495,7 @@ 
      *
      * @return mixed The METS file's / IIIF manifest's record identifier
      */
-    protected function _getRecordId()
-    {
+    protected function _getRecordId() {
         return $this->recordId;
     }
 
@@ -1530,8 +1506,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, $this->pid);
@@ -1561,8 +1536,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.
@@ -1603,8 +1577,7 @@ 
      *
      * @return mixed The UID or the URL of the document
      */
-    protected function _getUid()
-    {
+    protected function _getUid() {
         return $this->uid;
     }
 
@@ -1617,8 +1590,7 @@ 
      *
      * @return void
      */
-    protected function _setCPid($value)
-    {
+    protected function _setCPid($value) {
         $this->cPid = max(intval($value), 0);
     }
 
@@ -1629,8 +1601,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -1647,8 +1618,7 @@ 
      *
      * @return void
      */
-    protected function __construct($uid, $pid, $preloadedDocument)
-    {
+    protected function __construct($uid, $pid, $preloadedDocument) {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable('tx_dlf_documents');
         $location = '';
@@ -1760,8 +1730,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -1783,8 +1752,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));
     }
 
@@ -1798,8 +1766,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)

Classes/Common/DocumentList.php

Braces +32 added lines, -64 removed lines

@@ -104,8 +104,7 @@ 
      *
      * @return void
      */
-    public function add(array $elements, $position = -1)
-    {
+    public function add(array $elements, $position = -1) {
         $position = MathUtility::forceIntegerInRange($position, 0, $this->count, $this->count);
         if (!empty($elements)) {
             array_splice($this->elements, $position, 0, $elements);
@@ -121,8 +120,7 @@ 
      *
      * @return int The number of elements in the list
      */
-    public function count()
-    {
+    public function count() {
         return $this->count;
     }
 
@@ -134,8 +132,7 @@ 
      *
      * @return array The current element
      */
-    public function current()
-    {
+    public function current() {
         if ($this->valid()) {
             return $this->getRecord($this->elements[$this->position]);
         } else {
@@ -153,8 +150,7 @@ 
      *
      * @return mixed The element's full record
      */
-    protected function getRecord($element)
-    {
+    protected function getRecord($element) {
         if (
             is_array($element)
             && array_keys($element) == ['u', 'h', 's', 'p']
@@ -261,8 +257,7 @@ 
      *
      * @return Result
      */
-    private function getSolrResult($record)
-    {
+    private function getSolrResult($record) {
         $fields = Solr::getFields();
 
         $query = $this->solr->service->createSelect();
@@ -334,8 +329,7 @@ 
      *
      * @return array
      */
-    private function getSolrRecord($record, $result)
-    {
+    private function getSolrRecord($record, $result) {
         // If it is a fulltext search, fetch the highlighting results.
         if ($this->metadata['fulltextSearch']) {
             $data = $result->getData();
@@ -382,8 +376,7 @@ 
      *
      * @return int The current position
      */
-    public function key()
-    {
+    public function key() {
         return $this->position;
     }
 
@@ -397,8 +390,7 @@ 
      *
      * @return void
      */
-    public function move($position, $steps)
-    {
+    public function move($position, $steps) {
         $position = intval($position);
         // Check if list position is valid.
         if (
@@ -429,8 +421,7 @@ 
      *
      * @return void
      */
-    public function moveUp($position)
-    {
+    public function moveUp($position) {
         $this->move($position, -1);
     }
 
@@ -443,8 +434,7 @@ 
      *
      * @return void
      */
-    public function moveDown($position)
-    {
+    public function moveDown($position) {
         $this->move($position, 1);
     }
 
@@ -456,8 +446,7 @@ 
      *
      * @return void
      */
-    public function next()
-    {
+    public function next() {
         $this->position++;
     }
 
@@ -471,8 +460,7 @@ 
      *
      * @return bool Does the given offset exist?
      */
-    public function offsetExists($offset)
-    {
+    public function offsetExists($offset) {
         return isset($this->elements[$offset]);
     }
 
@@ -486,8 +474,7 @@ 
      *
      * @return array The element at the given offset
      */
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
         if ($this->offsetExists($offset)) {
             return $this->getRecord($this->elements[$offset]);
         } else {
@@ -507,8 +494,7 @@ 
      *
      * @return void
      */
-    public function offsetSet($offset, $value)
-    {
+    public function offsetSet($offset, $value) {
         if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($offset)) {
             $this->elements[$offset] = $value;
         } else {
@@ -528,8 +514,7 @@ 
      *
      * @return array The removed element
      */
-    public function remove($position)
-    {
+    public function remove($position) {
         $position = intval($position);
         if (
             $position < 0
@@ -553,8 +538,7 @@ 
      *
      * @return array The indizes of the removed elements
      */
-    public function removeRange($position, $length)
-    {
+    public function removeRange($position, $length) {
         $position = intval($position);
         if (
             $position < 0
@@ -575,8 +559,7 @@ 
      *
      * @return void
      */
-    public function reset()
-    {
+    public function reset() {
         $this->elements = [];
         $this->records = [];
         $this->metadata = [];
@@ -592,8 +575,7 @@ 
      *
      * @return void
      */
-    public function rewind()
-    {
+    public function rewind() {
         $this->position = 0;
     }
 
@@ -606,8 +588,7 @@ 
      *
      * @return void
      */
-    public function save($pid = 0)
-    {
+    public function save($pid = 0) {
         $pid = max(intval($pid), 0);
         // If no PID is given, save to the user's session instead
         if ($pid > 0) {
@@ -624,8 +605,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected function solrConnect()
-    {
+    protected function solrConnect() {
         // Get Solr instance.
         if (!$this->solr) {
             // Connect to Solr server.
@@ -674,8 +654,7 @@ 
      *
      * @return void
      */
-    public function sort($by, $asc = true)
-    {
+    public function sort($by, $asc = true) {
         $newOrder = [];
         $nonSortable = [];
         foreach ($this->elements as $num => $element) {
@@ -712,8 +691,7 @@ 
      *
      * @return void
      */
-    public function offsetUnset($offset)
-    {
+    public function offsetUnset($offset) {
         unset($this->elements[$offset]);
         // Re-number the elements.
         $this->elements = array_values($this->elements);
@@ -728,8 +706,7 @@ 
      *
      * @return bool Is the current list position valid?
      */
-    public function valid()
-    {
+    public function valid() {
         return isset($this->elements[$this->position]);
     }
 
@@ -740,8 +717,7 @@ 
      *
      * @return array The list's metadata
      */
-    protected function _getMetadata()
-    {
+    protected function _getMetadata() {
         return $this->metadata;
     }
 
@@ -754,8 +730,7 @@ 
      *
      * @return void
      */
-    protected function _setMetadata(array $metadata = [])
-    {
+    protected function _setMetadata(array $metadata = []) {
         $this->metadata = $metadata;
     }
 
@@ -769,8 +744,7 @@ 
      *
      * @return void
      */
-    public function __construct(array $elements = [], array $metadata = [])
-    {
+    public function __construct(array $elements = [], array $metadata = []) {
         if (
             empty($elements)
             && empty($metadata)
@@ -803,8 +777,7 @@ 
      *
      * @return void
      */
-    protected function __clone()
-    {
+    protected function __clone() {
         // This method is defined as protected because singleton objects should not be cloned.
     }
 
@@ -817,8 +790,7 @@ 
      *
      * @return mixed Value of $this->$var
      */
-    public function __get($var)
-    {
+    public function __get($var) {
         $method = '_get' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -840,8 +812,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));
     }
 
@@ -855,8 +826,7 @@ 
      *
      * @return void
      */
-    public function __set($var, $value)
-    {
+    public function __set($var, $value) {
         $method = '_set' . ucfirst($var);
         if (
             !property_exists($this, $var)
@@ -876,8 +846,7 @@ 
      *
      * @return array Properties to be serialized
      */
-    public function __sleep()
-    {
+    public function __sleep() {
         return ['elements', 'metadata'];
     }
 
@@ -889,8 +858,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $this->count = count($this->elements);
     }
 }

Classes/Common/IiifManifest.php

Braces +28 added lines, -56 removed lines

@@ -56,8 +56,7 @@ 
  * @property-read string $toplevelId This holds the toplevel manifest's @id
  * @property-read mixed $uid This holds the UID or the URL of the document
  */
-final class IiifManifest extends Document
-{
+final class IiifManifest extends Document {
     /**
      * This holds the manifest file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -118,8 +117,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
@@ -170,8 +168,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->iiif;
     }
 
@@ -184,8 +181,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';
@@ -226,8 +222,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);
@@ -255,8 +250,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)) {
@@ -369,8 +363,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) {
@@ -383,8 +376,7 @@ 
      * {@inheritDoc}
      * @see Document::getFileLocation()
      */
-    public function getFileLocation($id)
-    {
+    public function getFileLocation($id) {
         if ($id == null) {
             return null;
         }
@@ -408,8 +400,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";
@@ -434,8 +425,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];
@@ -470,8 +460,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'] = '';
@@ -563,8 +552,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];
         }
@@ -606,8 +594,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];
         }
@@ -714,8 +701,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) {
@@ -739,8 +725,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) {
@@ -763,8 +748,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();
@@ -779,8 +763,7 @@ 
      *
      * @see Document::getParentDocumentUidForSaving()
      */
-    protected function getParentDocumentUidForSaving($pid, $core, $owner)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core, $owner) {
         // Do nothing.
     }
 
@@ -789,8 +772,7 @@ 
      * @see Document::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])) {
@@ -847,8 +829,7 @@ 
      *
      * @return IiifResourceInterface
      */
-    public function getIiif()
-    {
+    public function getIiif() {
         return $this->iiif;
     }
 
@@ -856,8 +837,7 @@ 
      * {@inheritDoc}
      * @see Document::init()
      */
-    protected function init()
-    {
+    protected function init() {
         // Nothing to do here, at the moment
     }
 
@@ -865,8 +845,7 @@ 
      * {@inheritDoc}
      * @see Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = GeneralUtility::getUrl($location);
         if ($fileResource !== false) {
             $conf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get(self::$extKey);
@@ -889,8 +868,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);
     }
@@ -899,8 +877,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
         if ($preloadedDocument instanceof ManifestInterface) {
             $this->iiif = $preloadedDocument;
             return true;
@@ -912,8 +889,7 @@ 
      * {@inheritDoc}
      * @see Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         /*
          *  TODO Check annotations and annotation lists of canvas for ALTO documents.
          *  Example:
@@ -959,8 +935,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         return $this->iiif->getThumbnailUrl();
     }
 
@@ -968,8 +943,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();
@@ -986,8 +960,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']);
@@ -1006,8 +979,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/SolrSearchResult/ResultDocument.php

Braces +15 added lines, -30 removed lines

@@ -24,8 +24,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class ResultDocument
-{
+class ResultDocument {
 
     /**
      * The identifier
@@ -102,8 +101,7 @@ 
      *
      * @return void
      */
-    public function __construct($record, $highlighting, $fields)
-    {
+    public function __construct($record, $highlighting, $fields) {
         $this->id = $record[$fields['id']];
         $this->uid = $record[$fields['uid']];
         $this->page = $record[$fields['page']];
@@ -124,8 +122,7 @@ 
      *
      * @return string The result's record identifier
      */
-    public function getId()
-    {
+    public function getId() {
         return $this->id;
     }
 
@@ -136,8 +133,7 @@ 
      *
      * @return string|null The result's record unified identifier
      */
-    public function getUid()
-    {
+    public function getUid() {
         return $this->uid;
     }
 
@@ -148,8 +144,7 @@ 
      *
      * @return int The result's record page
      */
-    public function getPage()
-    {
+    public function getPage() {
         return $this->page;
     }
 
@@ -160,8 +155,7 @@ 
      *
      * @return string All result's record snippets imploded to one string
      */
-    public function getSnippets()
-    {
+    public function getSnippets() {
         return $this->snippets;
     }
 
@@ -172,8 +166,7 @@ 
      *
      * @return array(Page) All result's pages which contain search phrase
      */
-    public function getPages()
-    {
+    public function getPages() {
         return $this->pages;
     }
 
@@ -184,8 +177,7 @@ 
      *
      * @return array(Region) All result's regions which contain search phrase
      */
-    public function getRegions()
-    {
+    public function getRegions() {
         return $this->regions;
     }
 
@@ -196,8 +188,7 @@ 
      *
      * @return array(Highlight) All result's highlights of search phrase
      */
-    public function getHighlights()
-    {
+    public function getHighlights() {
         return $this->highlights;
     }
 
@@ -208,8 +199,7 @@ 
      *
      * @return array(string) All result's highlights of search phrase
      */
-    public function getHighlightsIds()
-    {
+    public function getHighlightsIds() {
         $highlightsIds = [];
         foreach ($this->highlights as $highlight) {
             array_push($highlightsIds, $highlight->getId());
@@ -225,8 +215,7 @@ 
      *
      * @return void
      */
-    private function parseSnippets()
-    {
+    private function parseSnippets() {
         $snippetArray = $this->getArrayByIndex('text');
 
         $this->snippets = !empty($snippetArray) ? implode(' [...] ', $snippetArray) : '';
@@ -240,8 +229,7 @@ 
      *
      * @return void
      */
-    private function parsePages()
-    {
+    private function parsePages() {
         $pageArray = $this->getArrayByIndex('pages');
 
         $i = 0;
@@ -261,8 +249,7 @@ 
      *
      * @return void
      */
-    private function parseRegions()
-    {
+    private function parseRegions() {
         $regionArray = $this->getArrayByIndex('regions');
 
         $i = 0;
@@ -282,8 +269,7 @@ 
      *
      * @return void
      */
-    private function parseHighlights()
-    {
+    private function parseHighlights() {
         $highlightArray = $this->getArrayByIndex('highlights');
 
         foreach ($highlightArray as $highlights) {
@@ -304,8 +290,7 @@ 
      *
      * @return array
      */
-    private function getArrayByIndex($index)
-    {
+    private function getArrayByIndex($index) {
         $objectArray = [];
         foreach ($this->snippetsForRecord as $snippet) {
             if (!empty($snippet[$index])) {

Classes/Common/SolrSearchResult/Highlight.php

Braces +7 added lines, -14 removed lines

@@ -20,8 +20,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Highlight
-{
+class Highlight {
 
     /**
      * The identifier in form 'w_h_x_y'
@@ -80,8 +79,7 @@ 
      *
      * @return void
      */
-    public function __construct($highlight)
-    {
+    public function __construct($highlight) {
         $this->parentRegionId = $highlight['parentRegionIdx'];
         $this->xBeginPosition = $highlight['ulx'];
         $this->xEndPosition = $highlight['lrx'];
@@ -97,8 +95,7 @@ 
      *
      * @return string The highlight's identifier
      */
-    public function getId()
-    {
+    public function getId() {
         return $this->id;
     }
 
@@ -109,8 +106,7 @@ 
      *
      * @return int The highlight's horizontal beginning position
      */
-    public function getXBeginPosition()
-    {
+    public function getXBeginPosition() {
         return $this->xBeginPosition;
     }
 
@@ -121,8 +117,7 @@ 
      *
      * @return int The highlight's horizontal ending position
      */
-    public function getXEndPosition()
-    {
+    public function getXEndPosition() {
         return $this->xEndPosition;
     }
 
@@ -133,8 +128,7 @@ 
      *
      * @return int The highlight's vertical beginning position
      */
-    public function getYBeginPosition()
-    {
+    public function getYBeginPosition() {
         return $this->yBeginPosition;
     }
 
@@ -145,8 +139,7 @@ 
      *
      * @return int The highlight's vertical ending position
      */
-    public function getYEndPosition()
-    {
+    public function getYEndPosition() {
         return $this->yEndPosition;
     }
 }

Classes/Common/MetsDocument.php

Braces +28 added lines, -56 removed lines

@@ -48,8 +48,7 @@ 
  * @property-read string $toplevelId This holds the toplevel structure's @ID (METS) or the manifest's @id (IIIF)
  * @property-read mixed $uid This holds the UID or the URL of the document
  */
-final class MetsDocument extends Document
-{
+final class MetsDocument extends Document {
     /**
      * This holds the whole XML file as string for serialization purposes
      * @see __sleep() / __wakeup()
@@ -128,8 +127,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'];
@@ -143,8 +141,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'];
@@ -164,8 +161,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') {
@@ -190,8 +186,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::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)
@@ -208,8 +203,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::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)
@@ -226,8 +220,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 (
@@ -267,8 +260,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;
@@ -366,8 +358,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.
@@ -669,8 +660,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::getFullText()
      */
-    public function getFullText($id)
-    {
+    public function getFullText($id) {
         $fullText = '';
 
         // Load fileGrps and check for full text files.
@@ -685,8 +675,7 @@ 
      * {@inheritDoc}
      * @see Document::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);
@@ -699,8 +688,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');
@@ -717,8 +705,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::loadLocation()
      */
-    protected function loadLocation($location)
-    {
+    protected function loadLocation($location) {
         $fileResource = GeneralUtility::getUrl($location);
         if ($fileResource !== false) {
             // Turn off libxml's error logging.
@@ -745,8 +732,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -757,8 +743,7 @@ 
      * {@inheritDoc}
      * @see Document::getParentDocumentUid()
      */
-    protected function getParentDocumentUidForSaving($pid, $core, $owner)
-    {
+    protected function getParentDocumentUidForSaving($pid, $core, $owner) {
         $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');
@@ -781,8 +766,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -795,8 +779,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -807,8 +790,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();
@@ -846,8 +828,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);
@@ -892,8 +873,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::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)) {
@@ -911,8 +891,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -920,8 +899,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"?
@@ -981,8 +959,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');
             if (!empty($smLinks)) {
@@ -1000,8 +977,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1080,8 +1056,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.
             $divs = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@DMDID and not(./mets:mptr)]');
@@ -1113,8 +1088,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'];
@@ -1127,8 +1101,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;
@@ -1143,8 +1116,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/Indexer.php

Braces +8 added lines, -16 removed lines

@@ -29,8 +29,7 @@ 
  * @subpackage dlf
  * @access public
  */
-class Indexer
-{
+class Indexer {
     /**
      * The extension key
      *
@@ -91,8 +90,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    public static function add(Document &$doc, $core = 0)
-    {
+    public static function add(Document &$doc, $core = 0) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         if (in_array($doc->uid, self::$processedDocs)) {
@@ -214,8 +212,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) {
         $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
 
         // Sanitize input.
@@ -243,8 +240,7 @@ 
      *
      * @return void
      */
-    protected static function loadIndexConf($pid)
-    {
+    protected static function loadIndexConf($pid) {
         if (!self::$fieldsLoaded) {
             $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                 ->getQueryBuilderForTable('tx_dlf_metadata');
@@ -314,8 +310,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processLogical(Document &$doc, array $logicalUnit)
-    {
+    protected static function processLogical(Document &$doc, array $logicalUnit) {
         $logger = GeneralUtility::makeInstance('TYPO3\CMS\Core\Log\LogManager')->getLogger(__CLASS__);
 
         $success = true;
@@ -446,8 +441,7 @@ 
      *
      * @return bool true on success or false on failure
      */
-    protected static function processPhysical(Document &$doc, $page, array $physicalUnit)
-    {
+    protected static function processPhysical(Document &$doc, $page, array $physicalUnit) {
         $logger = GeneralUtility::makeInstance('TYPO3\CMS\Core\Log\LogManager')->getLogger(__CLASS__);
 
         if ($doc->hasFulltext && $fullText = $doc->getFullText($physicalUnit['id'])) {
@@ -533,8 +527,7 @@ 
      *
      * @return bool 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.
@@ -557,8 +550,7 @@ 
      *
      * @access private
      */
-    private function __construct()
-    {
+    private function __construct() {
         // This is a static class, thus no instances should be created.
     }
 }