UploadTranslation::getTranslations() - Code Metrics - Inspection of "Allow to set directly an array of translations" - akeneo/php-crowdin-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#35)

unknown

created 2016-05-30 12:38 UTC

UploadTranslation::getTranslations() A

↳ Parent: UploadTranslation

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Akeneo\Crowdin\Api;

use \InvalidArgumentException;
use Akeneo\Crowdin\Client;
use Akeneo\Crowdin\FileReader;
use Akeneo\Crowdin\Translation;

/**
 *  Upload existing translations to your Crowdin project.
 *
 * @author Julien Janvier <[email protected]>
 * @see https://crowdin.net/page/api/upload-translation
 */
class UploadTranslation extends AbstractApi
{
    /** @var FileReader */
    protected $fileReader;

    /** @var Translation[] */
    protected $translations;

    /** @var string */
    protected $locale;

    /** @var bool */
    protected $areDuplicatesImported = false;

    /** @var bool */
    protected $areEqualSuggestionsImported = false;

    /** @var bool */
    protected $areImportsAutoApproved = false;

    /**
     * @param Client     $client
     * @param FileReader $fileReader
     */
    public function __construct(Client $client, FileReader $fileReader)
    {
        parent::__construct($client);
        $this->fileReader = $fileReader;
    }

    /**
     * {@inheritdoc}
     */
    public function execute()
    {
        if (0 === count($this->translations)) {
            throw new InvalidArgumentException('There are no translations to upload.');
        }

        if (null === $this->locale) {
            throw new InvalidArgumentException('Locale is not set.');
        }

        $path = sprintf(
            "project/%s/upload-translation?key=%s",
            $this->client->getProjectIdentifier(),
            $this->client->getProjectApiKey()
        );

        $data[] = [
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            'name'      => 'import_duplicates',
            'contents'  => (int)$this->areDuplicatesImported
        ];
        $data[] = [
            'name'      => 'import_eq_suggestions',
            'contents'  => (int)$this->areEqualSuggestionsImported
        ];
        $data[] = [
            'name'      => 'auto_approve_imported',
            'contents'  => (int)$this->areImportsAutoApproved
        ];
        $data[] = [
            'name'      => 'language',
            'contents'  => $this->locale
        ];

        foreach ($this->translations as $translation) {
            $data[] = [
                'name'       => 'files['.$translation->getCrowdinPath().']',
                'contents'   => $this->fileReader->readTranslation($translation)
            ];
        }

        $data = ['multipart' => $data];
        $response = $this->client->getHttpClient()->post($path, $data);

        return $response->getBody();
    }

    /**
     * @param string $localPath
     * @param string $crowdinPath
     * @param string $exportPattern
     * @param string $title
     *
     * @return $this
     */
    public function addTranslation($localPath, $crowdinPath, $exportPattern = null, $title = null)

    {
        $translation = new Translation($localPath, $crowdinPath);
        $translation->setExportPattern($exportPattern);
        $translation->setTitle($title);

        $this->translations[] = $translation;

        return $this;
    }
    
    /**
     * @param Translation[] $translations
     * @return UploadTranslation
     */
    public function setTranslations(array $translations)
    {
        $this->translations = $translations;
        
        return $this;
    }

    /**
     * @return Translation[]
     */
    public function getTranslations()
    {
        return $this->translations;
    }

    /**
     * @param bool $importsAutoApproved
     *
     * @throws InvalidArgumentException
     *
     * @return UploadTranslation
     */
    public function setImportsAutoApproved($importsAutoApproved)
    {
        if (!is_bool($importsAutoApproved)) {
            throw new InvalidArgumentException('A boolean is required.');
        }

        $this->areImportsAutoApproved = $importsAutoApproved;

        return $this;
    }

    /**
     * @return bool
     */
    public function areImportsAutoApproved()
    {
        return $this->areImportsAutoApproved;
    }

    /**
     * @param bool $duplicatesImported
     *
     * @throws InvalidArgumentException
     *
     * @return UploadTranslation
     */
    public function setDuplicatesImported($duplicatesImported)
    {
        if (!is_bool($duplicatesImported)) {
            throw new InvalidArgumentException('A boolean is required.');
        }

        $this->areDuplicatesImported = $duplicatesImported;

        return $this;
    }

    /**
     * @return bool
     */
    public function areDuplicatesImported()
    {
        return $this->areDuplicatesImported;
    }

    /**
     * @param bool $equalSuggestionsImported
     *
     * @throws InvalidArgumentException
     *
     * @return UploadTranslation
     */
    public function setEqualSuggestionsImported($equalSuggestionsImported)
    {
        if (!is_bool($equalSuggestionsImported)) {
            throw new InvalidArgumentException('A boolean is required.');
        }

        $this->areEqualSuggestionsImported = $equalSuggestionsImported;

        return $this;
    }

    /**
     * @return bool
     */
    public function areEqualSuggestionsImported()
    {
        return $this->areEqualSuggestionsImported;
    }

    /**
     * @param string $locale
     *
     * @return UploadTranslation
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;

        return $this;
    }

    /**
     * @return string
     */
    public function getLocale()
    {
        return $this->locale;
    }
}


1		<?php
2
3		namespace Akeneo\Crowdin\Api;
4
5		use \InvalidArgumentException;
6		use Akeneo\Crowdin\Client;
7		use Akeneo\Crowdin\FileReader;
8		use Akeneo\Crowdin\Translation;
9
10		/**
11		* Upload existing translations to your Crowdin project.
12		*
13		* @author Julien Janvier <[email protected]>
14		* @see https://crowdin.net/page/api/upload-translation
15		*/
16		class UploadTranslation extends AbstractApi
17		{
18		/** @var FileReader */
19		protected $fileReader;
20
21		/** @var Translation[] */
22		protected $translations;
23
24		/** @var string */
25		protected $locale;
26
27		/** @var bool */
28		protected $areDuplicatesImported = false;
29
30		/** @var bool */
31		protected $areEqualSuggestionsImported = false;
32
33		/** @var bool */
34		protected $areImportsAutoApproved = false;
35
36		/**
37		* @param Client $client
38		* @param FileReader $fileReader
39		*/
40		public function __construct(Client $client, FileReader $fileReader)
41		{
42		parent::__construct($client);
43		$this->fileReader = $fileReader;
44		}
45
46		/**
47		* {@inheritdoc}
48		*/
49		public function execute()
50		{
51		if (0 === count($this->translations)) {
52		throw new InvalidArgumentException('There are no translations to upload.');
53		}
54
55		if (null === $this->locale) {
56		throw new InvalidArgumentException('Locale is not set.');
57		}
58
59		$path = sprintf(
60		"project/%s/upload-translation?key=%s",
61		$this->client->getProjectIdentifier(),
62		$this->client->getProjectApiKey()
63		);
64
65		$data[] = [
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-04-28 02:10 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
66		'name' => 'import_duplicates',
67		'contents' => (int)$this->areDuplicatesImported
68		];
69		$data[] = [
70		'name' => 'import_eq_suggestions',
71		'contents' => (int)$this->areEqualSuggestionsImported
72		];
73		$data[] = [
74		'name' => 'auto_approve_imported',
75		'contents' => (int)$this->areImportsAutoApproved
76		];
77		$data[] = [
78		'name' => 'language',
79		'contents' => $this->locale
80		];
81
82		foreach ($this->translations as $translation) {
83		$data[] = [
84		'name' => 'files['.$translation->getCrowdinPath().']',
85		'contents' => $this->fileReader->readTranslation($translation)
86		];
87		}
88
89		$data = ['multipart' => $data];
90		$response = $this->client->getHttpClient()->post($path, $data);
91
92		return $response->getBody();
93		}
94
95		/**
96		* @param string $localPath
97		* @param string $crowdinPath
98		* @param string $exportPattern
99		* @param string $title
100		*
101		* @return $this
102		*/
103	View Code Duplication	public function addTranslation($localPath, $crowdinPath, $exportPattern = null, $title = null)
		0 ignored issues – show Duplication introduced 2016-04-29 10:40 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		{
105		$translation = new Translation($localPath, $crowdinPath);
106		$translation->setExportPattern($exportPattern);
107		$translation->setTitle($title);
108
109		$this->translations[] = $translation;
110
111		return $this;
112		}
113
114		/**
115		* @param Translation[] $translations
116		* @return UploadTranslation
117		*/
118		public function setTranslations(array $translations)
119		{
120		$this->translations = $translations;
121
122		return $this;
123		}
124
125		/**
126		* @return Translation[]
127		*/
128		public function getTranslations()
129		{
130		return $this->translations;
131		}
132
133		/**
134		* @param bool $importsAutoApproved
135		*
136		* @throws InvalidArgumentException
137		*
138		* @return UploadTranslation
139		*/
140		public function setImportsAutoApproved($importsAutoApproved)
141		{
142		if (!is_bool($importsAutoApproved)) {
143		throw new InvalidArgumentException('A boolean is required.');
144		}
145
146		$this->areImportsAutoApproved = $importsAutoApproved;
147
148		return $this;
149		}
150
151		/**
152		* @return bool
153		*/
154		public function areImportsAutoApproved()
155		{
156		return $this->areImportsAutoApproved;
157		}
158
159		/**
160		* @param bool $duplicatesImported
161		*
162		* @throws InvalidArgumentException
163		*
164		* @return UploadTranslation
165		*/
166		public function setDuplicatesImported($duplicatesImported)
167		{
168		if (!is_bool($duplicatesImported)) {
169		throw new InvalidArgumentException('A boolean is required.');
170		}
171
172		$this->areDuplicatesImported = $duplicatesImported;
173
174		return $this;
175		}
176
177		/**
178		* @return bool
179		*/
180		public function areDuplicatesImported()
181		{
182		return $this->areDuplicatesImported;
183		}
184
185		/**
186		* @param bool $equalSuggestionsImported
187		*
188		* @throws InvalidArgumentException
189		*
190		* @return UploadTranslation
191		*/
192		public function setEqualSuggestionsImported($equalSuggestionsImported)
193		{
194		if (!is_bool($equalSuggestionsImported)) {
195		throw new InvalidArgumentException('A boolean is required.');
196		}
197
198		$this->areEqualSuggestionsImported = $equalSuggestionsImported;
199
200		return $this;
201		}
202
203		/**
204		* @return bool
205		*/
206		public function areEqualSuggestionsImported()
207		{
208		return $this->areEqualSuggestionsImported;
209		}
210
211		/**
212		* @param string $locale
213		*
214		* @return UploadTranslation
215		*/
216		public function setLocale($locale)
217		{
218		$this->locale = $locale;
219
220		return $this;
221		}
222
223		/**
224		* @return string
225		*/
226		public function getLocale()
227		{
228		return $this->locale;
229		}
230		}
231

akeneo / php-crowdin-api

Pull Request — master (#35)

UploadTranslation::getTranslations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like