Translation::getDomain() - Code Metrics - ongr-io/TranslationsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Translation::getDomain() A
last analyzed 2017-05-18 13:09 UTC

↳ Parent: Translation

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	1
cts	1
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	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\Document;

use ONGR\ElasticsearchBundle\Annotation as ES;
use ONGR\ElasticsearchBundle\Collection\Collection;

/**
 * Holds translations for certain domain.
 *
 * @ES\Document(type="translation")
 */
class Translation implements \JsonSerializable
{
    /**
     * @var string
     *
     * @ES\Id()
     */
    private $id;

    /**
     * @var string
     *
     * @ES\Property(type="keyword")
     */
    private $domain;

    /**
     * @var array
     *
     * @ES\Property(type="keyword")
     */
    private $tags = [];

    /**
     * @var Message[]
     *
     * @ES\Embedded(class="ONGRTranslationsBundle:Message", multiple=true)
     */
    private $messages = [];

    /**
     * @var string
     *
     * @ES\Property(type="keyword")
     */
    private $key;

    /**
     * @var string
     *
     * @ES\Property(type="keyword")
     */
    private $path;

    /**
     * @var string
     *
     * @ES\Property(type="text")
     */
    private $description;

    /**
     * @var string
     *
     * @ES\Property(type="text")
     */
    private $format;

    /**
     * @var \DateTime
     *
     * @ES\Property(type="date")
     */
    private $createdAt;

    /**
     * @var \DateTime
     *
     * @ES\Property(type="date")
     */
    private $updatedAt;

    /**
     * Sets timestamps.
     */
    public function __construct()
    {
        $this->messages = new Collection();

        $this->createdAt = new \DateTime();
        $this->updatedAt = new \DateTime();
    }

    /**
     * Sets document unique id.
     *
     * @param string $documentId
     *
     * @return $this
     */
    public function setId($documentId)
    {
        $this->id = $documentId;

        return $this;
    }

    /**
     * Returns document id.
     *
     * @return string
     */
    public function getId()
    {
        if (!$this->id) {
            $this->setId(sha1($this->getDomain() . $this->getKey()));
        }

        return $this->id;
    }

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

    /**
     * @param string $domain
     */
    public function setDomain($domain)
    {
        $this->domain = $domain;
    }

    /**
     * Sets tags.
     *
     * @param array|string $tags
     */
    public function setTags($tags)
    {
        if (is_string($tags)) {
            $tags = [$tags];
        }

        $this->tags = $tags;
    }

    /**
     * Returns all tags.
     *
     * @return array
     */
    public function getTags()
    {
        return $this->tags;
    }

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

    /**
     * @param string $key
     */
    public function setKey($key)
    {
        $this->key = $key;
    }

    /**
     * @param Message $message
     */
    public function addMessage(Message $message)
    {
        $this->messages[] = $message;
    }

    /**
     * @return Message[]
     */
    public function getMessages()
    {
        return $this->messages;
    }

    /**
     * @param Message[]|Collection $messages
     */
    public function setMessages(Collection $messages = null)
    {
        $this->messages = $messages;

    }

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

    /**
     * @param string $path
     */
    public function setPath($path)
    {
        $this->path = $path;
    }

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

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

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

    /**
     * @param string $format
     */
    public function setFormat($format)
    {
        $this->format = $format;
    }

    /**
     * @return \DateTime
     */
    public function getCreatedAt()
    {
        return $this->createdAt;
    }

    /**
     * @param \DateTime $createdAt
     */
    public function setCreatedAt($createdAt)
    {
        $this->createdAt = $createdAt;
    }

    /**
     * @return \DateTime
     */
    public function getUpdatedAt()
    {
        return $this->updatedAt;
    }

    /**
     * @param \DateTime $updatedAt
     */
    public function setUpdatedAt($updatedAt)
    {
        $this->updatedAt = $updatedAt;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return array_replace(
            array_diff_key(get_object_vars($this), array_flip(['score', 'parent', 'ttl', 'highlight'])),
            [
                'id' => $this->getId(),
                'messages' => $this->getMessagesArray(),
                'tags' => $this->getTags(),
                'description' => $this->getDescription(),
                'createdAt' => $this->getCreatedAt()->format('Y-m-d H:i:s'),
                'updatedAt' => $this->getUpdatedAt()->format('Y-m-d H:i:s'),
            ]
        );
    }

    /**
     * Returns messages as array.
     *
     * Format: ['locale' => 'message'].
     *
     * @return array
     */
    public function getMessagesArray()
    {
        $result = [];
        foreach ($this->getMessages() as $message) {
            $result[$message->getLocale()] = $message;
        }

        return $result;
    }

    /**
     * @param string $locale
     * @return Message|null
     */
    public function getMessageByLocale($locale)
    {
        foreach ($this->messages as $message) {
            if ($message->getLocale() == $locale) {
                return $message;
            }
        }

        return null;
    }
}


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\Document;
13
14		use ONGR\ElasticsearchBundle\Annotation as ES;
15		use ONGR\ElasticsearchBundle\Collection\Collection;
16
17		/**
18		* Holds translations for certain domain.
19		*
20		* @ES\Document(type="translation")
21		*/
22		class Translation implements \JsonSerializable
23		{
24		/**
25		* @var string
26		*
27		* @ES\Id()
28		*/
29		private $id;
30
31		/**
32		* @var string
33		*
34		* @ES\Property(type="keyword")
35		*/
36		private $domain;
37
38		/**
39		* @var array
40		*
41		* @ES\Property(type="keyword")
42		*/
43		private $tags = [];
44
45		/**
46		* @var Message[]
47		*
48		* @ES\Embedded(class="ONGRTranslationsBundle:Message", multiple=true)
49		*/
50		private $messages = [];
51
52		/**
53		* @var string
54		*
55		* @ES\Property(type="keyword")
56		*/
57		private $key;
58
59		/**
60		* @var string
61		*
62		* @ES\Property(type="keyword")
63		*/
64		private $path;
65
66		/**
67		* @var string
68		*
69		* @ES\Property(type="text")
70		*/
71		private $description;
72
73		/**
74		* @var string
75		*
76		* @ES\Property(type="text")
77		*/
78		private $format;
79
80		/**
81		* @var \DateTime
82		*
83	4	* @ES\Property(type="date")
84		*/
85	4	private $createdAt;
86	4
87	4	/**
88		* @var \DateTime
89		*
90		* @ES\Property(type="date")
91		*/
92	4	private $updatedAt;
93
94	4	/**
95		* Sets timestamps.
96		*/
97		public function __construct()
98		{
99		$this->messages = new Collection();
		0 ignored issues – show Documentation Bug introduced 2016-03-16 15:15 UTC by Report Bug Copy Issue Report It seems like `new \ONGR\ElasticsearchB...Collection\Collection()` of type `object<ONGR\Elasticsearc...\Collection\Collection>` is incompatible with the declared type `array<integer,object<ONG...ndle\Document\Message>>` of property `$messages`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history... Deprecated Code introduced 2017-05-04 09:16 UTC by Report Bug Copy Issue Report The class `ONGR\ElasticsearchBundle\Collection\Collection` has been deprecated with message: Use Doctrine\Common\Collections\ArrayCollection instead. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
100	4	$this->createdAt = new \DateTime();
101		$this->updatedAt = new \DateTime();
102	4	}
103	4
104		/**
105		* Sets document unique id.
106		*
107		* @param string $documentId
108		*
109		* @return $this
110		*/
111		public function setId($documentId)
112		{
113		$this->id = $documentId;
114
115		return $this;
116		}
117
118		/**
119		* Returns document id.
120	2	*
121		* @return string
122	2	*/
123		public function getId()
124		{
125		if (!$this->id) {
126		$this->setId(sha1($this->getDomain() . $this->getKey()));
127		}
128
129		return $this->id;
130		}
131
132		/**
133		* @return string
134		*/
135		public function getDomain()
136		{
137		return $this->domain;
138	4	}
139
140	4	/**
141		* @param string $domain
142		*/
143		public function setDomain($domain)
144		{
145		$this->domain = $domain;
146	3	}
147
148	3	/**
149	3	* Sets tags.
150		*
151		* @param array\|string $tags
152		*/
153		public function setTags($tags)
154		{
155		if (is_string($tags)) {
156	1	$tags = [$tags];
157		}
158	1
159	1	$this->tags = $tags;
160		}
161
162	1	/**
163		* Returns all tags.
164		*
165		* @return array
166		*/
167		public function getTags()
168	4	{
169		return $this->tags;
170	4	}
171	4
172		/**
173		* @return string
174		*/
175		public function getKey()
176	4	{
177		return $this->key;
178	4	}
179
180		/**
181		* @param string $key
182		*/
183		public function setKey($key)
184	1	{
185		$this->key = $key;
186	1	}
187	1
188		/**
189		* @param Message $message
190		*/
191		public function addMessage(Message $message)
192	3	{
193		$this->messages[] = $message;
194	3	}
195
196		/**
197		* @return Message[]
198		*/
199		public function getMessages()
200	3	{
201		return $this->messages;
202	3	}
203	3
204		/**
205		* @param Message[]\|Collection $messages
206		*/
207		public function setMessages(Collection $messages = null)
208	3	{
209		$this->messages = $messages;
		0 ignored issues – show Documentation Bug introduced 2016-03-16 15:15 UTC by Report Bug Copy Issue Report It seems like `$messages` of type `null` or `object<ONGR\Elasticsearc...\Collection\Collection>` is incompatible with the declared type `array<integer,object<ONG...ndle\Document\Message>>` of property `$messages`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
210	3	}
211
212		/**
213		* @return string
214		*/
215		public function getPath()
216	3	{
217		return $this->path;
218	3	}
219	3
220		/**
221		* @param string $path
222		*/
223		public function setPath($path)
224	3	{
225		$this->path = $path;
226	3	}
227
228		/**
229		* @return string
230		*/
231		public function getDescription()
232	1	{
233		return $this->description;
234	1	}
235	1
236		/**
237		* @param string $description
238		*/
239		public function setDescription($description)
240	3	{
241		$this->description = $description;
242	3	}
243
244		/**
245		* @return string
246		*/
247		public function getFormat()
248	1	{
249		return $this->format;
250	1	}
251	1
252		/**
253		* @param string $format
254		*/
255		public function setFormat($format)
256	1	{
257		$this->format = $format;
258	1	}
259	1
260		/**
261	1	* @return \DateTime
262	1	*/
263	1	public function getCreatedAt()
264	1	{
265	1	return $this->createdAt;
266		}
267
268		/**
269		* @param \DateTime $createdAt
270		*/
271		public function setCreatedAt($createdAt)
272		{
273		$this->createdAt = $createdAt;
274		}
275
276		/**
277	1	* @return \DateTime
278		*/
279	1	public function getUpdatedAt()
280	1	{
281	1	return $this->updatedAt;
282		}
283
284	1	/**
285		* @param \DateTime $updatedAt
286		*/
287		public function setUpdatedAt($updatedAt)
288		{
289		$this->updatedAt = $updatedAt;
290		}
291
292	1	/**
293		* {@inheritdoc}
294	1	*/
295		public function jsonSerialize()
296		{
297		return array_replace(
298	1	array_diff_key(get_object_vars($this), array_flip(['score', 'parent', 'ttl', 'highlight'])),
299	1	[
300		'id' => $this->getId(),
301		'messages' => $this->getMessagesArray(),
302		'tags' => $this->getTags(),
303	1	'description' => $this->getDescription(),
304		'createdAt' => $this->getCreatedAt()->format('Y-m-d H:i:s'),
305		'updatedAt' => $this->getUpdatedAt()->format('Y-m-d H:i:s'),
306		]
307		);
308		}
309
310		/**
311		* Returns messages as array.
312		*
313		* Format: ['locale' => 'message'].
314		*
315		* @return array
316		*/
317		public function getMessagesArray()
318		{
319		$result = [];
320		foreach ($this->getMessages() as $message) {
321		$result[$message->getLocale()] = $message;
322		}
323
324		return $result;
325		}
326
327		/**
328		* @param string $locale
329		* @return Message\|null
330		*/
331		public function getMessageByLocale($locale)
332		{
333		foreach ($this->messages as $message) {
334		if ($message->getLocale() == $locale) {
335		return $message;
336		}
337		}
338
339		return null;
340		}
341		}
342

ongr-io / TranslationsBundle

Translation::getDomain() A last analyzed 2017-05-18 13:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Translation::getDomain() A
last analyzed 2017-05-18 13:09 UTC