Completed
Pull Request — master (#1)
by Sascha-Oliver
05:59
created

XliffConverter::contentToCatalogue()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 8
ccs 0
cts 7
cp 0
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 5
nc 1
nop 3
crap 2
1
<?php
2
3
namespace Translation\PlatformAdapter\PhraseApp\Bridge\Symfony;
4
5
use Symfony\Component\Translation\MessageCatalogue;
6
use Translation\SymfonyStorage\Dumper\XliffDumper;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Translation\PlatformAdap...dge\Symfony\XliffDumper.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
7
use Translation\SymfonyStorage\Loader\XliffLoader;
8
9
/**
10
 * Utility class to convert between a MessageCatalogue and XLIFF file content.
11
 */
12
final class XliffConverter
13
{
14
    /**
15
     * Create a catalogue from the contents of a XLIFF file.
16
     *
17
     * @param string $content
18
     * @param string $locale
19
     * @param string $domain
20
     *
21
     * @return MessageCatalogue
22
     */
23
    public static function contentToCatalogue($content, $locale, $domain)
24
    {
25
        $loader = new XliffLoader();
26
        $catalogue = new MessageCatalogue($locale);
27
        $loader->extractFromContent($content, $catalogue, $domain);
28
29
        return $catalogue;
30
    }
31
32
    /**
33
     * @param MessageCatalogue $catalogue
34
     * @param string           $domain
35
     *
36
     * @return string
37
     */
38
    public static function catalogueToContent(MessageCatalogue $catalogue, $domain)
39
    {
40
        $dumper = new XliffDumper();
41
42
        return $dumper->getFormattedCatalogue($catalogue, $domain);
43
    }
44
}
45