matecat / xliff-parser

src/XliffReplacer/Xliff12.php

Spacing +63 added lines, -63 removed lines

@@ -36,34 +36,34 @@ 
     /**
      * @var string
      */
-    protected string $namespace = "mtc";       // Custom namespace
+    protected string $namespace = "mtc"; // Custom namespace
 
     /**
      * @inheritDoc
      */
-    protected function tagOpen( $parser, string $name, array $attr ) {
+    protected function tagOpen($parser, string $name, array $attr) {
 
-        $this->handleOpenUnit( $name, $attr );
+        $this->handleOpenUnit($name, $attr);
 
-        $this->trySetAltTrans( $name );;
-        $this->checkSetInTarget( $name );
+        $this->trySetAltTrans($name); ;
+        $this->checkSetInTarget($name);
 
         // open buffer
-        $this->setInBuffer( $name );
+        $this->setInBuffer($name);
 
         // check if we are inside a <target>, obviously this happen only if there are targets inside the trans-unit
         // <target> must be stripped to be replaced, so this check avoids <target> reconstruction
-        if ( !$this->inTarget ) {
+        if (!$this->inTarget) {
 
             $tag = '';
 
             // construct tag
             $tag .= "<$name ";
 
-            foreach ( $attr as $k => $v ) {
+            foreach ($attr as $k => $v) {
 
                 //if tag name is file, we must replace the target-language attribute
-                if ( $name === 'file' && $k === 'target-language' && !empty( $this->targetLang ) ) {
+                if ($name === 'file' && $k === 'target-language' && !empty($this->targetLang)) {
                     //replace Target language with job language provided from constructor
                     $tag .= "$k=\"$this->targetLang\" ";
                 } else {
@@ -74,20 +74,20 @@ 
 
             $seg = $this->getCurrentSegment();
 
-            if ( $name === $this->tuTagName && !empty( $seg ) && isset( $seg[ 'sid' ] ) ) {
+            if ($name === $this->tuTagName && !empty($seg) && isset($seg['sid'])) {
 
                 // add `help-id` to xliff v.1*
-                if ( strpos( $tag, 'help-id' ) === false ) {
-                    if ( !empty( $seg[ 'sid' ] ) ) {
-                        $tag .= "help-id=\"{$seg[ 'sid' ]}\" ";
+                if (strpos($tag, 'help-id') === false) {
+                    if (!empty($seg['sid'])) {
+                        $tag .= "help-id=\"{$seg['sid']}\" ";
                     }
                 }
 
             }
 
-            $tag = $this->handleOpenXliffTag( $name, $attr, $tag );
+            $tag = $this->handleOpenXliffTag($name, $attr, $tag);
 
-            $this->checkForSelfClosedTagAndFlush( $parser, $tag );
+            $this->checkForSelfClosedTagAndFlush($parser, $tag);
 
         }
 
@@ -97,7 +97,7 @@ 
     /**
      * @inheritDoc
      */
-    protected function tagClose( $parser, string $name ) {
+    protected function tagClose($parser, string $name) {
         $tag = '';
 
         /**
@@ -106,23 +106,23 @@ 
          *
          * self::tagOpen method
          */
-        if ( !$this->isEmpty ) {
+        if (!$this->isEmpty) {
 
             // write closing tag if is not a target
             // EXCLUDE the target nodes with currentTransUnitIsTranslatable = 'NO'
-            if ( !$this->inTarget and $this->currentTransUnitIsTranslatable !== 'no' ) {
+            if (!$this->inTarget and $this->currentTransUnitIsTranslatable !== 'no') {
                 $tag = "</$name>";
             }
 
-            if ( 'target' == $name && !$this->inAltTrans ) {
+            if ('target' == $name && !$this->inAltTrans) {
 
-                if ( isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
+                if (isset($this->transUnits[$this->currentTransUnitId])) {
 
                     // get translation of current segment, by indirect indexing: id -> positional index -> segment
                     // actually there may be more than one segment to that ID if there are two mrk of the same source segment
                     $tag = $this->rebuildTarget();
 
-                } elseif( !empty($this->CDATABuffer) and $this->currentTransUnitIsTranslatable === 'no' ) {
+                } elseif (!empty($this->CDATABuffer) and $this->currentTransUnitIsTranslatable === 'no') {
 
                     // These are target nodes with currentTransUnitIsTranslatable = 'NO'
                     $this->bufferIsActive = false;
@@ -133,45 +133,45 @@ 
                 $this->targetWasWritten = true;
                 // signal we are leaving a target
                 $this->inTarget = false;
-                $this->postProcAndFlush( $this->outputFP, $tag, true );
+                $this->postProcAndFlush($this->outputFP, $tag, true);
 
-            } elseif ( in_array( $name, $this->nodesToBuffer ) ) { // we are closing a critical CDATA section
+            } elseif (in_array($name, $this->nodesToBuffer)) { // we are closing a critical CDATA section
 
                 $this->bufferIsActive = false;
                 $tag                  = $this->CDATABuffer . "</$name>";
                 $this->CDATABuffer    = "";
 
                 //flush to the pointer
-                $this->postProcAndFlush( $this->outputFP, $tag );
+                $this->postProcAndFlush($this->outputFP, $tag);
 
-            } elseif ( $name === $this->tuTagName ) {
+            } elseif ($name === $this->tuTagName) {
 
                 $tag = "";
 
                 // handling </trans-unit> closure
-                if ( !$this->targetWasWritten ) {
+                if (!$this->targetWasWritten) {
 
-                    if ( isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
+                    if (isset($this->transUnits[$this->currentTransUnitId])) {
                         $tag = $this->rebuildTarget();
                     } else {
-                        $tag = $this->createTargetTag( "", "" );
+                        $tag = $this->createTargetTag("", "");
                     }
 
                 }
 
-                $tag                    .= "</$this->tuTagName>";
+                $tag .= "</$this->tuTagName>";
                 $this->targetWasWritten = false;
-                $this->postProcAndFlush( $this->outputFP, $tag );
+                $this->postProcAndFlush($this->outputFP, $tag);
 
-            } elseif ( $this->bufferIsActive ) { // this is a tag ( <g | <mrk ) inside a seg or seg-source tag
+            } elseif ($this->bufferIsActive) { // this is a tag ( <g | <mrk ) inside a seg or seg-source tag
                 $this->CDATABuffer .= "</$name>";
                 // Do NOT Flush
             } else { //generic tag closure do Nothing
                 // flush to pointer
-                $this->postProcAndFlush( $this->outputFP, $tag );
+                $this->postProcAndFlush($this->outputFP, $tag);
             }
 
-        } elseif ( in_array( $name, $this->nodesToBuffer ) ) {
+        } elseif (in_array($name, $this->nodesToBuffer)) {
 
             $this->isEmpty        = false;
             $this->bufferIsActive = false;
@@ -179,7 +179,7 @@ 
             $this->CDATABuffer    = "";
 
             //flush to the pointer
-            $this->postProcAndFlush( $this->outputFP, $tag );
+            $this->postProcAndFlush($this->outputFP, $tag);
 
         } else {
             //ok, nothing to be done; reset flag for next coming tag
@@ -187,10 +187,10 @@ 
         }
 
         // try to signal that we are leaving a target
-        $this->tryUnsetAltTrans( $name );
+        $this->tryUnsetAltTrans($name);
 
         // check if we are leaving a <trans-unit> (xliff v1.*) or <unit> (xliff v2.*)
-        if ( $this->tuTagName === $name ) {
+        if ($this->tuTagName === $name) {
             $this->currentTransUnitIsTranslatable = null;
             $this->inTU                           = false;
             $this->hasWrittenCounts               = false;
@@ -207,31 +207,31 @@ 
      *
      * @return string
      */
-    protected function prepareTranslation( array $seg, string $transUnitTranslation = "" ): string {
+    protected function prepareTranslation(array $seg, string $transUnitTranslation = ""): string {
 
-        $segment     = Strings::removeDangerousChars( $seg [ 'segment' ] );
-        $translation = Strings::removeDangerousChars( $seg [ 'translation' ] );
+        $segment     = Strings::removeDangerousChars($seg ['segment']);
+        $translation = Strings::removeDangerousChars($seg ['translation']);
 
-        if ( $seg [ 'translation' ] == '' ) {
+        if ($seg ['translation'] == '') {
             $translation = $segment;
         } else {
-            if ( $this->callback instanceof XliffReplacerCallbackInterface ) {
-                $error = ( !empty( $seg[ 'error' ] ) ) ? $seg[ 'error' ] : null;
-                if ( $this->callback->thereAreErrors( $seg[ 'sid' ], $segment, $translation, [], $error ) ) {
+            if ($this->callback instanceof XliffReplacerCallbackInterface) {
+                $error = (!empty($seg['error'])) ? $seg['error'] : null;
+                if ($this->callback->thereAreErrors($seg['sid'], $segment, $translation, [], $error)) {
                     $translation = '|||UNTRANSLATED_CONTENT_START|||' . $segment . '|||UNTRANSLATED_CONTENT_END|||';
                 }
             }
         }
 
-        $transUnitTranslation .= $seg[ 'prev_tags' ] . $this->rebuildMarks( $seg, $translation ) . ltrim( $seg[ 'succ_tags' ] );
+        $transUnitTranslation .= $seg['prev_tags'] . $this->rebuildMarks($seg, $translation) . ltrim($seg['succ_tags']);
 
         return $transUnitTranslation;
     }
 
-    protected function rebuildMarks( array $seg, string $translation ): string {
+    protected function rebuildMarks(array $seg, string $translation): string {
 
-        if ( $seg[ 'mrk_id' ] !== null && $seg[ 'mrk_id' ] != '' ) {
-            $translation = "<mrk mid=\"" . $seg[ 'mrk_id' ] . "\" mtype=\"seg\">" . $seg[ 'mrk_prev_tags' ] . $translation . $seg[ 'mrk_succ_tags' ] . "</mrk>";
+        if ($seg['mrk_id'] !== null && $seg['mrk_id'] != '') {
+            $translation = "<mrk mid=\"" . $seg['mrk_id'] . "\" mtype=\"seg\">" . $seg['mrk_prev_tags'] . $translation . $seg['mrk_succ_tags'] . "</mrk>";
         }
 
         return $translation;
@@ -246,10 +246,10 @@ 
      *
      * @return string
      */
-    protected function createTargetTag( string $translation, string $stateProp ): string {
+    protected function createTargetTag(string $translation, string $stateProp): string {
         $targetLang = ' xml:lang="' . $this->targetLang . '"';
         $tag        = "<target $targetLang $stateProp>$translation</target>";
-        $tag        .= "\n<count-group name=\"$this->currentTransUnitId\"><count count-type=\"x-matecat-raw\">" . $this->counts[ 'raw_word_count' ] . "</count><count count-type=\"x-matecat-weighted\">" . $this->counts[ 'eq_word_count' ] . '</count></count-group>';
+        $tag .= "\n<count-group name=\"$this->currentTransUnitId\"><count count-type=\"x-matecat-raw\">" . $this->counts['raw_word_count'] . "</count><count count-type=\"x-matecat-weighted\">" . $this->counts['eq_word_count'] . '</count></count-group>';
 
         return $tag;
 
@@ -265,7 +265,7 @@ 
         // we must reset the lastMrkId found because this is a new segment.
         $lastMrkId = -1;
 
-        foreach ( $this->lastTransUnit as $pos => $seg ) {
+        foreach ($this->lastTransUnit as $pos => $seg) {
 
             /*
              * This routine works to respect the positional orders of markers.
@@ -278,8 +278,8 @@ 
              * pre-assign zero to the new mrk if this is the first one ( in this segment )
              * If it is null leave it NULL
              */
-            if ( (int)$seg[ "mrk_id" ] < 0 && $seg[ "mrk_id" ] !== null ) {
-                $seg[ "mrk_id" ] = 0;
+            if ((int)$seg["mrk_id"] < 0 && $seg["mrk_id"] !== null) {
+                $seg["mrk_id"] = 0;
             }
 
             /*
@@ -288,39 +288,39 @@ 
              * ( null <= -1 ) === true
              * so, cast to int
              */
-            if ( (int)$seg[ "mrk_id" ] <= $lastMrkId ) {
+            if ((int)$seg["mrk_id"] <= $lastMrkId) {
                 break;
             }
 
             // update counts
-            if ( !empty( $seg ) ) {
-                $this->updateSegmentCounts( $seg );
+            if (!empty($seg)) {
+                $this->updateSegmentCounts($seg);
             }
 
             // delete translations so the prepareSegment
             // will put source content in target tag
-            if ( $this->sourceInTarget ) {
-                $seg[ 'translation' ] = '';
+            if ($this->sourceInTarget) {
+                $seg['translation'] = '';
                 $this->resetCounts();
             }
 
             // append $translation
-            $translation = $this->prepareTranslation( $seg, $translation );
+            $translation = $this->prepareTranslation($seg, $translation);
 
-            $lastMrkId = $seg[ "mrk_id" ];
+            $lastMrkId = $seg["mrk_id"];
 
-            [ $stateProp, $lastMrkState ] = StatusToStateAttribute::getState( $this->xliffVersion, $seg[ 'status' ], $lastMrkState );
+            [$stateProp, $lastMrkState] = StatusToStateAttribute::getState($this->xliffVersion, $seg['status'], $lastMrkState);
 
         }
 
         //append translation
-        return $this->createTargetTag( $translation, $stateProp );
+        return $this->createTargetTag($translation, $stateProp);
 
     }
 
     protected function getCurrentSegment(): array {
-        if ( $this->currentTransUnitIsTranslatable !== 'no' && isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
-            return $this->segments[ $this->transUnits[ $this->currentTransUnitId ][ 0 ] ]; // TODO try to understand why here is needed to override the method and set 0 index hardcoded
+        if ($this->currentTransUnitIsTranslatable !== 'no' && isset($this->transUnits[$this->currentTransUnitId])) {
+            return $this->segments[$this->transUnits[$this->currentTransUnitId][0]]; // TODO try to understand why here is needed to override the method and set 0 index hardcoded
         }
 
         return [];

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');
     }
 }

src/Utils/Strings.php

Spacing +55 added lines, -55 removed lines

@@ -17,8 +17,8 @@ 
      * @return string
      * @throws Exception
      */
-    public static function cleanCDATA( string $testString ): string {
-        $cleanXMLContent = new SimpleXMLElement( '<rootNoteNode>' . $testString . '</rootNoteNode>', LIBXML_NOCDATA );
+    public static function cleanCDATA(string $testString): string {
+        $cleanXMLContent = new SimpleXMLElement('<rootNoteNode>' . $testString . '</rootNoteNode>', LIBXML_NOCDATA);
 
         return $cleanXMLContent->__toString();
     }
@@ -28,28 +28,28 @@ 
      *
      * @return bool
      */
-    public static function isJSON( string $string ): bool {
-        if ( is_numeric( $string ) ) {
+    public static function isJSON(string $string): bool {
+        if (is_numeric($string)) {
             return false;
         }
 
         try {
-            $string = Strings::cleanCDATA( $string );
-        } catch ( Exception $e ) {
+            $string = Strings::cleanCDATA($string);
+        } catch (Exception $e) {
             return false;
         }
 
-        $string = trim( $string );
-        if ( empty( $string ) ) {
+        $string = trim($string);
+        if (empty($string)) {
             return false;
         }
 
         // String representation in json is "quoted", but we want to accept only object or arrays.
         // exclude strings and numbers and other primitive types
-        if ( in_array( $string [ 0 ], [ "{", "[" ] ) ) {
-            json_decode( $string );
+        if (in_array($string [0], ["{", "["])) {
+            json_decode($string);
 
-            return empty( self::getLastJsonError()[ 0 ] );
+            return empty(self::getLastJsonError()[0]);
         } else {
             return false; // Not accepted: string or primitive types.
         }
@@ -61,10 +61,10 @@ 
      *
      * @return array
      */
-    public static function jsonToArray( string $string ): array {
-        $decodedJSON = json_decode( $string, true );
+    public static function jsonToArray(string $string): array {
+        $decodedJSON = json_decode($string, true);
 
-        return ( is_array( $decodedJSON ) ) ? $decodedJSON : [];
+        return (is_array($decodedJSON)) ? $decodedJSON : [];
     }
 
     /**
@@ -73,10 +73,10 @@ 
      */
     private static function raiseLastJsonException() {
 
-        [ $msg, $error ] = self::getLastJsonError();
+        [$msg, $error] = self::getLastJsonError();
 
-        if ( $error != JSON_ERROR_NONE ) {
-            throw new NotValidJSONException( $msg, $error );
+        if ($error != JSON_ERROR_NONE) {
+            throw new NotValidJSONException($msg, $error);
         }
 
     }
@@ -86,11 +86,11 @@ 
      */
     private static function getLastJsonError(): array {
 
-        if ( function_exists( "json_last_error" ) ) {
+        if (function_exists("json_last_error")) {
 
             $error = json_last_error();
 
-            switch ( $error ) {
+            switch ($error) {
                 case JSON_ERROR_NONE:
                     $msg = null; # - No errors
                     break;
@@ -114,10 +114,10 @@ 
                     break;
             }
 
-            return [ $msg, $error ];
+            return [$msg, $error];
         }
 
-        return [ null, JSON_ERROR_NONE ];
+        return [null, JSON_ERROR_NONE];
 
     }
 
@@ -140,11 +140,11 @@ 
      *
      * @return string
      */
-    public static function fixNonWellFormedXml( string $content, ?bool $escapeStrings = true ): string {
-        if ( self::$find_xliff_tags_reg === null ) {
+    public static function fixNonWellFormedXml(string $content, ?bool $escapeStrings = true): string {
+        if (self::$find_xliff_tags_reg === null) {
             // Convert the list of tags in a regexp list, for example "g|x|bx|ex"
             $xliffTags           = XliffTags::$tags;
-            $xliff_tags_reg_list = implode( '|', $xliffTags );
+            $xliff_tags_reg_list = implode('|', $xliffTags);
             // Regexp to find all the XLIFF tags:
             //   </?               -> matches the tag start, for both opening and
             //                        closure tags (see the optional slash)
@@ -165,30 +165,30 @@ 
         }
 
         // Find all the XLIFF tags
-        preg_match_all( self::$find_xliff_tags_reg, $content, $matches );
-        $tags = (array)$matches[ 0 ];
+        preg_match_all(self::$find_xliff_tags_reg, $content, $matches);
+        $tags = (array)$matches[0];
 
         // Prepare placeholders
         $tags_placeholders = [];
-        $tagsNum           = count( $tags );
-        for ( $i = 0; $i < $tagsNum; $i++ ) {
-            $tag                       = $tags[ $i ];
-            $tags_placeholders[ $tag ] = "#@!XLIFF-TAG-$i!@#";
+        $tagsNum           = count($tags);
+        for ($i = 0; $i < $tagsNum; $i++) {
+            $tag                       = $tags[$i];
+            $tags_placeholders[$tag] = "#@!XLIFF-TAG-$i!@#";
         }
 
         // Replace all XLIFF tags with placeholders that will not be escaped
-        foreach ( $tags_placeholders as $tag => $placeholder ) {
-            $content = str_replace( $tag, $placeholder, $content );
+        foreach ($tags_placeholders as $tag => $placeholder) {
+            $content = str_replace($tag, $placeholder, $content);
         }
 
         // Escape the string with the remaining non-XLIFF tags
-        if ( $escapeStrings ) {
-            $content = htmlspecialchars( $content, ENT_NOQUOTES, 'UTF-8', false );
+        if ($escapeStrings) {
+            $content = htmlspecialchars($content, ENT_NOQUOTES, 'UTF-8', false);
         }
 
         // Put again in place the original XLIFF tags replacing placeholders
-        foreach ( $tags_placeholders as $tag => $placeholder ) {
-            $content = str_replace( $placeholder, $tag, $content );
+        foreach ($tags_placeholders as $tag => $placeholder) {
+            $content = str_replace($placeholder, $tag, $content);
         }
 
         return $content;
@@ -199,17 +199,17 @@ 
      *
      * @return string
      */
-    public static function removeDangerousChars( $string ): string {
+    public static function removeDangerousChars($string): string {
         // clean invalid xml entities ( characters with ascii < 32 and different from 0A, 0D and 09
         $regexpEntity = '/&#x(0[0-8BCEF]|1[\dA-F]|7F);/u';
 
         // remove binary chars in some xliff files
         $regexpAscii = '/[\x{00}-\x{08}\x{0B}\x{0C}\x{0E}-\x{1F}\x{7F}]/u';
 
-        $string = preg_replace( $regexpAscii, '', $string ?? '' );
-        $string = preg_replace( $regexpEntity, '', $string ?? '' );
+        $string = preg_replace($regexpAscii, '', $string ?? '');
+        $string = preg_replace($regexpEntity, '', $string ?? '');
 
-        return !empty( $string ) || strlen( $string ) > 0 ? $string : "";
+        return !empty($string) || strlen($string) > 0 ? $string : "";
     }
 
 
@@ -219,15 +219,15 @@ 
      *
      * @return string
      */
-    public static function htmlspecialchars_decode( string $string, ?bool $onlyEscapedEntities = false ): string {
-        if ( false === $onlyEscapedEntities ) {
-            return htmlspecialchars_decode( $string, ENT_NOQUOTES );
+    public static function htmlspecialchars_decode(string $string, ?bool $onlyEscapedEntities = false): string {
+        if (false === $onlyEscapedEntities) {
+            return htmlspecialchars_decode($string, ENT_NOQUOTES);
         }
 
-        return preg_replace_callback( self::$htmlEntityRegex,
-                function ( $match ) {
-                    return self::htmlspecialchars_decode( $match[ 0 ] );
-                }, $string );
+        return preg_replace_callback(self::$htmlEntityRegex,
+                function($match) {
+                    return self::htmlspecialchars_decode($match[0]);
+                }, $string);
     }
 
     /**
@@ -242,8 +242,8 @@ 
      *
      * @return bool
      */
-    public static function isADoubleEscapedEntity( string $str ): bool {
-        return preg_match( self::$htmlEntityRegex, $str ) != 0;
+    public static function isADoubleEscapedEntity(string $str): bool {
+        return preg_match(self::$htmlEntityRegex, $str) != 0;
     }
 
     /**
@@ -251,8 +251,8 @@ 
      *
      * @return bool
      */
-    public static function isAValidUuid( $uuid ) {
-        return preg_match( '/^[\da-f]{8}-[\da-f]{4}-4[\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}$/', $uuid ) === 1;
+    public static function isAValidUuid($uuid) {
+        return preg_match('/^[\da-f]{8}-[\da-f]{4}-4[\da-f]{3}-[89ab][\da-f]{3}-[\da-f]{12}$/', $uuid) === 1;
     }
 
     /**
@@ -261,8 +261,8 @@ 
      *
      * @return array|false|string[]
      */
-    public static function preg_split( $pattern, $subject ) {
-        return preg_split( $pattern, $subject, -1, PREG_SPLIT_NO_EMPTY );
+    public static function preg_split($pattern, $subject) {
+        return preg_split($pattern, $subject, -1, PREG_SPLIT_NO_EMPTY);
     }
 
     /**
@@ -270,8 +270,8 @@ 
      *
      * @return int
      */
-    public static function getTheNumberOfTrailingSpaces( $segment ): int {
-        return mb_strlen( $segment ) - mb_strlen( rtrim( $segment, ' ' ) );
+    public static function getTheNumberOfTrailingSpaces($segment): int {
+        return mb_strlen($segment) - mb_strlen(rtrim($segment, ' '));
     }
 
 }