Erikmitk / kitodo-presentation

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;
@@ -420,8 +412,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.
@@ -675,8 +666,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();
@@ -723,8 +713,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.
@@ -739,8 +728,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);
@@ -753,8 +741,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);
@@ -778,8 +765,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);
@@ -797,8 +783,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -809,8 +794,7 @@ 
      * {@inheritDoc}
      * @see Doc::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -823,8 +807,7 @@ 
      * {@inheritDoc}
      * @see Doc::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -835,8 +818,7 @@ 
      *
      * @return array Array of metadata sections with their IDs as array key
      */
-    protected function _getMdSec()
-    {
+    protected function _getMdSec() {
         if (!$this->mdSecLoaded) {
             $this->loadFormats();
 
@@ -878,8 +860,7 @@ 
         return $this->mdSec;
     }
 
-    protected function _getDmdSec()
-    {
+    protected function _getDmdSec() {
         $this->_getMdSec();
         return $this->dmdSec;
     }
@@ -893,8 +874,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;
@@ -934,8 +914,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);
@@ -987,8 +966,7 @@ 
      * @access protected
      * @return array
      */
-    protected function _getFileInfos()
-    {
+    protected function _getFileInfos() {
         $this->_getFileGrps();
         return $this->fileInfos;
     }
@@ -997,8 +975,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)) {
@@ -1016,8 +993,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -1025,8 +1001,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"?
@@ -1088,8 +1063,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)) {
@@ -1107,8 +1081,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Doc::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1187,8 +1160,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)]');
@@ -1217,8 +1189,7 @@ 
      *
      * @return string|null
      */
-    public function _getParentHref()
-    {
+    public function _getParentHref() {
         if ($this->parentHref === null) {
             $this->parentHref = '';
 
@@ -1240,8 +1211,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'];
@@ -1254,8 +1224,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;
@@ -1270,8 +1239,7 @@ 
      *
      * @return void
      */
-    public function __wakeup()
-    {
+    public function __wakeup() {
         $xml = Helper::getXmlFileAsString($this->asXML);
         if ($xml !== false) {
             $this->asXML = '';