EditTranslationHelperTrait::getAllKey()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 5
nc 2
nop 0
dl 0
loc 10
rs 9.4285
c 0
b 0
f 0
1
<?php
2
/*
3
 * Copyright (c) 2012 David Negrier
4
 *
5
 * See the file LICENSE.txt for copying permission.
6
 */
7
namespace Mouf\Utils\I18n\Fine\Common\Ui;
8
9
/**
10
 * Used to translation message
11
 * This class add default implementation to create your own storage translator
12
 *
13
 * @author Marc Teyssier
14
 *
15
 */
16
trait EditTranslationHelperTrait
17
{
18
19
    /**
20
     * Add or change many translations in one time
21
     *
22
     * @param array<string, string> $messages List with key value of translation
23
     * @param string                $language Language to add translation
24
     */
25
    public function setTranslationsForLanguage(array $messages, $language)
26
    {
27
        foreach ($messages as $key => $value) {
28
            $this->setTranslation($key, $value, $language);
0 ignored issues
show
Bug introduced by
The method setTranslation() does not exist on Mouf\Utils\I18n\Fine\Com...tTranslationHelperTrait. Did you maybe mean setTranslationsForLanguage()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
29
        }
30
    }
31
32
    /**
33
     * Add or change many translations in one time
34
     *
35
     * @param array<string, string> $messages List with key value of translation
36
     * @param string                $key      Key to add translation
37
     */
38
    public function setTranslationsForKey(array $messages, $key)
39
    {
40
        foreach ($messages as $language => $value) {
41
            $this->setTranslation($key, $value, $language);
0 ignored issues
show
Bug introduced by
The method setTranslation() does not exist on Mouf\Utils\I18n\Fine\Com...tTranslationHelperTrait. Did you maybe mean setTranslationsForLanguage()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
42
        }
43
    }
44
45
    /**
46
     * Return the list of all translation. The table has 2 dimensions.
47
     * The first is the language.
48
     * The second is the key value of translation
49
     *
50
     * @return array<string, array<string, string>> Translations
0 ignored issues
show
Documentation introduced by
The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
51
     */
52
    public function getAllTranslationByLanguage()
53
    {
54
        $messages = array();
55
        foreach ($this->getLanguageList() as $language) {
0 ignored issues
show
Bug introduced by
It seems like getLanguageList() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
56
            $messages[$language] = $this->getTranslationsForLanguage($language);
0 ignored issues
show
Bug introduced by
It seems like getTranslationsForLanguage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
57
        }
58
59
        return $messages;
60
    }
61
62
    /**
63
     * Return an array with all the key create without language checking
64
     *
65
     * @return array<string> All key
66
     */
67
    public function getAllKey()
68
    {
69
        $keys = array();
70
        // First, let's merge all the arrays in order to get all the keys:
71
        foreach ($this->getAllTranslationByLanguage() as $translations) {
72
            $keys = array_merge($keys, $translations);
73
        }
74
75
        return array_keys($keys);
76
    }
77
}
78