ONGR\TranslationsBundle\Document\Translation

Complexity

Total Complexity

31

Size/Duplication

Total Lines	322
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

89.19%

Importance

Changes	16
Bugs	3	Features	7

25 Methods

Rating	Name	Duplication	Size	Complexity
A	setTags()	0	4	1
A	getTags()	0	4	1
A	addTag()	0	4	1
A	getKey()	0	4	1
A	setKey()	0	4	1
A	addMessage()	0	4	1
A	getPath()	0	4	1
A	setPath()	0	4	1
A	getFormat()	0	4	1
A	setFormat()	0	4	1
A	getCreatedAt()	0	4	1
A	setCreatedAt()	0	4	1
A	getUpdatedAt()	0	4	1
A	__construct()	0	7	1
A	setId()	0	6	1
A	getId()	0	8	2
A	getDomain()	0	4	1
A	setDomain()	0	4	1
A	getMessages()	0	4	1
A	setMessages()	0	4	1
A	hasMessage()	0	9	3
A	setUpdatedAt()	0	4	1
A	jsonSerialize()	0	13	1
A	getMessagesArray()	0	9	2
A	getTagsArray()	0	13	3

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * 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="string", options={"index"="not_analyzed"})
     */
    private $domain;

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

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

    /**
     * @var string
     *
     * @ES\Property(type="string", options={"index"="not_analyzed"})
     */
    private $key;

    /**
     * @var string
     *
     * @ES\Property(type="string", options={"index"="not_analyzed"})
     */
    private $path;

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

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

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

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

It seems like new \ONGR\ElasticsearchBundle\Collection\Collection() of type object<ONGR\ElasticsearchBundle\Collection\Collection> is incompatible with the declared type array<integer,object<ONGR\TranslationsBundle\Document\Tag>> of property $tags.

        $this->messages = new Collection();

It seems like new \ONGR\ElasticsearchBundle\Collection\Collection() of type object<ONGR\ElasticsearchBundle\Collection\Collection> is incompatible with the declared type array<integer,object<ONGR\TranslationsBundle\Document\Message>> of property $messages.

        $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 Tag[]|Collection $tags
     */
    public function setTags(Collection $tags = null)
    {
        $this->tags = $tags;

It seems like $tags of type null or object<ONGR\ElasticsearchBundle\Collection\Collection> is incompatible with the declared type array<integer,object<ONGR\TranslationsBundle\Document\Tag>> of property $tags.

    }

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

    /**
     * Adds a single tag.
     *
     * @param Tag $tag
     */
    public function addTag($tag)
    {
        $this->tags[] = $tag;
    }

    /**
     * @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;

It seems like $messages of type null or object<ONGR\ElasticsearchBundle\Collection\Collection> is incompatible with the declared type array<integer,object<ONGR\TranslationsBundle\Document\Message>> of property $messages.

    }

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

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

    /**
     * @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 string $locale
     *
     * @return bool
     */
    public function hasMessage($locale)
    {
        foreach ($this->messages as $message) {
            if ($message->getLocale() == $locale) {
                return true;
            }
        }
        return false;
    }

    /**
     * @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->getTagsArray(),
                '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
     */
    private function getMessagesArray()
    {
        $result = [];
        foreach ($this->getMessages() as $message) {
            $result[$message->getLocale()] = $message;
        }

        return $result;
    }

    /**
     * Returns tags array.
     *
     * @return array
     */
    private function getTagsArray()
    {
        if ($this->tags === null) {
            return [];
        }

        $result = [];
        foreach ($this->tags as $tag) {
            $result[] = $tag->getName();
        }

        return $result;
    }
}