Xliff::toString() - Code Metrics - Inspection of "Add support for XLIFF unit IDs" - oscarotero/Gettext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#221)

by Alec

created 2019-09-14 21:37 UTC

Xliff::toString() F

↳ Parent: Xliff

Complexity

Conditions	12
Paths	580

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
nc	580
nop	2
dl	0
loc	78
rs	3.1866
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

namespace Gettext\Generators;

use Gettext\Translation;
use Gettext\Translations;
use DOMDocument;

class Xliff extends Generator implements GeneratorInterface
{
    const UNIT_ID_REGEXP = '/^XLIFF_UNIT_ID: (.*)$/';

    /**
     * {@inheritdoc}
     */
    public static function toString(Translations $translations, array $options = [])
    {
        $dom = new DOMDocument('1.0', 'utf-8');
        $dom->formatOutput = true;
        $xliff = $dom->appendChild($dom->createElement('xliff'));
        $xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:2.0');
        $xliff->setAttribute('version', '2.0');
        $xliff->setAttribute('srcLang', $translations->getLanguage());
        $xliff->setAttribute('trgLang', $translations->getLanguage());
        $file = $xliff->appendChild($dom->createElement('file'));
        $file->setAttribute('id', $translations->getDomain().'.'.$translations->getLanguage());

        //Save headers as notes
        $notes = $dom->createElement('notes');

        foreach ($translations->getHeaders() as $name => $value) {
            $notes->appendChild(self::createTextNode($dom, 'note', $value))->setAttribute('id', $name);
        }

        if ($notes->hasChildNodes()) {
            $file->appendChild($notes);
        }

        foreach ($translations as $translation) {
            //Find an XLIFF unit ID, if one is available; otherwise generate
            $unitId = self::getUnitID($translation)?:md5($translation->getContext().$translation->getOriginal());

            $unit = $dom->createElement('unit');
            $unit->setAttribute('id', $unitId);

            //Save comments as notes
            $notes = $dom->createElement('notes');

            $notes->appendChild(self::createTextNode($dom, 'note', $translation->getContext()))
                ->setAttribute('category', 'context');

            foreach ($translation->getComments() as $comment) {
                //Skip XLIFF unit ID comments.
                if (preg_match(self::UNIT_ID_REGEXP, $comment)) {
                    continue;
                }

                $notes->appendChild(self::createTextNode($dom, 'note', $comment))
                    ->setAttribute('category', 'comment');
            }

            foreach ($translation->getExtractedComments() as $comment) {
                $notes->appendChild(self::createTextNode($dom, 'note', $comment))
                    ->setAttribute('category', 'extracted-comment');
            }

            foreach ($translation->getFlags() as $flag) {
                $notes->appendChild(self::createTextNode($dom, 'note', $flag))
                    ->setAttribute('category', 'flag');
            }

            foreach ($translation->getReferences() as $reference) {
                $notes->appendChild(self::createTextNode($dom, 'note', $reference[0].':'.$reference[1]))
                    ->setAttribute('category', 'reference');
            }

            $unit->appendChild($notes);

            $segment = $unit->appendChild($dom->createElement('segment'));
            $segment->appendChild(self::createTextNode($dom, 'source', $translation->getOriginal()));
            $segment->appendChild(self::createTextNode($dom, 'target', $translation->getTranslation()));

            foreach ($translation->getPluralTranslations() as $plural) {
                if ($plural !== '') {
                    $segment->appendChild(self::createTextNode($dom, 'target', $plural));
                }
            }

            $file->appendChild($unit);
        }

        return $dom->saveXML();
    }

    private static function createTextNode(DOMDocument $dom, $name, $string)
    {
        $node = $dom->createElement($name);
        $text = (preg_match('/[&<>]/', $string) === 1)
             ? $dom->createCDATASection($string)
             : $dom->createTextNode($string);
        $node->appendChild($text);

        return $node;
    }

    /**
     * Gets the translation's unit ID, if one is available.
     *
     * @param Translation $translation
     *
     * @return string|null
     */
    public static function getUnitID(Translation $translation)
    {
        foreach ($translation->getComments() as $comment) {
            if (preg_match(self::UNIT_ID_REGEXP, $comment, $matches)) {
                return $matches[1];
            }
        }
        return null;
    }
}


1			<?php
2
3			namespace Gettext\Generators;
4
5			use Gettext\Translation;
6			use Gettext\Translations;
7			use DOMDocument;
8
9			class Xliff extends Generator implements GeneratorInterface
10			{
11			const UNIT_ID_REGEXP = '/^XLIFF_UNIT_ID: (.*)$/';
12
13			/**
14			* {@inheritdoc}
15			*/
16			public static function toString(Translations $translations, array $options = [])
17			{
18			$dom = new DOMDocument('1.0', 'utf-8');
19			$dom->formatOutput = true;
20			$xliff = $dom->appendChild($dom->createElement('xliff'));
21			$xliff->setAttribute('xmlns', 'urn:oasis:names:tc:xliff:document:2.0');
22			$xliff->setAttribute('version', '2.0');
23			$xliff->setAttribute('srcLang', $translations->getLanguage());
24			$xliff->setAttribute('trgLang', $translations->getLanguage());
25			$file = $xliff->appendChild($dom->createElement('file'));
26			$file->setAttribute('id', $translations->getDomain().'.'.$translations->getLanguage());
27
28			//Save headers as notes
29			$notes = $dom->createElement('notes');
30
31			foreach ($translations->getHeaders() as $name => $value) {
32			$notes->appendChild(self::createTextNode($dom, 'note', $value))->setAttribute('id', $name);
33			}
34
35			if ($notes->hasChildNodes()) {
36			$file->appendChild($notes);
37			}
38
39			foreach ($translations as $translation) {
40			//Find an XLIFF unit ID, if one is available; otherwise generate
41			$unitId = self::getUnitID($translation)?:md5($translation->getContext().$translation->getOriginal());
42
43			$unit = $dom->createElement('unit');
44			$unit->setAttribute('id', $unitId);
45
46			//Save comments as notes
47			$notes = $dom->createElement('notes');
48
49			$notes->appendChild(self::createTextNode($dom, 'note', $translation->getContext()))
50			->setAttribute('category', 'context');
51
52			foreach ($translation->getComments() as $comment) {
53			//Skip XLIFF unit ID comments.
54			if (preg_match(self::UNIT_ID_REGEXP, $comment)) {
55			continue;
56			}
57
58			$notes->appendChild(self::createTextNode($dom, 'note', $comment))
59			->setAttribute('category', 'comment');
60			}
61
62			foreach ($translation->getExtractedComments() as $comment) {
63			$notes->appendChild(self::createTextNode($dom, 'note', $comment))
64			->setAttribute('category', 'extracted-comment');
65			}
66
67			foreach ($translation->getFlags() as $flag) {
68			$notes->appendChild(self::createTextNode($dom, 'note', $flag))
69			->setAttribute('category', 'flag');
70			}
71
72			foreach ($translation->getReferences() as $reference) {
73			$notes->appendChild(self::createTextNode($dom, 'note', $reference[0].':'.$reference[1]))
74			->setAttribute('category', 'reference');
75			}
76
77			$unit->appendChild($notes);
78
79			$segment = $unit->appendChild($dom->createElement('segment'));
80			$segment->appendChild(self::createTextNode($dom, 'source', $translation->getOriginal()));
81			$segment->appendChild(self::createTextNode($dom, 'target', $translation->getTranslation()));
82
83			foreach ($translation->getPluralTranslations() as $plural) {
84			if ($plural !== '') {
85			$segment->appendChild(self::createTextNode($dom, 'target', $plural));
86			}
87			}
88
89			$file->appendChild($unit);
90			}
91
92			return $dom->saveXML();
93			}
94
95			private static function createTextNode(DOMDocument $dom, $name, $string)
96			{
97			$node = $dom->createElement($name);
98			$text = (preg_match('/[&<>]/', $string) === 1)
99			? $dom->createCDATASection($string)
100			: $dom->createTextNode($string);
101			$node->appendChild($text);
102
103			return $node;
104			}
105
106			/**
107			* Gets the translation's unit ID, if one is available.
108			*
109			* @param Translation $translation
110			*
111			* @return string\|null
112			*/
113			public static function getUnitID(Translation $translation)
114			{
115			foreach ($translation->getComments() as $comment) {
116			if (preg_match(self::UNIT_ID_REGEXP, $comment, $matches)) {
117			return $matches[1];
118			}
119			}
120			return null;
121			}
122			}
123

oscarotero / Gettext

Pull Request — master (#221)

Xliff::toString() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like