UploadTranslation::execute() - Code Metrics - akeneo/php-crowdin-api - Measure and Improve Code Quality continuously with Scrutinizer

UploadTranslation::execute() B
last analyzed 2016-11-18 13:56 UTC

↳ Parent: UploadTranslation

Complexity

Conditions	5
Paths	6

Size

Total Lines	54
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	54
rs	8.7449
c	0
b	0
f	0
cc	5
eloc	33
nc	6
nop	0

How to fix Long Method

<?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.com/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;
    
    /** @var string */
    protected $branch;

    /**
     * @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.');
        }

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

        $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
        ];
        
        if (null !== $this->branch) {
            $data[] = [
                'name'      => 'branch',
                'contents'  => $this->branch
            ];
        }

        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;
    }

    /**
     * @return string|null
     */
    public function getBranch()
    {
        return $this->branch;
    }

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

        return $this;
    }
}


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.com/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		/** @var string */
37		protected $branch;
38
39		/**
40		* @param Client $client
41		* @param FileReader $fileReader
42		*/
43		public function __construct(Client $client, FileReader $fileReader)
44		{
45		parent::__construct($client);
46		$this->fileReader = $fileReader;
47		}
48
49		/**
50		* {@inheritdoc}
51		*/
52		public function execute()
53		{
54		if (0 === count($this->translations)) {
55		throw new InvalidArgumentException('There are no translations to upload.');
56		}
57
58		if (null === $this->locale) {
59		throw new InvalidArgumentException('Locale is not set.');
60		}
61
62		$this->addUrlParameter('key', $this->client->getProjectApiKey());
63
64		$path = sprintf(
65		"project/%s/upload-translation?%s",
66		$this->client->getProjectIdentifier(),
67		$this->getUrlQueryString()
68		);
69
70		$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...
71		'name' => 'import_duplicates',
72		'contents' => (int)$this->areDuplicatesImported
73		];
74		$data[] = [
75		'name' => 'import_eq_suggestions',
76		'contents' => (int)$this->areEqualSuggestionsImported
77		];
78		$data[] = [
79		'name' => 'auto_approve_imported',
80		'contents' => (int)$this->areImportsAutoApproved
81		];
82		$data[] = [
83		'name' => 'language',
84		'contents' => $this->locale
85		];
86
87		if (null !== $this->branch) {
88		$data[] = [
89		'name' => 'branch',
90		'contents' => $this->branch
91		];
92		}
93
94		foreach ($this->translations as $translation) {
95		$data[] = [
96		'name' => 'files['.$translation->getCrowdinPath().']',
97		'contents' => $this->fileReader->readTranslation($translation)
98		];
99		}
100
101		$data = ['multipart' => $data];
102		$response = $this->client->getHttpClient()->post($path, $data);
103
104		return $response->getBody();
105		}
106
107		/**
108		* @param string $localPath
109		* @param string $crowdinPath
110		* @param string $exportPattern
111		* @param string $title
112		*
113		* @return $this
114		*/
115	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...
116		{
117		$translation = new Translation($localPath, $crowdinPath);
118		$translation->setExportPattern($exportPattern);
119		$translation->setTitle($title);
120
121		$this->translations[] = $translation;
122
123		return $this;
124		}
125
126		/**
127		* @param Translation[] $translations
128		* @return UploadTranslation
129		*/
130		public function setTranslations(array $translations)
131		{
132		$this->translations = $translations;
133
134		return $this;
135		}
136
137		/**
138		* @return Translation[]
139		*/
140		public function getTranslations()
141		{
142		return $this->translations;
143		}
144
145		/**
146		* @param bool $importsAutoApproved
147		*
148		* @throws InvalidArgumentException
149		*
150		* @return UploadTranslation
151		*/
152		public function setImportsAutoApproved($importsAutoApproved)
153		{
154		if (!is_bool($importsAutoApproved)) {
155		throw new InvalidArgumentException('A boolean is required.');
156		}
157
158		$this->areImportsAutoApproved = $importsAutoApproved;
159
160		return $this;
161		}
162
163		/**
164		* @return bool
165		*/
166		public function areImportsAutoApproved()
167		{
168		return $this->areImportsAutoApproved;
169		}
170
171		/**
172		* @param bool $duplicatesImported
173		*
174		* @throws InvalidArgumentException
175		*
176		* @return UploadTranslation
177		*/
178		public function setDuplicatesImported($duplicatesImported)
179		{
180		if (!is_bool($duplicatesImported)) {
181		throw new InvalidArgumentException('A boolean is required.');
182		}
183
184		$this->areDuplicatesImported = $duplicatesImported;
185
186		return $this;
187		}
188
189		/**
190		* @return bool
191		*/
192		public function areDuplicatesImported()
193		{
194		return $this->areDuplicatesImported;
195		}
196
197		/**
198		* @param bool $equalSuggestionsImported
199		*
200		* @throws InvalidArgumentException
201		*
202		* @return UploadTranslation
203		*/
204		public function setEqualSuggestionsImported($equalSuggestionsImported)
205		{
206		if (!is_bool($equalSuggestionsImported)) {
207		throw new InvalidArgumentException('A boolean is required.');
208		}
209
210		$this->areEqualSuggestionsImported = $equalSuggestionsImported;
211
212		return $this;
213		}
214
215		/**
216		* @return bool
217		*/
218		public function areEqualSuggestionsImported()
219		{
220		return $this->areEqualSuggestionsImported;
221		}
222
223		/**
224		* @param string $locale
225		*
226		* @return UploadTranslation
227		*/
228		public function setLocale($locale)
229		{
230		$this->locale = $locale;
231
232		return $this;
233		}
234
235		/**
236		* @return string
237		*/
238		public function getLocale()
239		{
240		return $this->locale;
241		}
242
243		/**
244		* @return string\|null
245		*/
246		public function getBranch()
247		{
248		return $this->branch;
249		}
250
251		/**
252		* @param string $branch
253		*
254		* @return UploadTranslation
255		*/
256		public function setBranch($branch)
257		{
258		$this->branch = $branch;
259
260		return $this;
261		}
262		}
263

akeneo / php-crowdin-api

UploadTranslation::execute() B last analyzed 2016-11-18 13:56 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

UploadTranslation::execute() B
last analyzed 2016-11-18 13:56 UTC