TranslationManager::getAll() - Code Metrics - Inspection of "Merge branch 'export'" - ongr-io/TranslationsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 298f7d...b54616 )

by Simonas

created 2017-03-29 08:41 UTC

TranslationManager::getAll() A

↳ Parent: TranslationManager

Complexity

Conditions	3
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	8
nc	2
nop	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\TranslationsBundle\Service;

use ONGR\ElasticsearchBundle\Result\DocumentIterator;
use ONGR\ElasticsearchDSL\Aggregation\Bucketing\TermsAggregation;
use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
use ONGR\ElasticsearchDSL\Query\TermLevel\TermsQuery;
use ONGR\ElasticsearchBundle\Service\Repository;
use ONGR\TranslationsBundle\Document\Message;
use ONGR\TranslationsBundle\Document\Translation;
use ONGR\TranslationsBundle\Event\Events;
use ONGR\TranslationsBundle\Event\MessageUpdateEvent;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Handles translation objects by http requests.
 */
class TranslationManager
{
    /**
     * @var Repository
     */
    private $repository;

    /**
     * @var HistoryManager
     */
    private $historyManager;

    /**
     * @var EventDispatcherInterface
     */
    private $dispatcher;

    /**
     * @param Repository               $repository Translation repository service.
     * @param HistoryManager           $manager    History manager service.
     * @param EventDispatcherInterface $dispatcher
     */
    public function __construct(Repository $repository, HistoryManager $manager, EventDispatcherInterface $dispatcher)
    {
        $this->repository = $repository;
        $this->historyManager = $manager;
        $this->dispatcher = $dispatcher;
    }

    /**
     * Edits object from translation.
     *
     * @param string $id
     * @param Request $request Http request object.
     */
    public function edit($id, Request $request)
    {
        $content = json_decode($request->getContent(), true);

        if (empty($content)) {
            return;
        }

        $document = $this->get($id);

        if (isset($content['messages'])) {
            $this->updateMessages($document, $content['messages']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            unset($content['messages']);
        }

        try {
            foreach ($content as $key => $value) {
                $document->{'set'.ucfirst($key)}($value);
            }

            $document->setUpdatedAt(new \DateTime());
        } catch (\Exception $e) {
            throw new \LogicException('Illegal variable provided for translation');
        }

        $this->repository->getManager()->persist($document);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $this->repository->getManager()->commit();
    }

    /**
     * Returns all active tags from translations
     * @return array
     */
    public function getTags()
    {
        return $this->getGroupTypeInfo('tags');
    }

    /**
     * Returns all active domains from translations
     * @return array
     */
    public function getDomains()
    {
        return $this->getGroupTypeInfo('domain');
    }

    /**
     * @param string $id
     *
     * @return Translation|object
     */
    public function get($id)
    {
        return $this->repository->find($id);
    }

    /**
     * Returns all translations if filters are not specified
     *
     * @param array $filters An array with specified limitations for results
     *
     * @return DocumentIterator
     */
    public function getAll(array $filters = null)
    {
        $search = $this->repository->createSearch();
        $search->addQuery(new MatchAllQuery());
        $search->setScroll('2m');

        if ($filters) {
            foreach ($filters as $field => $value) {
                $search->addQuery(new TermsQuery($field, $value));
            }
        }

        return $this->repository->findDocuments($search);
    }

    /**
     * @param Translation[] $translations
     */
    public function save($translations)
    {
        foreach ($translations as $translation) {
            $this->repository->getManager()->persist($translation);
        }

        $this->repository->getManager()->commit();
    }

    /**
     * @param Translation $document
     * @param array $messages
     */
    private function updateMessages(Translation $document, array $messages)
    {
        $setMessagesLocales = array_keys($document->getMessagesArray());
        $documentMessages = $document->getMessages();

        foreach ($messages as $locale => $messageText) {
            if (!empty($messageText) && is_string($messageText)) {
                $this->dispatcher->dispatch(
                    Events::ADD_HISTORY,
                    new MessageUpdateEvent($document, $locale)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                );

                if (in_array($locale, $setMessagesLocales)) {
                    foreach ($documentMessages as $message) {
                        if ($message->getLocale() == $locale && $message->getMessage() != $messageText) {
                            $this->historyManager->addHistory($message, $document);
                            $this->updateMessageData($message, $locale, $messages[$locale], new \DateTime());
                            break;
                        }
                    }
                } else {
                    $documentMessages[] = $this->updateMessageData(new Message(), $locale, $messageText);
                }
            }
        }

        $document->setMessages($documentMessages);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param Message   $message
     * @param string    $locale
     * @param string    $text
     * @param \DateTime $updatedAt
     *
     * @return Message
     */
    private function updateMessageData(Message $message, $locale, $text, $updatedAt = null)
    {
        $message->setLocale($locale);
        $message->setStatus(Message::DIRTY);
        $message->setMessage($text);

        if ($updatedAt) {
            $message->setUpdatedAt($updatedAt);
        }

        return $message;
    }

    /**
     * Returns a list of available tags or domains.
     *
     * @param string $type
     *
     * @return array
     */
    private function getGroupTypeInfo($type)
    {
        $search = $this->repository->createSearch();
        $search->addAggregation(new TermsAggregation($type, $type));
        $result = $this->repository->findDocuments($search);
        $aggregation = $result->getAggregation($type);
        $items = [];

        foreach ($aggregation as $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $items[] = $item['key'];
        }

        return $items;
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\TranslationsBundle\Service;
13
14			use ONGR\ElasticsearchBundle\Result\DocumentIterator;
15			use ONGR\ElasticsearchDSL\Aggregation\Bucketing\TermsAggregation;
16			use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
17			use ONGR\ElasticsearchDSL\Query\TermLevel\TermsQuery;
18			use ONGR\ElasticsearchBundle\Service\Repository;
19			use ONGR\TranslationsBundle\Document\Message;
20			use ONGR\TranslationsBundle\Document\Translation;
21			use ONGR\TranslationsBundle\Event\Events;
22			use ONGR\TranslationsBundle\Event\MessageUpdateEvent;
23			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
24			use Symfony\Component\HttpFoundation\Request;
25
26			/**
27			* Handles translation objects by http requests.
28			*/
29			class TranslationManager
30			{
31			/**
32			* @var Repository
33			*/
34			private $repository;
35
36			/**
37			* @var HistoryManager
38			*/
39			private $historyManager;
40
41			/**
42			* @var EventDispatcherInterface
43			*/
44			private $dispatcher;
45
46			/**
47			* @param Repository $repository Translation repository service.
48			* @param HistoryManager $manager History manager service.
49			* @param EventDispatcherInterface $dispatcher
50			*/
51			public function __construct(Repository $repository, HistoryManager $manager, EventDispatcherInterface $dispatcher)
52			{
53			$this->repository = $repository;
54			$this->historyManager = $manager;
55			$this->dispatcher = $dispatcher;
56			}
57
58			/**
59			* Edits object from translation.
60			*
61			* @param string $id
62			* @param Request $request Http request object.
63			*/
64			public function edit($id, Request $request)
65			{
66			$content = json_decode($request->getContent(), true);
67
68			if (empty($content)) {
69			return;
70			}
71
72			$document = $this->get($id);
73
74			if (isset($content['messages'])) {
75			$this->updateMessages($document, $content['messages']);
			0 ignored issues – show Documentation introduced 2016-11-04 08:52 UTC by Report Bug Copy Issue Report `$document` is of type `null\|object<ReflectionClass>`, but the function expects a `object<ONGR\Translations...e\Document\Translation>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
76			unset($content['messages']);
77			}
78
79			try {
80			foreach ($content as $key => $value) {
81			$document->{'set'.ucfirst($key)}($value);
82			}
83
84			$document->setUpdatedAt(new \DateTime());
85			} catch (\Exception $e) {
86			throw new \LogicException('Illegal variable provided for translation');
87			}
88
89			$this->repository->getManager()->persist($document);
			0 ignored issues – show Bug introduced 2016-11-16 10:40 UTC by Report Bug Copy Issue Report It seems like `$document` defined by `$this->get($id)` on line `72` can be `null`; however, `ONGR\ElasticsearchBundle...vice\Manager::persist()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
90			$this->repository->getManager()->commit();
91			}
92
93			/**
94			* Returns all active tags from translations
95			* @return array
96			*/
97			public function getTags()
98			{
99			return $this->getGroupTypeInfo('tags');
100			}
101
102			/**
103			* Returns all active domains from translations
104			* @return array
105			*/
106			public function getDomains()
107			{
108			return $this->getGroupTypeInfo('domain');
109			}
110
111			/**
112			* @param string $id
113			*
114			* @return Translation\|object
115			*/
116			public function get($id)
117			{
118			return $this->repository->find($id);
119			}
120
121			/**
122			* Returns all translations if filters are not specified
123			*
124			* @param array $filters An array with specified limitations for results
125			*
126			* @return DocumentIterator
127			*/
128			public function getAll(array $filters = null)
129			{
130			$search = $this->repository->createSearch();
131			$search->addQuery(new MatchAllQuery());
132			$search->setScroll('2m');
133
134			if ($filters) {
135			foreach ($filters as $field => $value) {
136			$search->addQuery(new TermsQuery($field, $value));
137			}
138			}
139
140			return $this->repository->findDocuments($search);
141			}
142
143			/**
144			* @param Translation[] $translations
145			*/
146			public function save($translations)
147			{
148			foreach ($translations as $translation) {
149			$this->repository->getManager()->persist($translation);
150			}
151
152			$this->repository->getManager()->commit();
153			}
154
155			/**
156			* @param Translation $document
157			* @param array $messages
158			*/
159			private function updateMessages(Translation $document, array $messages)
160			{
161			$setMessagesLocales = array_keys($document->getMessagesArray());
162			$documentMessages = $document->getMessages();
163
164			foreach ($messages as $locale => $messageText) {
165			if (!empty($messageText) && is_string($messageText)) {
166			$this->dispatcher->dispatch(
167			Events::ADD_HISTORY,
168			new MessageUpdateEvent($document, $locale)
			0 ignored issues – show Documentation introduced 2017-03-29 09:44 UTC by Report Bug Copy Issue Report `$locale` is of type `integer\|string`, but the function expects a `object<ONGR\TranslationsBundle\Document\Message>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
169			);
170
171			if (in_array($locale, $setMessagesLocales)) {
172			foreach ($documentMessages as $message) {
173			if ($message->getLocale() == $locale && $message->getMessage() != $messageText) {
174			$this->historyManager->addHistory($message, $document);
175			$this->updateMessageData($message, $locale, $messages[$locale], new \DateTime());
176			break;
177			}
178			}
179			} else {
180			$documentMessages[] = $this->updateMessageData(new Message(), $locale, $messageText);
181			}
182			}
183			}
184
185			$document->setMessages($documentMessages);
			0 ignored issues – show Documentation introduced 2016-11-04 08:52 UTC by Report Bug Copy Issue Report `$documentMessages` is of type `array<integer,object<ONG...ndle\Document\Message>>`, but the function expects a `null\|object<ONGR\Elastic...\Collection\Collection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
186			}
187
188			/**
189			* @param Message $message
190			* @param string $locale
191			* @param string $text
192			* @param \DateTime $updatedAt
193			*
194			* @return Message
195			*/
196			private function updateMessageData(Message $message, $locale, $text, $updatedAt = null)
197			{
198			$message->setLocale($locale);
199			$message->setStatus(Message::DIRTY);
200			$message->setMessage($text);
201
202			if ($updatedAt) {
203			$message->setUpdatedAt($updatedAt);
204			}
205
206			return $message;
207			}
208
209			/**
210			* Returns a list of available tags or domains.
211			*
212			* @param string $type
213			*
214			* @return array
215			*/
216			private function getGroupTypeInfo($type)
217			{
218			$search = $this->repository->createSearch();
219			$search->addAggregation(new TermsAggregation($type, $type));
220			$result = $this->repository->findDocuments($search);
221			$aggregation = $result->getAggregation($type);
222			$items = [];
223
224			foreach ($aggregation as $item) {
			0 ignored issues – show Bug introduced 2016-11-04 08:52 UTC by Report Bug Copy Issue Report The expression `$aggregation` of type `null\|object<ONGR\Elastic...ation\AggregationValue>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
225			$items[] = $item['key'];
226			}
227
228			return $items;
229			}
230			}
231

ongr-io / TranslationsBundle

Push — master ( 298f7d...b54616 )

TranslationManager::getAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like