matecat / xliff-parser

src/XliffReplacer/Xliff12.php

Spacing +55 added lines, -55 removed lines

@@ -27,28 +27,28 @@ 
     /**
      * @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->checkSetInTarget( $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 {
@@ -59,20 +59,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);
 
         }
 
@@ -82,7 +82,7 @@ 
     /**
      * @inheritDoc
      */
-    protected function tagClose( $parser, string $name ) {
+    protected function tagClose($parser, string $name) {
         $tag = '';
 
         /**
@@ -91,15 +91,15 @@ 
          *
          * self::tagOpen method
          */
-        if ( !$this->isEmpty ) {
+        if (!$this->isEmpty) {
 
-            if ( !$this->inTarget ) {
+            if (!$this->inTarget) {
                 $tag = "</$name>";
             }
 
-            if ( 'target' == $name ) {
+            if ('target' == $name) {
 
-                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
@@ -110,42 +110,42 @@ 
                 $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);
             }
 
         } else {
@@ -154,7 +154,7 @@ 
         }
 
         // 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;
@@ -171,31 +171,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;
@@ -210,10 +210,10 @@ 
      *
      * @return string
      */
-    private function createTargetTag( string $translation, string $stateProp ): string {
+    private 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;
 
@@ -229,7 +229,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.
@@ -242,8 +242,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;
             }
 
             /*
@@ -252,33 +252,33 @@ 
              * ( 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);
 
     }
 

src/XliffReplacer/Xliff20.php

Spacing +62 added lines, -62 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * @var bool
      */
-    protected bool $unitContainsMda = false;   // check if <unit> already contains a <mda:metadata> (forXliff v 2.*)
+    protected bool $unitContainsMda = false; // check if <unit> already contains a <mda:metadata> (forXliff v 2.*)
     /**
      * @var array
      */
@@ -35,22 +35,22 @@ 
     /**
      * @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);
 
-        if ( 'mda:metadata' === $name ) {
+        if ('mda:metadata' === $name) {
             $this->unitContainsMda = true;
         }
 
-        $this->checkSetInTarget( $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 = '';
 
@@ -72,48 +72,48 @@ 
             //
             // http://docs.oasis-open.org/xliff/xliff-core/v2.0/os/xliff-core-v2.0-os.html#unit
             //
-            if ( in_array( $name, [ 'notes', 'originalData', 'segment', 'ignorable' ] ) &&
+            if (in_array($name, ['notes', 'originalData', 'segment', 'ignorable']) &&
                     $this->unitContainsMda === false &&
-                    !empty( $this->transUnits[ $this->currentTransUnitId ] ) &&
+                    !empty($this->transUnits[$this->currentTransUnitId]) &&
                     !$this->hasWrittenCounts
             ) {
                 // we need to update counts here
                 $this->updateCounts();
                 $this->hasWrittenCounts = true;
-                $tag                    .= $this->getWordCountGroupForXliffV2();
+                $tag .= $this->getWordCountGroupForXliffV2();
                 $this->unitContainsMda  = true;
             }
 
             // construct tag
             $tag .= "<$name ";
 
-            foreach ( $attr as $k => $v ) {
+            foreach ($attr as $k => $v) {
                 //normal tag flux, put attributes in it but skip for translation state and set the right value for the attribute
-                if ( $k != 'state' ) {
+                if ($k != 'state') {
                     $tag .= "$k=\"$v\" ";
                 }
             }
 
             $seg = $this->getCurrentSegment();
 
-            if ( $name === $this->tuTagName && !empty( $seg ) && isset( $seg[ 'sid' ] ) ) {
+            if ($name === $this->tuTagName && !empty($seg) && isset($seg['sid'])) {
 
                 // add `mtc:segment-id` to xliff v.2*
-                if ( strpos( $tag, 'mtc:segment-id' ) === false ) {
-                    $tag .= "mtc:segment-id=\"{$seg[ 'sid' ]}\" ";
+                if (strpos($tag, 'mtc:segment-id') === false) {
+                    $tag .= "mtc:segment-id=\"{$seg['sid']}\" ";
                 }
 
             }
 
             // replace state for xliff v2
-            if ( 'segment' === $name ) { // add state to segment in Xliff v2
-                [ $stateProp, ] = StatusToStateAttribute::getState( $this->xliffVersion, $seg[ 'status' ] );
+            if ('segment' === $name) { // add state to segment in Xliff v2
+                [$stateProp, ] = StatusToStateAttribute::getState($this->xliffVersion, $seg['status']);
                 $tag .= $stateProp;
             }
 
-            $tag = $this->handleOpenXliffTag( $name, $attr, $tag );
+            $tag = $this->handleOpenXliffTag($name, $attr, $tag);
 
-            $this->checkForSelfClosedTagAndFlush( $parser, $tag );
+            $this->checkForSelfClosedTagAndFlush($parser, $tag);
 
         }
 
@@ -126,10 +126,10 @@ 
      *
      * @return string
      */
-    protected function handleOpenXliffTag( string $name, array $attr, string $tag ): string {
-        $tag = parent::handleOpenXliffTag( $name, $attr, $tag );
+    protected function handleOpenXliffTag(string $name, array $attr, string $tag): string {
+        $tag = parent::handleOpenXliffTag($name, $attr, $tag);
         // add oasis xliff 20 namespace
-        if ( $name === 'xliff' && !array_key_exists( 'xmlns:mda', $attr ) ) {
+        if ($name === 'xliff' && !array_key_exists('xmlns:mda', $attr)) {
             $tag .= 'xmlns:mda="urn:oasis:names:tc:xliff:metadata:2.0"';
         }
 
@@ -139,7 +139,7 @@ 
     /**
      * @inheritDoc
      */
-    protected function tagClose( $parser, string $name ) {
+    protected function tagClose($parser, string $name) {
         $tag = '';
 
         /**
@@ -148,32 +148,32 @@ 
          *
          * self::tagOpen method
          */
-        if ( !$this->isEmpty ) {
+        if (!$this->isEmpty) {
 
-            if ( !$this->inTarget ) {
+            if (!$this->inTarget) {
                 $tag = "</$name>";
             }
 
-            if ( 'target' == $name ) {
+            if ('target' == $name) {
 
-                if ( isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
+                if (isset($this->transUnits[$this->currentTransUnitId])) {
 
                     $seg = $this->getCurrentSegment();
 
                     // update counts
-                    if ( !$this->hasWrittenCounts && !empty( $seg ) ) {
-                        $this->updateSegmentCounts( $seg );
+                    if (!$this->hasWrittenCounts && !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 = $this->prepareTranslation($seg);
 
                     //append translation
                     $tag = "<target>$translation</target>";
@@ -183,22 +183,22 @@ 
                 // signal we are leaving a target
                 $this->targetWasWritten = true;
                 $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;
 
                 // only for Xliff 2.*
                 // write here <mda:metaGroup> and <mda:meta> if already present in the <unit>
-                if ( 'mda:metadata' === $name && $this->unitContainsMda && !$this->hasWrittenCounts ) {
+                if ('mda:metadata' === $name && $this->unitContainsMda && !$this->hasWrittenCounts) {
 
                     // we need to update counts here
                     $this->updateCounts();
                     $this->hasWrittenCounts = true;
 
                     $tag = $this->CDATABuffer;
-                    $tag .= $this->getWordCountGroupForXliffV2( false );
+                    $tag .= $this->getWordCountGroupForXliffV2(false);
                     $tag .= "    </mda:metadata>";
 
                 } else {
@@ -208,19 +208,19 @@ 
                 $this->CDATABuffer = "";
 
                 //flush to the pointer
-                $this->postProcAndFlush( $this->outputFP, $tag );
+                $this->postProcAndFlush($this->outputFP, $tag);
 
-            } elseif ( 'segment' === $name ) {
+            } elseif ('segment' === $name) {
 
                 // only for Xliff 2.*
                 // if segment has no <target> add it BEFORE </segment>
-                if ( !$this->targetWasWritten ) {
+                if (!$this->targetWasWritten) {
 
                     $seg = $this->getCurrentSegment();
 
-                    if ( isset( $seg[ 'translation' ] ) ) {
+                    if (isset($seg['translation'])) {
 
-                        $translation = $this->prepareTranslation( $seg );
+                        $translation = $this->prepareTranslation($seg);
                         // replace the tag
                         $tag = "<target>$translation</target>";
 
@@ -233,17 +233,17 @@ 
                 // update segmentPositionInTu
                 $this->segmentInUnitPosition++;
 
-                $this->postProcAndFlush( $this->outputFP, $tag );
+                $this->postProcAndFlush($this->outputFP, $tag);
 
                 // we are leaving <segment>, reset $segmentHasTarget
                 $this->targetWasWritten = false;
 
-            } 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);
             }
         } else {
             //ok, nothing to be done; reset flag for next coming tag
@@ -251,7 +251,7 @@ 
         }
 
         // 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->unitContainsMda                = false;
@@ -267,8 +267,8 @@ 
     private function updateCounts() {
 
         $seg = $this->getCurrentSegment();
-        if ( !empty( $seg ) ) {
-            $this->updateSegmentCounts( $seg );
+        if (!empty($seg)) {
+            $this->updateSegmentCounts($seg);
         }
 
     }
@@ -278,30 +278,30 @@ 
      *
      * @return string
      */
-    private function getWordCountGroupForXliffV2( bool $withMetadataTag = true ): string {
+    private function getWordCountGroupForXliffV2(bool $withMetadataTag = true): string {
 
         $this->mdaGroupCounter++;
-        $segments_count_array = $this->counts[ 'segments_count_array' ];
+        $segments_count_array = $this->counts['segments_count_array'];
 
         $tag = '';
 
-        if ( $withMetadataTag === true ) {
+        if ($withMetadataTag === true) {
             $tag .= '<mda:metadata>';
         }
 
         $index = 0;
-        foreach ( $segments_count_array as $segments_count_item ) {
+        foreach ($segments_count_array as $segments_count_item) {
 
             $id = 'word_count_tu[' . $this->currentTransUnitId . '][' . $index . ']';
             $index++;
 
             $tag .= "    <mda:metaGroup id=\"" . $id . "\" category=\"row_xml_attribute\">
-                                <mda:meta type=\"x-matecat-raw\">" . $segments_count_item[ 'raw_word_count' ] . "</mda:meta>
-                                <mda:meta type=\"x-matecat-weighted\">" . $segments_count_item[ 'eq_word_count' ] . "</mda:meta>
+                                <mda:meta type=\"x-matecat-raw\">" . $segments_count_item['raw_word_count'] . "</mda:meta>
+                                <mda:meta type=\"x-matecat-weighted\">" . $segments_count_item['eq_word_count'] . "</mda:meta>
                             </mda:metaGroup>";
         }
 
-        if ( $withMetadataTag === true ) {
+        if ($withMetadataTag === true) {
             $tag .= '</mda:metadata>';
         }
 
@@ -316,18 +316,18 @@ 
      *
      * @return string
      */
-    protected function prepareTranslation( array $seg ): string {
+    protected function prepareTranslation(array $seg): string {
 
-        $segment     = Strings::removeDangerousChars( $seg [ 'segment' ] );
-        $translation = Strings::removeDangerousChars( $seg [ 'translation' ] );
-        $dataRefMap  = ( isset( $seg[ 'data_ref_map' ] ) ) ? Strings::jsonToArray( $seg[ 'data_ref_map' ] ) : [];
+        $segment     = Strings::removeDangerousChars($seg ['segment']);
+        $translation = Strings::removeDangerousChars($seg ['translation']);
+        $dataRefMap  = (isset($seg['data_ref_map'])) ? Strings::jsonToArray($seg['data_ref_map']) : [];
 
-        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, $dataRefMap, $error ) ) {
+            if ($this->callback instanceof XliffReplacerCallbackInterface) {
+                $error = (!empty($seg['error'])) ? $seg['error'] : null;
+                if ($this->callback->thereAreErrors($seg['sid'], $segment, $translation, $dataRefMap, $error)) {
                     $translation = '|||UNTRANSLATED_CONTENT_START|||' . $segment . '|||UNTRANSLATED_CONTENT_END|||';
                 }
             }

src/XliffReplacer/AbstractXliffReplacer.php

Spacing +112 added lines, -112 removed lines

@@ -7,26 +7,26 @@ 
 
 abstract class AbstractXliffReplacer {
     protected $originalFP;
-    protected $outputFP;                  // output stream pointer
+    protected $outputFP; // output stream pointer
 
-    protected string $tuTagName;                 // <trans-unit> (forXliff v 1.*) or <unit> (forXliff v 2.*)
-    protected bool   $inTU             = false;  // flag to check whether we are in a <trans-unit>
-    protected bool   $inTarget         = false;  // flag to check whether we are in a <target>, to ignore everything
-    protected bool   $isEmpty          = false;  // flag to check whether we are in an empty tag (<tag/>)
-    protected bool   $targetWasWritten = false;  // flag to check is <target> was written in the current unit
-    protected string $CDATABuffer      = "";       // buffer for special tag
-    protected bool   $bufferIsActive   = false;    // buffer for special tag
+    protected string $tuTagName; // <trans-unit> (forXliff v 1.*) or <unit> (forXliff v 2.*)
+    protected bool   $inTU             = false; // flag to check whether we are in a <trans-unit>
+    protected bool   $inTarget         = false; // flag to check whether we are in a <target>, to ignore everything
+    protected bool   $isEmpty          = false; // flag to check whether we are in an empty tag (<tag/>)
+    protected bool   $targetWasWritten = false; // flag to check is <target> was written in the current unit
+    protected string $CDATABuffer      = ""; // buffer for special tag
+    protected bool   $bufferIsActive   = false; // buffer for special tag
 
-    protected int $offset = 0;         // offset for SAX pointer
+    protected int $offset = 0; // offset for SAX pointer
 
-    protected string  $currentBuffer;             // the current piece of text it's been parsed
-    protected int     $len;                       // length of the currentBuffer
-    protected array   $segments;                  // array of translations
+    protected string  $currentBuffer; // the current piece of text it's been parsed
+    protected int     $len; // length of the currentBuffer
+    protected array   $segments; // array of translations
     protected array   $lastTransUnit                  = [];
     protected int     $segmentInUnitPosition          = 0;
-    protected ?string $currentTransUnitId             = null;        // id of current <trans-unit>
+    protected ?string $currentTransUnitId             = null; // id of current <trans-unit>
     protected ?string $currentTransUnitIsTranslatable = null; // 'translate' attribute of current <trans-unit>
-    protected bool    $hasWrittenCounts               = false;  // check if <unit> already wrote segment counts (forXliff v 2.*)
+    protected bool    $hasWrittenCounts               = false; // check if <unit> already wrote segment counts (forXliff v 2.*)
     protected string  $targetLang;
     protected bool    $sourceInTarget                 = false;
 
@@ -76,10 +76,10 @@ 
             XliffReplacerCallbackInterface $callback = null
     ) {
         self::$INTERNAL_TAG_PLACEHOLDER = $this->getInternalTagPlaceholder();
-        $this->createOutputFileIfDoesNotExist( $outputFilePath );
-        $this->setFileDescriptors( $originalXliffPath, $outputFilePath );
+        $this->createOutputFileIfDoesNotExist($outputFilePath);
+        $this->setFileDescriptors($originalXliffPath, $outputFilePath);
         $this->xliffVersion   = $xliffVersion;
-        $this->tuTagName      = ( $this->xliffVersion === 2 ) ? 'unit' : 'trans-unit';
+        $this->tuTagName      = ($this->xliffVersion === 2) ? 'unit' : 'trans-unit';
         $this->segments       = $segments;
         $this->targetLang     = $trgLang;
         $this->sourceInTarget = $setSourceInTarget;
@@ -89,17 +89,17 @@ 
     }
 
     public function replaceTranslation() {
-        fwrite( $this->outputFP, '<?xml version="1.0" encoding="UTF-8"?>' );
+        fwrite($this->outputFP, '<?xml version="1.0" encoding="UTF-8"?>');
 
         //create Sax parser
         $xmlParser = $this->initSaxParser();
 
-        while ( $this->currentBuffer = fread( $this->originalFP, 4096 ) ) {
+        while ($this->currentBuffer = fread($this->originalFP, 4096)) {
             /*
                preprocess file
              */
             // obfuscate entities because sax automatically does html_entity_decode
-            $temporary_check_buffer = preg_replace( "/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer );
+            $temporary_check_buffer = preg_replace("/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer);
 
             //avoid cutting entities in half:
             //the last fread could have truncated an entity (say, '&lt;' in '&l'), thus invalidating the escaping
@@ -107,27 +107,27 @@ 
             // 9 is the max length of an entity. So, suppose that the & is at the end of buffer,
             // add 9 Bytes and substitute the entities, if the & is present, and it is not at the end
             //it can't be an entity, exit the loop
-            while ( true ) {
-                $_ampPos = strpos( $temporary_check_buffer, '&' );
+            while (true) {
+                $_ampPos = strpos($temporary_check_buffer, '&');
 
                 //check for real entity or escape it to safely exit from the loop!!!
-                if ( $_ampPos === false || strlen( substr( $temporary_check_buffer, $_ampPos ) ) > 9 ) {
+                if ($_ampPos === false || strlen(substr($temporary_check_buffer, $_ampPos)) > 9) {
                     break;
                 }
 
                 //if an entity is still present, fetch some more and repeat the escaping
-                $this->currentBuffer    .= fread( $this->originalFP, 9 );
-                $temporary_check_buffer = preg_replace( "/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer );
+                $this->currentBuffer .= fread($this->originalFP, 9);
+                $temporary_check_buffer = preg_replace("/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer);
             }
 
             //free stuff outside the loop
-            unset( $temporary_check_buffer );
+            unset($temporary_check_buffer);
 
-            $this->currentBuffer = preg_replace( "/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer );
-            $this->currentBuffer = str_replace( "&", self::$INTERNAL_TAG_PLACEHOLDER . 'amp' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer );
+            $this->currentBuffer = preg_replace("/&(.*?);/", self::$INTERNAL_TAG_PLACEHOLDER . '$1' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer);
+            $this->currentBuffer = str_replace("&", self::$INTERNAL_TAG_PLACEHOLDER . 'amp' . self::$INTERNAL_TAG_PLACEHOLDER, $this->currentBuffer);
 
             //get length of chunk
-            $this->len = strlen( $this->currentBuffer );
+            $this->len = strlen($this->currentBuffer);
 
             /*
             * Get the accumulated this->offset in the document:
@@ -137,12 +137,12 @@ 
             $this->offset += $this->len;
 
             //parse chunk of text
-            $this->runParser( $xmlParser );
+            $this->runParser($xmlParser);
 
         }
 
         // close Sax parser
-        $this->closeSaxParser( $xmlParser );
+        $this->closeSaxParser($xmlParser);
 
     }
 
@@ -151,15 +151,15 @@ 
      *
      * @return void
      */
-    protected function runParser( $xmlParser ) {
+    protected function runParser($xmlParser) {
         //parse chunk of text
-        if ( !xml_parse( $xmlParser, $this->currentBuffer, feof( $this->originalFP ) ) ) {
+        if (!xml_parse($xmlParser, $this->currentBuffer, feof($this->originalFP))) {
             //if unable, raise an exception
-            throw new RuntimeException( sprintf(
+            throw new RuntimeException(sprintf(
                     "XML error: %s at line %d",
-                    xml_error_string( xml_get_error_code( $xmlParser ) ),
-                    xml_get_current_line_number( $xmlParser )
-            ) );
+                    xml_error_string(xml_get_error_code($xmlParser)),
+                    xml_get_current_line_number($xmlParser)
+            ));
         }
     }
 
@@ -168,18 +168,18 @@ 
      *
      * @return string
      */
-    protected function getLastCharacter( $parser ): string {
+    protected function getLastCharacter($parser): string {
 
         //this logic helps detecting empty tags
         //get current position of SAX pointer in all the stream of data is has read so far:
         //it points at the end of current tag
-        $idx = xml_get_current_byte_index( $parser );
+        $idx = xml_get_current_byte_index($parser);
 
         //check whether the bounds of current tag are entirely in current buffer or the end of the current tag
         //is outside current buffer (in the latter case, it's in next buffer to be read by the while loop);
         //this check is necessary because we may have truncated a tag in half with current read,
         //and the other half may be encountered in the next buffer it will be passed
-        return $this->currentBuffer[ $idx - $this->offset ] ?? $this->currentBuffer[ $this->len - 1 ];
+        return $this->currentBuffer[$idx - $this->offset] ?? $this->currentBuffer[$this->len - 1];
 
     }
 
@@ -190,19 +190,19 @@ 
         return "§" .
                 substr(
                         str_replace(
-                                [ '+', '/' ],
+                                ['+', '/'],
                                 '',
-                                base64_encode( openssl_random_pseudo_bytes( 10, $_crypto_strong ) )
+                                base64_encode(openssl_random_pseudo_bytes(10, $_crypto_strong))
                         ),
                         0,
                         4
                 );
     }
 
-    private function createOutputFileIfDoesNotExist( string $outputFilePath ) {
+    private function createOutputFileIfDoesNotExist(string $outputFilePath) {
         // create output file
-        if ( !file_exists( $outputFilePath ) ) {
-            touch( $outputFilePath );
+        if (!file_exists($outputFilePath)) {
+            touch($outputFilePath);
         }
     }
 
@@ -210,13 +210,13 @@ 
      * @param string $originalXliffPath
      * @param string $outputFilePath
      */
-    private function setFileDescriptors( string $originalXliffPath, string $outputFilePath ) {
-        $this->outputFP = fopen( $outputFilePath, 'w+' );
+    private function setFileDescriptors(string $originalXliffPath, string $outputFilePath) {
+        $this->outputFP = fopen($outputFilePath, 'w+');
 
         $streamArgs = null;
 
-        if ( !( $this->originalFP = fopen( $originalXliffPath, "r", false, stream_context_create( $streamArgs ) ) ) ) {
-            throw new RuntimeException( "could not open XML input" );
+        if (!($this->originalFP = fopen($originalXliffPath, "r", false, stream_context_create($streamArgs)))) {
+            throw new RuntimeException("could not open XML input");
         }
     }
 
@@ -226,12 +226,12 @@ 
     public function __destruct() {
         //this stream can be closed outside the class
         //to permit multiple concurrent downloads, so suppress warnings
-        if ( is_resource( $this->originalFP ) ) {
-            fclose( $this->originalFP );
+        if (is_resource($this->originalFP)) {
+            fclose($this->originalFP);
         }
 
-        if ( is_resource( $this->outputFP ) ) {
-            fclose( $this->outputFP );
+        if (is_resource($this->outputFP)) {
+            fclose($this->outputFP);
         }
 
     }
@@ -242,11 +242,11 @@ 
      * @return resource
      */
     protected function initSaxParser() {
-        $xmlSaxParser = xml_parser_create( 'UTF-8' );
-        xml_set_object( $xmlSaxParser, $this );
-        xml_parser_set_option( $xmlSaxParser, XML_OPTION_CASE_FOLDING, false );
-        xml_set_element_handler( $xmlSaxParser, 'tagOpen', 'tagClose' );
-        xml_set_character_data_handler( $xmlSaxParser, 'characterData' );
+        $xmlSaxParser = xml_parser_create('UTF-8');
+        xml_set_object($xmlSaxParser, $this);
+        xml_parser_set_option($xmlSaxParser, XML_OPTION_CASE_FOLDING, false);
+        xml_set_element_handler($xmlSaxParser, 'tagOpen', 'tagClose');
+        xml_set_character_data_handler($xmlSaxParser, 'characterData');
 
         return $xmlSaxParser;
     }
@@ -254,8 +254,8 @@ 
     /**
      * @param resource $xmlSaxParser
      */
-    protected function closeSaxParser( $xmlSaxParser ) {
-        xml_parser_free( $xmlSaxParser );
+    protected function closeSaxParser($xmlSaxParser) {
+        xml_parser_free($xmlSaxParser);
     }
 
     /**
@@ -265,7 +265,7 @@ 
      *
      * @return mixed
      */
-    abstract protected function tagOpen( $parser, string $name, array $attr );
+    abstract protected function tagOpen($parser, string $name, array $attr);
 
     /**
      * @param resource $parser
@@ -273,7 +273,7 @@ 
      *
      * @return mixed
      */
-    abstract protected function tagClose( $parser, string $name );
+    abstract protected function tagClose($parser, string $name);
 
     /**
      * @param resource $parser
@@ -281,11 +281,11 @@ 
      *
      * @return mixed
      */
-    protected function characterData( $parser, string $data ): void {
+    protected function characterData($parser, string $data): void {
         // don't write <target> data
-        if ( !$this->inTarget && !$this->bufferIsActive ) {
-            $this->postProcAndFlush( $this->outputFP, $data );
-        } elseif ( $this->bufferIsActive ) {
+        if (!$this->inTarget && !$this->bufferIsActive) {
+            $this->postProcAndFlush($this->outputFP, $data);
+        } elseif ($this->bufferIsActive) {
             $this->CDATABuffer .= $data;
         }
     }
@@ -297,19 +297,19 @@ 
      * @param string   $data
      * @param bool     $treatAsCDATA
      */
-    protected function postProcAndFlush( $fp, string $data, bool $treatAsCDATA = false ) {
+    protected function postProcAndFlush($fp, string $data, bool $treatAsCDATA = false) {
         //postprocess string
-        $data = preg_replace( "/" . self::$INTERNAL_TAG_PLACEHOLDER . '(.*?)' . self::$INTERNAL_TAG_PLACEHOLDER . "/", '&$1;', $data );
-        $data = str_replace( '&nbsp;', ' ', $data );
-        if ( !$treatAsCDATA ) {
+        $data = preg_replace("/" . self::$INTERNAL_TAG_PLACEHOLDER . '(.*?)' . self::$INTERNAL_TAG_PLACEHOLDER . "/", '&$1;', $data);
+        $data = str_replace('&nbsp;', ' ', $data);
+        if (!$treatAsCDATA) {
             //unix2dos
-            $data = str_replace( "\r\n", "\r", $data );
-            $data = str_replace( "\n", "\r", $data );
-            $data = str_replace( "\r", "\r\n", $data );
+            $data = str_replace("\r\n", "\r", $data);
+            $data = str_replace("\n", "\r", $data);
+            $data = str_replace("\r", "\r\n", $data);
         }
 
         //flush to disk
-        fwrite( $fp, $data );
+        fwrite($fp, $data);
     }
 
     /**
@@ -318,19 +318,19 @@ 
      *
      * @return void
      */
-    protected function handleOpenUnit( string $name, array $attr ) {
+    protected function handleOpenUnit(string $name, array $attr) {
 
         // check if we are entering into a <trans-unit> (xliff v1.*) or <unit> (xliff v2.*)
-        if ( $this->tuTagName === $name ) {
+        if ($this->tuTagName === $name) {
             $this->inTU = true;
 
             // get id
             // trim to first 100 characters because this is the limit on Matecat's DB
-            $this->currentTransUnitId = substr( $attr[ 'id' ], 0, 100 );
+            $this->currentTransUnitId = substr($attr['id'], 0, 100);
 
             // `translate` attribute can be only yes or no
             // current 'translate' attribute of the current trans-unit
-            $this->currentTransUnitIsTranslatable = empty( $attr[ 'translate' ] ) ? 'yes' : $attr[ 'translate' ];
+            $this->currentTransUnitIsTranslatable = empty($attr['translate']) ? 'yes' : $attr['translate'];
 
             $this->setLastTransUnitSegments();
 
@@ -344,15 +344,15 @@ 
      *
      * @return string
      */
-    protected function handleOpenXliffTag( string $name, array $attr, string $tag ): string {
+    protected function handleOpenXliffTag(string $name, array $attr, string $tag): string {
 
         // Add MateCat specific namespace.
         // Add trgLang
-        if ( $name === 'xliff' ) {
-            if ( !array_key_exists( 'xmlns:mtc', $attr ) ) {
+        if ($name === 'xliff') {
+            if (!array_key_exists('xmlns:mtc', $attr)) {
                 $tag .= ' xmlns:mtc="https://www.matecat.com" ';
             }
-            $tag = preg_replace( '/trgLang="(.*?)"/', 'trgLang="' . $this->targetLang . '"', $tag );
+            $tag = preg_replace('/trgLang="(.*?)"/', 'trgLang="' . $this->targetLang . '"', $tag);
         }
 
         return $tag;
@@ -364,10 +364,10 @@ 
      *
      * @return void
      */
-    protected function checkSetInTarget( string $name ) {
+    protected function checkSetInTarget(string $name) {
         // check if we are entering into a <target>
-        if ( 'target' === $name ) {
-            if ( $this->currentTransUnitIsTranslatable === 'no' ) {
+        if ('target' === $name) {
+            if ($this->currentTransUnitIsTranslatable === 'no') {
                 $this->inTarget = false;
             } else {
                 $this->inTarget = true;
@@ -380,8 +380,8 @@ 
      *
      * @return void
      */
-    protected function setInBuffer( string $name ) {
-        if ( in_array( $name, $this->nodesToBuffer ) ) {
+    protected function setInBuffer(string $name) {
+        if (in_array($name, $this->nodesToBuffer)) {
             $this->bufferIsActive = true;
         }
     }
@@ -389,24 +389,24 @@ 
     /**
      * @param array $seg
      */
-    protected function updateSegmentCounts( array $seg = [] ) {
+    protected function updateSegmentCounts(array $seg = []) {
 
-        $raw_word_count = $seg[ 'raw_word_count' ];
-        $eq_word_count  = ( floor( $seg[ 'eq_word_count' ] * 100 ) / 100 );
+        $raw_word_count = $seg['raw_word_count'];
+        $eq_word_count  = (floor($seg['eq_word_count'] * 100) / 100);
 
-        $this->counts[ 'segments_count_array' ][ $seg[ 'sid' ] ] = [
+        $this->counts['segments_count_array'][$seg['sid']] = [
                 'raw_word_count' => $raw_word_count,
                 'eq_word_count'  => $eq_word_count,
         ];
 
-        $this->counts[ 'raw_word_count' ] += $raw_word_count;
-        $this->counts[ 'eq_word_count' ]  += $eq_word_count;
+        $this->counts['raw_word_count'] += $raw_word_count;
+        $this->counts['eq_word_count']  += $eq_word_count;
     }
 
     protected function resetCounts() {
-        $this->counts[ 'segments_count_array' ] = [];
-        $this->counts[ 'raw_word_count' ]       = 0;
-        $this->counts[ 'eq_word_count' ]        = 0;
+        $this->counts['segments_count_array'] = [];
+        $this->counts['raw_word_count']       = 0;
+        $this->counts['eq_word_count']        = 0;
     }
 
     /**
@@ -415,16 +415,16 @@ 
      *
      * @return void
      */
-    protected function checkForSelfClosedTagAndFlush( $parser, string $tag ) {
+    protected function checkForSelfClosedTagAndFlush($parser, string $tag) {
 
-        $lastChar = $this->getLastCharacter( $parser );
+        $lastChar = $this->getLastCharacter($parser);
 
         //trim last space
-        $tag = rtrim( $tag );
+        $tag = rtrim($tag);
 
         //detect empty tag
         $this->isEmpty = $lastChar == '/';
-        if ( $this->isEmpty ) {
+        if ($this->isEmpty) {
             $tag .= $lastChar;
         }
 
@@ -432,11 +432,11 @@ 
         $tag .= ">";
 
         //set a Buffer for the segSource Source tag
-        if ( $this->bufferIsActive ) { // we are opening a critical CDATA section
+        if ($this->bufferIsActive) { // we are opening a critical CDATA section
             //these are NOT source/seg-source/value empty tags, THERE IS A CONTENT, write it in buffer
             $this->CDATABuffer .= $tag;
         } else {
-            $this->postProcAndFlush( $this->outputFP, $tag );
+            $this->postProcAndFlush($this->outputFP, $tag);
         }
 
     }
@@ -461,18 +461,18 @@ 
          */
         $this->lastTransUnit = [];
 
-        if ( !isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
+        if (!isset($this->transUnits[$this->currentTransUnitId])) {
             return;
         }
 
-        $listOfSegmentsIds = $this->transUnits[ $this->currentTransUnitId ];
+        $listOfSegmentsIds = $this->transUnits[$this->currentTransUnitId];
         $last_value        = null;
-        $segmentsCount     = count( $listOfSegmentsIds );
-        for ( $i = 0; $i < $segmentsCount; $i++ ) {
-            $id = $listOfSegmentsIds[ $i ];
-            if ( isset( $this->segments[ $id ] ) && ( $i == 0 || $last_value + 1 == $listOfSegmentsIds[ $i ] ) ) {
-                $last_value            = $listOfSegmentsIds[ $i ];
-                $this->lastTransUnit[] = $this->segments[ $id ];
+        $segmentsCount     = count($listOfSegmentsIds);
+        for ($i = 0; $i < $segmentsCount; $i++) {
+            $id = $listOfSegmentsIds[$i];
+            if (isset($this->segments[$id]) && ($i == 0 || $last_value + 1 == $listOfSegmentsIds[$i])) {
+                $last_value            = $listOfSegmentsIds[$i];
+                $this->lastTransUnit[] = $this->segments[$id];
             }
         }
 
@@ -482,8 +482,8 @@ 
      * @return array
      */
     protected function getCurrentSegment(): array {
-        if ( $this->currentTransUnitIsTranslatable !== 'no' && isset( $this->transUnits[ $this->currentTransUnitId ] ) ) {
-            return $this->segments[ $this->segmentInUnitPosition ];
+        if ($this->currentTransUnitIsTranslatable !== 'no' && isset($this->transUnits[$this->currentTransUnitId])) {
+            return $this->segments[$this->segmentInUnitPosition];
         }
 
         return [];