Erikmitk / kitodo-presentation

Classes/Common/MetsDocument.php

Braces +29 added lines, -58 removed lines

@@ -47,8 +47,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()
@@ -127,8 +126,7 @@ 
      *
      * @return  void
      */
-    public function addMetadataFromMets(&$metadata, $id)
-    {
+    public function addMetadataFromMets(&$metadata, $id) {
         $details = $this->getLogicalStructure($id);
         if (!empty($details)) {
             $metadata['mets_label'][0] = $details['label'];
@@ -141,8 +139,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'];
@@ -162,8 +159,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') {
@@ -188,8 +184,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)
@@ -206,8 +201,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)
@@ -224,8 +218,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 (
@@ -265,8 +258,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;
@@ -356,8 +348,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.
@@ -641,8 +632,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])) {
@@ -660,8 +650,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);
@@ -674,8 +663,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');
@@ -692,8 +680,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.
@@ -720,8 +707,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::ensureHasFulltextIsSet()
      */
-    protected function ensureHasFulltextIsSet()
-    {
+    protected function ensureHasFulltextIsSet() {
         // Are the fileGrps already loaded?
         if (!$this->fileGrpsLoaded) {
             $this->_getFileGrps();
@@ -732,8 +718,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');
@@ -756,8 +741,7 @@ 
      * {@inheritDoc}
      * @see Document::setPreloadedDocument()
      */
-    protected function setPreloadedDocument($preloadedDocument)
-    {
+    protected function setPreloadedDocument($preloadedDocument) {
 
         if ($preloadedDocument instanceof \SimpleXMLElement) {
             $this->xml = $preloadedDocument;
@@ -770,8 +754,7 @@ 
      * {@inheritDoc}
      * @see Document::getDocument()
      */
-    protected function getDocument()
-    {
+    protected function getDocument() {
         return $this->mets;
     }
 
@@ -782,8 +765,7 @@ 
      *
      * @return int The PID of the metadata definitions
      */
-    protected function _getCPid()
-    {
+    protected function _getCPid() {
         return $this->cPid;
     }
 
@@ -794,8 +776,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();
@@ -833,8 +814,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]);
@@ -879,8 +859,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)) {
@@ -898,8 +877,7 @@ 
      *
      * @return \SimpleXMLElement The XML's METS part as \SimpleXMLElement object
      */
-    protected function _getMets()
-    {
+    protected function _getMets() {
         return $this->mets;
     }
 
@@ -907,8 +885,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"?
@@ -968,8 +945,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)) {
@@ -987,8 +963,7 @@ 
      * {@inheritDoc}
      * @see \Kitodo\Dlf\Common\Document::_getThumbnail()
      */
-    protected function _getThumbnail($forceReload = false)
-    {
+    protected function _getThumbnail($forceReload = false) {
         if (
             !$this->thumbnailLoaded
             || $forceReload
@@ -1061,8 +1036,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)]');
@@ -1094,8 +1068,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'];
@@ -1108,8 +1081,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;
@@ -1124,8 +1096,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.