matecat / xliff-parser

src/XliffParser/XliffParserV1.php

Spacing +115 added lines, -115 removed lines

@@ -16,41 +16,41 @@ 
      * @inheritDoc
      * @throws Exception
      */
-    public function parse( DOMDocument $dom, ?array $output = [] ): array {
+    public function parse(DOMDocument $dom, ?array $output = []): array {
         $i = 1;
         /** @var DOMElement $file */
-        foreach ( $dom->getElementsByTagName( 'file' ) as $file ) {
+        foreach ($dom->getElementsByTagName('file') as $file) {
 
             // metadata
-            $output[ 'files' ][ $i ][ 'attr' ] = $this->extractMetadata( $file );
+            $output['files'][$i]['attr'] = $this->extractMetadata($file);
 
             // reference
-            if ( !empty( $this->extractReference( $file ) ) ) {
-                $output[ 'files' ][ $i ][ 'reference' ] = $this->extractReference( $file );
+            if (!empty($this->extractReference($file))) {
+                $output['files'][$i]['reference'] = $this->extractReference($file);
             }
 
             // trans-units
             $transUnitIdArrayForUniquenessCheck = [];
             $j                                  = 1;
-            foreach ( $file->childNodes as $body ) {
+            foreach ($file->childNodes as $body) {
 
                 // external-file
-                if ( $body->nodeName === 'header' ) {
-                    foreach ( $body->childNodes as $header ) {
-                        $this->extractExternalFile( $header, $i, $output );
+                if ($body->nodeName === 'header') {
+                    foreach ($body->childNodes as $header) {
+                        $this->extractExternalFile($header, $i, $output);
                     }
                 }
 
-                if ( $body->nodeName === 'body' ) {
-                    foreach ( $body->childNodes as $childNode ) {
-                        $this->extractTuFromNode( $childNode, $transUnitIdArrayForUniquenessCheck, $dom, $output, $i, $j );
+                if ($body->nodeName === 'body') {
+                    foreach ($body->childNodes as $childNode) {
+                        $this->extractTuFromNode($childNode, $transUnitIdArrayForUniquenessCheck, $dom, $output, $i, $j);
                     }
 
                     // trans-unit re-count check
-                    $totalTransUnitsId  = count( $transUnitIdArrayForUniquenessCheck );
-                    $transUnitsUniqueId = count( array_unique( $transUnitIdArrayForUniquenessCheck ) );
-                    if ( $totalTransUnitsId != $transUnitsUniqueId ) {
-                        throw new DuplicateTransUnitIdInXliff( "Invalid trans-unit id, duplicate found.", 400 );
+                    $totalTransUnitsId  = count($transUnitIdArrayForUniquenessCheck);
+                    $transUnitsUniqueId = count(array_unique($transUnitIdArrayForUniquenessCheck));
+                    if ($totalTransUnitsId != $transUnitsUniqueId) {
+                        throw new DuplicateTransUnitIdInXliff("Invalid trans-unit id, duplicate found.", 400);
                     }
 
                     $i++;
@@ -66,27 +66,27 @@ 
      * @param            $i
      * @param            $output
      */
-    private function extractExternalFile( DOMNode $header, $i, &$output ) {
-
-        if ( $header->nodeName === "skl" ) {
-            foreach ( $header->childNodes as $referenceNode ) {
-                if ( $referenceNode->nodeName === "reference" ) {
-                    foreach ( $referenceNode->childNodes as $childNode ) {
-                        if ( $childNode->nodeName === "external-file" ) {
-                            $href                                                 = $childNode->getAttribute( "href" );
-                            $output[ 'files' ][ $i ][ 'attr' ][ 'external-file' ] = $href;
+    private function extractExternalFile(DOMNode $header, $i, &$output) {
+
+        if ($header->nodeName === "skl") {
+            foreach ($header->childNodes as $referenceNode) {
+                if ($referenceNode->nodeName === "reference") {
+                    foreach ($referenceNode->childNodes as $childNode) {
+                        if ($childNode->nodeName === "external-file") {
+                            $href                                                 = $childNode->getAttribute("href");
+                            $output['files'][$i]['attr']['external-file'] = $href;
                         }
                     }
-                } elseif ( $referenceNode->nodeName === "external-file" ) {
-                    $href                                                 = $referenceNode->getAttribute( "href" );
-                    $output[ 'files' ][ $i ][ 'attr' ][ 'external-file' ] = $href;
+                } elseif ($referenceNode->nodeName === "external-file") {
+                    $href                                                 = $referenceNode->getAttribute("href");
+                    $output['files'][$i]['attr']['external-file'] = $href;
                 }
             }
-        } elseif ( $header->nodeName === "reference" ) {
-            foreach ( $header->childNodes as $referenceNode ) {
-                if ( $referenceNode->nodeName === "external-file" ) {
-                    $href                                                 = $referenceNode->getAttribute( "href" );
-                    $output[ 'files' ][ $i ][ 'attr' ][ 'external-file' ] = $href;
+        } elseif ($header->nodeName === "reference") {
+            foreach ($header->childNodes as $referenceNode) {
+                if ($referenceNode->nodeName === "external-file") {
+                    $href                                                 = $referenceNode->getAttribute("href");
+                    $output['files'][$i]['attr']['external-file'] = $href;
                 }
             }
         }
@@ -97,50 +97,50 @@ 
      *
      * @return array
      */
-    private function extractMetadata( DOMElement $file ): array {
+    private function extractMetadata(DOMElement $file): array {
         $metadata   = [];
         $customAttr = [];
 
         /** @var DOMAttr $attribute */
-        foreach ( $file->attributes as $attribute ) {
-            switch ( $attribute->localName ) {
+        foreach ($file->attributes as $attribute) {
+            switch ($attribute->localName) {
                 // original
                 case 'original':
-                    $metadata[ 'original' ] = $attribute->value;
+                    $metadata['original'] = $attribute->value;
                     break;
 
                 // source-language
                 case 'source-language':
-                    $metadata[ 'source-language' ] = $attribute->value;
+                    $metadata['source-language'] = $attribute->value;
                     break;
 
                 // data-type
                 case 'datatype':
-                    $metadata[ 'data-type' ] = $attribute->value;
+                    $metadata['data-type'] = $attribute->value;
                     break;
 
                 // target-language
                 case 'target-language':
-                    $metadata[ 'target-language' ] = $attribute->value;
+                    $metadata['target-language'] = $attribute->value;
                     break;
             }
 
             // Custom MateCat x-Attribute
-            preg_match( '|x-(.*?)|si', $attribute->localName, $temp );
-            if ( isset( $temp[ 1 ] ) ) {
-                $customAttr[ $attribute->localName ] = $attribute->value;
+            preg_match('|x-(.*?)|si', $attribute->localName, $temp);
+            if (isset($temp[1])) {
+                $customAttr[$attribute->localName] = $attribute->value;
             }
-            unset( $temp );
+            unset($temp);
 
             // Custom MateCat namespace Attribute mtc:
-            preg_match( '|mtc:(.*?)|si', $attribute->nodeName, $temp );
-            if ( isset( $temp[ 1 ] ) ) {
-                $customAttr[ $attribute->nodeName ] = $attribute->value;
+            preg_match('|mtc:(.*?)|si', $attribute->nodeName, $temp);
+            if (isset($temp[1])) {
+                $customAttr[$attribute->nodeName] = $attribute->value;
             }
-            unset( $temp );
+            unset($temp);
 
-            if ( !empty( $customAttr ) ) {
-                $metadata[ 'custom' ] = $customAttr;
+            if (!empty($customAttr)) {
+                $metadata['custom'] = $customAttr;
             }
         }
 
@@ -152,16 +152,16 @@ 
      *
      * @return array
      */
-    private function extractReference( DOMElement $file ): array {
+    private function extractReference(DOMElement $file): array {
         $reference = [];
 
         $order = 0;
-        foreach ( $file->getElementsByTagName( 'reference' ) as $ref ) {
+        foreach ($file->getElementsByTagName('reference') as $ref) {
             /** @var DOMNode $childNode */
-            foreach ( $ref->childNodes as $childNode ) {
-                if ( $childNode->nodeName === 'internal-file' ) {
-                    $reference[ $order ][ 'form-type' ] = $childNode->attributes->getNamedItem( 'form' )->nodeValue;
-                    $reference[ $order ][ 'base64' ]    = trim( $childNode->nodeValue );
+            foreach ($ref->childNodes as $childNode) {
+                if ($childNode->nodeName === 'internal-file') {
+                    $reference[$order]['form-type'] = $childNode->attributes->getNamedItem('form')->nodeValue;
+                    $reference[$order]['base64']    = trim($childNode->nodeValue);
                     $order++;
                 }
             }
@@ -183,61 +183,61 @@ 
      *
      * @throws Exception
      */
-    protected function extractTransUnit( DOMElement $transUnit, array &$transUnitIdArrayForUniquenessCheck, DomDocument $dom, array &$output, int &$i, int &$j, ?array $contextGroups = [] ) {
+    protected function extractTransUnit(DOMElement $transUnit, array &$transUnitIdArrayForUniquenessCheck, DomDocument $dom, array &$output, int &$i, int &$j, ?array $contextGroups = []) {
         // metadata
-        $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'attr' ] = $this->extractTransUnitMetadata( $transUnit, $transUnitIdArrayForUniquenessCheck );
+        $output['files'][$i]['trans-units'][$j]['attr'] = $this->extractTransUnitMetadata($transUnit, $transUnitIdArrayForUniquenessCheck);
 
         // notes
-        $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'notes' ] = $this->extractTransUnitNotes( $dom, $transUnit );
+        $output['files'][$i]['trans-units'][$j]['notes'] = $this->extractTransUnitNotes($dom, $transUnit);
 
         // content
         /** @var DOMElement $childNode */
-        foreach ( $transUnit->childNodes as $childNode ) {
+        foreach ($transUnit->childNodes as $childNode) {
             // source
-            if ( $childNode->nodeName === 'source' ) {
-                $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'source' ] = $this->extractContent( $dom, $childNode );
+            if ($childNode->nodeName === 'source') {
+                $output['files'][$i]['trans-units'][$j]['source'] = $this->extractContent($dom, $childNode);
             }
 
             // seg-source
-            if ( $childNode->nodeName === 'seg-source' ) {
-                $rawSegment                                                     = $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'source' ][ 'raw-content' ];
-                $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'seg-source' ] = $this->extractContentWithMarksAndExtTags( $dom, $childNode, $rawSegment );
+            if ($childNode->nodeName === 'seg-source') {
+                $rawSegment                                                     = $output['files'][$i]['trans-units'][$j]['source']['raw-content'];
+                $output['files'][$i]['trans-units'][$j]['seg-source'] = $this->extractContentWithMarksAndExtTags($dom, $childNode, $rawSegment);
             }
 
             // target
-            if ( $childNode->nodeName === 'target' ) {
-                $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'target' ] = $this->extractContent( $dom, $childNode );
+            if ($childNode->nodeName === 'target') {
+                $output['files'][$i]['trans-units'][$j]['target'] = $this->extractContent($dom, $childNode);
 
                 // seg-target
-                $targetRawContent = $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'target' ][ 'raw-content' ] ?? null;
-                $segSource        = $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'seg-source' ] ?? null;
+                $targetRawContent = $output['files'][$i]['trans-units'][$j]['target']['raw-content'] ?? null;
+                $segSource        = $output['files'][$i]['trans-units'][$j]['seg-source'] ?? null;
 
-                if ( !empty( $targetRawContent ) and isset( $segSource ) and count( $segSource ) > 0 ) {
-                    $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'seg-target' ]                = $this->extractContentWithMarksAndExtTags( $dom, $childNode );
-                    $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'seg-target' ][ 0 ][ 'attr' ] = $this->extractTagAttributes( $childNode );
+                if (!empty($targetRawContent) and isset($segSource) and count($segSource) > 0) {
+                    $output['files'][$i]['trans-units'][$j]['seg-target']                = $this->extractContentWithMarksAndExtTags($dom, $childNode);
+                    $output['files'][$i]['trans-units'][$j]['seg-target'][0]['attr'] = $this->extractTagAttributes($childNode);
                 }
             }
 
             // locked
-            if ( $childNode->nodeName === 'sdl:seg' ) {
-                $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'locked' ] = $this->extractLocked( $childNode );
+            if ($childNode->nodeName === 'sdl:seg') {
+                $output['files'][$i]['trans-units'][$j]['locked'] = $this->extractLocked($childNode);
             }
         }
 
         // context-group
-        if ( !empty( $contextGroups ) ) {
-            foreach ( $contextGroups as $contextGroup ) {
-                $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'context-group' ][] = $this->extractTransUnitContextGroup( $dom, $contextGroup );
+        if (!empty($contextGroups)) {
+            foreach ($contextGroups as $contextGroup) {
+                $output['files'][$i]['trans-units'][$j]['context-group'][] = $this->extractTransUnitContextGroup($dom, $contextGroup);
             }
         }
 
-        foreach ( $transUnit->getElementsByTagName( 'context-group' ) as $contextGroup ) {
-            $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'context-group' ][] = $this->extractTransUnitContextGroup( $dom, $contextGroup );
+        foreach ($transUnit->getElementsByTagName('context-group') as $contextGroup) {
+            $output['files'][$i]['trans-units'][$j]['context-group'][] = $this->extractTransUnitContextGroup($dom, $contextGroup);
         }
 
         // alt-trans
-        foreach ( $transUnit->getElementsByTagName( 'alt-trans' ) as $altTrans ) {
-            $output[ 'files' ][ $i ][ 'trans-units' ][ $j ][ 'alt-trans' ][] = $this->extractTransUnitAltTrans( $altTrans );
+        foreach ($transUnit->getElementsByTagName('alt-trans') as $altTrans) {
+            $output['files'][$i]['trans-units'][$j]['alt-trans'][] = $this->extractTransUnitAltTrans($altTrans);
         }
 
         $j++;
@@ -250,41 +250,41 @@ 
      * @return array
      * @throws Exception
      */
-    private function extractTransUnitMetadata( DOMElement $transUnit, array &$transUnitIdArrayForUniquenessCheck ): array {
+    private function extractTransUnitMetadata(DOMElement $transUnit, array &$transUnitIdArrayForUniquenessCheck): array {
         $metadata = [];
 
         // id MUST NOT be null
-        if ( null === $transUnit->attributes->getNamedItem( 'id' ) ) {
-            throw new NotFoundIdInTransUnit( 'Invalid trans-unit id found. EMPTY value', 400 );
+        if (null === $transUnit->attributes->getNamedItem('id')) {
+            throw new NotFoundIdInTransUnit('Invalid trans-unit id found. EMPTY value', 400);
         }
 
         /**
          * @var DOMAttr $element
          */
-        foreach ( $transUnit->attributes as $element ) {
+        foreach ($transUnit->attributes as $element) {
 
-            if ( $element->nodeName === "id" ) {
+            if ($element->nodeName === "id") {
 
                 $id = $element->nodeValue;
 
-                if ( strlen( $id ) > 100 ) {
-                    throw new SegmentIdTooLongException( 'Segment-id too long. Max 100 characters allowed', 400 );
+                if (strlen($id) > 100) {
+                    throw new SegmentIdTooLongException('Segment-id too long. Max 100 characters allowed', 400);
                 }
 
                 $transUnitIdArrayForUniquenessCheck[] = $id;
-                $metadata[ 'id' ]                     = $id;
+                $metadata['id']                     = $id;
 
-            } elseif ( $element->nodeName === "approved" ) {
+            } elseif ($element->nodeName === "approved") {
                 // approved as BOOLEAN
                 // http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html#approved
-                $metadata[ $element->nodeName ] = filter_var( $element->nodeValue, FILTER_VALIDATE_BOOLEAN );
-            } elseif ( $element->nodeName === "maxwidth" ) {
+                $metadata[$element->nodeName] = filter_var($element->nodeValue, FILTER_VALIDATE_BOOLEAN);
+            } elseif ($element->nodeName === "maxwidth") {
                 // we ignore ( but we get ) the attribute size-unit="char" assuming that a restriction is everytime done by character
                 // we duplicate the info to allow Xliff V1 and V2 to work the same
-                $metadata[ 'sizeRestriction' ]  = filter_var( $element->nodeValue, FILTER_SANITIZE_NUMBER_INT );
-                $metadata[ $element->nodeName ] = filter_var( $element->nodeValue, FILTER_SANITIZE_NUMBER_INT );
+                $metadata['sizeRestriction']  = filter_var($element->nodeValue, FILTER_SANITIZE_NUMBER_INT);
+                $metadata[$element->nodeName] = filter_var($element->nodeValue, FILTER_SANITIZE_NUMBER_INT);
             } else {
-                $metadata[ $element->nodeName ] = $element->nodeValue;
+                $metadata[$element->nodeName] = $element->nodeValue;
             }
 
         }
@@ -299,19 +299,19 @@ 
      * @return array
      * @throws Exception
      */
-    private function extractTransUnitNotes( DOMDocument $dom, DOMElement $transUnit ): array {
+    private function extractTransUnitNotes(DOMDocument $dom, DOMElement $transUnit): array {
         $notes = [];
-        foreach ( $transUnit->getElementsByTagName( 'note' ) as $note ) {
+        foreach ($transUnit->getElementsByTagName('note') as $note) {
 
-            $noteValue = $this->extractTagContent( $dom, $note );
+            $noteValue = $this->extractTagContent($dom, $note);
 
-            if ( '' !== $noteValue ) {
+            if ('' !== $noteValue) {
 
-                $extractedNote = $this->JSONOrRawContentArray( $noteValue );
+                $extractedNote = $this->JSONOrRawContentArray($noteValue);
 
                 // extract all the attributes
-                foreach ( $note->attributes as $attribute ) {
-                    $extractedNote[ $attribute->name ] = $attribute->value;
+                foreach ($note->attributes as $attribute) {
+                    $extractedNote[$attribute->name] = $attribute->value;
                 }
 
                 $notes[] = $extractedNote;
@@ -327,14 +327,14 @@ 
      *
      * @return array
      */
-    private function extractTransUnitContextGroup( DOMDocument $dom, DOMElement $contextGroup ): array {
+    private function extractTransUnitContextGroup(DOMDocument $dom, DOMElement $contextGroup): array {
         $cg           = [];
-        $cg[ 'attr' ] = $this->extractTagAttributes( $contextGroup );
+        $cg['attr'] = $this->extractTagAttributes($contextGroup);
 
         /** @var DOMNode $context */
-        foreach ( $contextGroup->childNodes as $context ) {
-            if ( $context->nodeName === 'context' ) {
-                $cg[ 'contexts' ][] = $this->extractContent( $dom, $context );
+        foreach ($contextGroup->childNodes as $context) {
+            if ($context->nodeName === 'context') {
+                $cg['contexts'][] = $this->extractContent($dom, $context);
             }
         }
 
@@ -346,16 +346,16 @@ 
      *
      * @return array
      */
-    private function extractTransUnitAltTrans( DOMElement $altTrans ) {
+    private function extractTransUnitAltTrans(DOMElement $altTrans) {
         $at           = [];
-        $at[ 'attr' ] = $this->extractTagAttributes( $altTrans );
+        $at['attr'] = $this->extractTagAttributes($altTrans);
 
-        if ( $altTrans->getElementsByTagName( 'source' )->length > 0 ) {
-            $at[ 'source' ] = $altTrans->getElementsByTagName( 'source' )->item( 0 )->nodeValue;
+        if ($altTrans->getElementsByTagName('source')->length > 0) {
+            $at['source'] = $altTrans->getElementsByTagName('source')->item(0)->nodeValue;
         }
 
-        if ( $altTrans->getElementsByTagName( 'target' ) ) {
-            $at[ 'target' ] = $altTrans->getElementsByTagName( 'target' )->item( 0 )->nodeValue;
+        if ($altTrans->getElementsByTagName('target')) {
+            $at['target'] = $altTrans->getElementsByTagName('target')->item(0)->nodeValue;
         }
 
         return $at;
@@ -366,7 +366,7 @@ 
      *
      * @return bool
      */
-    private function extractLocked( DOMElement $locked ) {
-        return null !== $locked->getAttribute( 'locked' );
+    private function extractLocked(DOMElement $locked) {
+        return null !== $locked->getAttribute('locked');
     }
 }