matecat / subfiltering

src/Utils/DataRefReplacer.php

Spacing +92 added lines, -92 removed lines

@@ -27,8 +27,8 @@ 
      *
      * @param array $map
      */
-    public function __construct( array $map = [] ) {
-        $this->map = Map::instance( $this->sanitizeMap( $map ) );
+    public function __construct(array $map = []) {
+        $this->map = Map::instance($this->sanitizeMap($map));
     }
 
     /**
@@ -42,42 +42,42 @@ 
      *
      * @return string
      */
-    public function replace( $string ) {
+    public function replace($string) {
 
         // if the map is empty
         // or the string has not a dataRef attribute
         // return string as is
-        if ( $this->map->isEmpty() || !$this->hasAnyDataRefAttribute( $string ) ) {
+        if ($this->map->isEmpty() || !$this->hasAnyDataRefAttribute($string)) {
             return $string;
         }
 
         // try not to throw exception for wrong segments with opening tags and no closing
         try {
 
-            $html = XmlParser::parse( $string, true );
+            $html = XmlParser::parse($string, true);
 
             $dataRefEndMap = new ArrayList();
 
-            foreach ( $html as $node ) {
+            foreach ($html as $node) {
 
                 // 1. Replace <ph>|<sc>|<ec> tags
-                $string = $this->recursiveTransformDataRefToPhTag( $node, $string );
+                $string = $this->recursiveTransformDataRefToPhTag($node, $string);
 
                 // 2. Replace self-closed <pc dataRefStart="xyz" /> tags
-                $string = $this->recursiveReplaceSelfClosedPcTags( $node, $string );
+                $string = $this->recursiveReplaceSelfClosedPcTags($node, $string);
 
                 // 3. Build the DataRefEndMap needed by replaceClosingPcTags function
                 // (needed for correct handling of </pc> closing tags)
                 // make this inline with one foreach cycle
-                $this->extractDataRefMapRecursively( $node, $string, $dataRefEndMap );
+                $this->extractDataRefMapRecursively($node, $string, $dataRefEndMap);
 
             }
 
             // 4. replace pc tags
-            $string = $this->replaceOpeningPcTags( $string );
-            $string = $this->replaceClosingPcTags( $string, $dataRefEndMap );
+            $string = $this->replaceOpeningPcTags($string);
+            $string = $this->replaceClosingPcTags($string, $dataRefEndMap);
 
-        } catch ( Exception $ignore ) {
+        } catch (Exception $ignore) {
             // if something fails here, do not throw exception and return the original string instead
 //            var_dump( $ignore );
         } finally {
@@ -91,8 +91,8 @@ 
      *
      * @return bool
      */
-    private function hasAnyDataRefAttribute( $string ) {
-        return (bool)preg_match( '/(dataRef|dataRefStart|dataRefEnd)=[\'"].*?[\'"]/', $string );
+    private function hasAnyDataRefAttribute($string) {
+        return (bool) preg_match('/(dataRef|dataRefStart|dataRefEnd)=[\'"].*?[\'"]/', $string);
     }
 
     /**
@@ -108,18 +108,18 @@ 
      *
      * @return string
      */
-    private function recursiveTransformDataRefToPhTag( $node, $string ) {
+    private function recursiveTransformDataRefToPhTag($node, $string) {
 
-        if ( $node->has_children ) {
+        if ($node->has_children) {
 
-            foreach ( $node->inner_html as $childNode ) {
-                $string = $this->recursiveTransformDataRefToPhTag( $childNode, $string );
+            foreach ($node->inner_html as $childNode) {
+                $string = $this->recursiveTransformDataRefToPhTag($childNode, $string);
             }
 
         } else {
 
             // accept only those tags
-            switch ( $node->tagName ) {
+            switch ($node->tagName) {
                 case 'ph':
                     $ctype = CTypeEnum::PH_DATA_REF;
                     break;
@@ -134,17 +134,17 @@ 
             }
 
             // if isset a value in the map proceed with conversion otherwise skip
-            $attributesMap = Map::instance( $node->attributes );
-            if ( !$this->map->get( $attributesMap->get( 'dataRef' ) ) ) {
+            $attributesMap = Map::instance($node->attributes);
+            if (!$this->map->get($attributesMap->get('dataRef'))) {
                 return $string;
             }
 
-            $dataRefName = $node->attributes[ 'dataRef' ];   // map identifier. Eg: source1
+            $dataRefName = $node->attributes['dataRef']; // map identifier. Eg: source1
 
             return $this->replaceNewTagString(
                     $node->node,
-                    $attributesMap->getOrDefault( 'id', $dataRefName ),
-                    $this->map->getOrDefault( $node->attributes[ 'dataRef' ], 'NULL' ),
+                    $attributesMap->getOrDefault('id', $dataRefName),
+                    $this->map->getOrDefault($node->attributes['dataRef'], 'NULL'),
                     $ctype,
                     $string,
                     null
@@ -162,11 +162,11 @@ 
      *
      * @return array
      */
-    private function sanitizeMap( $map ) {
+    private function sanitizeMap($map) {
 
-        foreach ( $map as $name => $value ) {
-            if ( is_null( $value ) || $value === '' ) {
-                $map[ $name ] = 'NULL';
+        foreach ($map as $name => $value) {
+            if (is_null($value) || $value === '') {
+                $map[$name] = 'NULL';
             }
         }
 
@@ -182,23 +182,23 @@ 
      * @throws InvalidXmlException
      * @throws XmlParsingException
      */
-    private function recursiveReplaceSelfClosedPcTags( $node, $string ) {
+    private function recursiveReplaceSelfClosedPcTags($node, $string) {
 
-        if ( $node->has_children ) {
+        if ($node->has_children) {
 
-            foreach ( $node->inner_html as $childNode ) {
-                $string = $this->recursiveReplaceSelfClosedPcTags( $childNode, $string );
+            foreach ($node->inner_html as $childNode) {
+                $string = $this->recursiveReplaceSelfClosedPcTags($childNode, $string);
             }
 
-        } elseif ( $node->tagName == 'pc' && $node->self_closed === true ) {
+        } elseif ($node->tagName == 'pc' && $node->self_closed === true) {
 
-            $attributesMap = Map::instance( $node->attributes );
+            $attributesMap = Map::instance($node->attributes);
 
-            if ( $dataRefStartValue = $this->map->get( $node->attributes[ 'dataRefStart' ] ) ) {
+            if ($dataRefStartValue = $this->map->get($node->attributes['dataRefStart'])) {
 
                 $string = $this->replaceNewTagString(
                         $node->node,
-                        $attributesMap->get( 'id' ),
+                        $attributesMap->get('id'),
                         $dataRefStartValue,
                         CTypeEnum::PC_SELF_CLOSE_DATA_REF,
                         $string
@@ -219,12 +219,12 @@ 
      * @param string    $completeString
      * @param ArrayList $dataRefEndMap
      */
-    private function extractDataRefMapRecursively( $node, $completeString, ArrayList $dataRefEndMap ) {
+    private function extractDataRefMapRecursively($node, $completeString, ArrayList $dataRefEndMap) {
 
         // we have to build the map for the closing pc tag, so get the children first
-        if ( $node->has_children ) {
-            foreach ( $node->inner_html as $nestedNode ) {
-                $this->extractDataRefMapRecursively( $nestedNode, $completeString, $dataRefEndMap );
+        if ($node->has_children) {
+            foreach ($node->inner_html as $nestedNode) {
+                $this->extractDataRefMapRecursively($nestedNode, $completeString, $dataRefEndMap);
             }
         }
 
@@ -237,15 +237,15 @@ 
         //   becomes
         // <pc id="source5" dataRefStart="source5"></pc>
         //
-        $isATagPairWithEmptyTextNode = strpos( $completeString, substr( $node->node, 0, -2 ) . '></pc>' ) !== false;
+        $isATagPairWithEmptyTextNode = strpos($completeString, substr($node->node, 0, -2).'></pc>') !== false;
 
-        if ( $node->tagName === 'pc' && ( $node->self_closed === false || $isATagPairWithEmptyTextNode ) ) {
+        if ($node->tagName === 'pc' && ($node->self_closed === false || $isATagPairWithEmptyTextNode)) {
 
-            $attributesMap = Map::instance( $node->attributes );
-            $dataRefEnd    = $attributesMap->getOrDefault( 'dataRefEnd', $attributesMap->get( 'dataRefStart' ) );
+            $attributesMap = Map::instance($node->attributes);
+            $dataRefEnd    = $attributesMap->getOrDefault('dataRefEnd', $attributesMap->get('dataRefStart'));
 
             $dataRefEndMap[] = [
-                    'id'         => $attributesMap->get( 'id' ),
+                    'id'         => $attributesMap->get('id'),
                     'dataRefEnd' => $dataRefEnd,
             ];
 
@@ -263,31 +263,31 @@ 
      * @throws InvalidXmlException
      * @throws XmlParsingException
      */
-    private function replaceOpeningPcTags( $string ) {
+    private function replaceOpeningPcTags($string) {
 
-        preg_match_all( '|<pc ([^>/]+?)>|iu', $string, $openingPcMatches );
+        preg_match_all('|<pc ([^>/]+?)>|iu', $string, $openingPcMatches);
 
-        foreach ( $openingPcMatches[ 0 ] as $match ) {
+        foreach ($openingPcMatches[0] as $match) {
 
-            $node = XmlParser::parse( $match . '</pc>', true )[ 0 ]; // add a closing tag to not break xml integrity
+            $node = XmlParser::parse($match.'</pc>', true)[0]; // add a closing tag to not break xml integrity
 
             // CASE 1 - Missing `dataRefStart`
-            if ( isset( $node->attributes[ 'dataRefEnd' ] ) && !isset( $node->attributes[ 'dataRefStart' ] ) ) {
-                $node->attributes[ 'dataRefStart' ] = $node->attributes[ 'dataRefEnd' ];
+            if (isset($node->attributes['dataRefEnd']) && !isset($node->attributes['dataRefStart'])) {
+                $node->attributes['dataRefStart'] = $node->attributes['dataRefEnd'];
             }
 
             // CASE 2 - Missing `dataRefEnd`
-            if ( isset( $node->attributes[ 'dataRefStart' ] ) && !isset( $node->attributes[ 'dataRefEnd' ] ) ) {
-                $node->attributes[ 'dataRefEnd' ] = $node->attributes[ 'dataRefStart' ];
+            if (isset($node->attributes['dataRefStart']) && !isset($node->attributes['dataRefEnd'])) {
+                $node->attributes['dataRefEnd'] = $node->attributes['dataRefStart'];
             }
 
-            if ( isset( $node->attributes[ 'dataRefStart' ] ) ) {
+            if (isset($node->attributes['dataRefStart'])) {
 
-                $attributesMap = Map::instance( $node->attributes );
+                $attributesMap = Map::instance($node->attributes);
                 $string        = $this->replaceNewTagString(
                         $match,
-                        $attributesMap->get( 'id' ),
-                        $this->map->getOrDefault( $node->attributes[ 'dataRefStart' ], 'NULL' ),
+                        $attributesMap->get('id'),
+                        $this->map->getOrDefault($node->attributes['dataRefStart'], 'NULL'),
                         CTypeEnum::PC_OPEN_DATA_REF,
                         $string
                 );
@@ -307,31 +307,31 @@ 
      *
      * @return string
      */
-    private function replaceClosingPcTags( $string, ArrayList $dataRefEndMap ) {
+    private function replaceClosingPcTags($string, ArrayList $dataRefEndMap) {
 
-        preg_match_all( '|</pc>|iu', $string, $closingPcMatches, PREG_OFFSET_CAPTURE );
+        preg_match_all('|</pc>|iu', $string, $closingPcMatches, PREG_OFFSET_CAPTURE);
         $delta = 0;
 
-        foreach ( $closingPcMatches[ 0 ] as $index => $match ) {
+        foreach ($closingPcMatches[0] as $index => $match) {
 
-            $offset = $match[ 1 ];
+            $offset = $match[1];
             $length = 5; // strlen of '</pc>'
 
-            $attr = $dataRefEndMap->get( $index );
-            if ( !empty( $attr ) && isset( $attr[ 'dataRefEnd' ] ) ) {
+            $attr = $dataRefEndMap->get($index);
+            if (!empty($attr) && isset($attr['dataRefEnd'])) {
 
                 // conversion for opening <pc> tag
                 $completeTag = $this->getNewTagString(
                         '</pc>',
-                        $attr[ 'id' ],
-                        $this->map->getOrDefault( $attr[ 'dataRefEnd' ], 'NULL' ),
+                        $attr['id'],
+                        $this->map->getOrDefault($attr['dataRefEnd'], 'NULL'),
                         CTypeEnum::PC_CLOSE_DATA_REF,
                         '_2'
                 );
 
-                $realOffset = ( $delta === 0 ) ? $offset : ( $offset + $delta );
-                $string     = substr_replace( $string, $completeTag, $realOffset, $length );
-                $delta      = $delta + strlen( $completeTag ) - $length;
+                $realOffset = ($delta === 0) ? $offset : ($offset + $delta);
+                $string     = substr_replace($string, $completeTag, $realOffset, $length);
+                $delta      = $delta + strlen($completeTag) - $length;
 
             }
 
@@ -349,17 +349,17 @@ 
      * @throws InvalidXmlException
      * @throws XmlParsingException
      */
-    public function restore( $string ) {
+    public function restore($string) {
 
         // if the map is empty return string as is
-        if ( empty( $this->map ) ) {
+        if (empty($this->map)) {
             return $string;
         }
 
-        $html = XmlParser::parse( $string, true );
+        $html = XmlParser::parse($string, true);
 
-        foreach ( $html as $node ) {
-            $string = $this->recursiveRestoreOriginalTags( $node, $string );
+        foreach ($html as $node) {
+            $string = $this->recursiveRestoreOriginalTags($node, $string);
         }
 
         return $string;
@@ -371,26 +371,26 @@ 
      *
      * @return string
      */
-    private function recursiveRestoreOriginalTags( $node, $string ) {
+    private function recursiveRestoreOriginalTags($node, $string) {
 
-        if ( $node->has_children ) {
+        if ($node->has_children) {
 
-            foreach ( $node->inner_html as $childNode ) {
-                $string = $this->recursiveRestoreOriginalTags( $childNode, $string );
+            foreach ($node->inner_html as $childNode) {
+                $string = $this->recursiveRestoreOriginalTags($childNode, $string);
             }
 
         } else {
 
-            $nodeAttributesMap = Map::instance( $node->attributes );
+            $nodeAttributesMap = Map::instance($node->attributes);
 
-            if ( !$nodeAttributesMap->get( 'x-orig' ) ) {
+            if (!$nodeAttributesMap->get('x-orig')) {
                 return $string;
             }
 
-            $cType = $nodeAttributesMap->get( 'ctype' );
+            $cType = $nodeAttributesMap->get('ctype');
 
-            if ( CTypeEnum::isLayer2Constant( $cType ) ) {
-                return preg_replace( '/' . preg_quote( $node->node, '/' ) . '/', base64_decode( $nodeAttributesMap->get( 'x-orig' ) ), $string, 1 );
+            if (CTypeEnum::isLayer2Constant($cType)) {
+                return preg_replace('/'.preg_quote($node->node, '/').'/', base64_decode($nodeAttributesMap->get('x-orig')), $string, 1);
             }
 
         }
@@ -408,24 +408,24 @@ 
      *
      * @return string
      */
-    private function getNewTagString( $actualNodeString, $id, $dataRefValue, $ctype, $upCountIdValue = null ) {
+    private function getNewTagString($actualNodeString, $id, $dataRefValue, $ctype, $upCountIdValue = null) {
 
-        $newTag = [ '<ph' ];
+        $newTag = ['<ph'];
 
-        if ( isset( $id ) ) {
-            $newTag[] = 'id="' . $id . $upCountIdValue . '"';
+        if (isset($id)) {
+            $newTag[] = 'id="'.$id.$upCountIdValue.'"';
         }
 
-        $newTag[] = 'ctype="' . $ctype . '"';
-        $newTag[] = 'equiv-text="base64:' . base64_encode( $dataRefValue ) . '"';
-        $newTag[] = 'x-orig="' . base64_encode( $actualNodeString ) . '"';
+        $newTag[] = 'ctype="'.$ctype.'"';
+        $newTag[] = 'equiv-text="base64:'.base64_encode($dataRefValue).'"';
+        $newTag[] = 'x-orig="'.base64_encode($actualNodeString).'"';
 
-        return implode( " ", $newTag ) . '/>';
+        return implode(" ", $newTag).'/>';
 
     }
 
-    private function replaceNewTagString( $actualNodeString, $id, $dataRefValue, $ctype, $originalString, $upCountIdValue = '_1' ) {
-        return str_replace( $actualNodeString, $this->getNewTagString( $actualNodeString, $id, $dataRefValue, $ctype, $upCountIdValue ), $originalString );
+    private function replaceNewTagString($actualNodeString, $id, $dataRefValue, $ctype, $originalString, $upCountIdValue = '_1') {
+        return str_replace($actualNodeString, $this->getNewTagString($actualNodeString, $id, $dataRefValue, $ctype, $upCountIdValue), $originalString);
     }
 
 }
\ No newline at end of file