Magneds / php-lokalise

src/TranslateString/Entity/TranslateStringPartial.php

<?php // Copyright ⓒ 2018 Magneds IP B.V. - All Rights Reserved
namespace Magneds\Lokalise\TranslateString\Entity;

use Magneds\Lokalise\Language\Entity\Language;

class TranslateStringPartial
{
    /**
     * @var string
     */
    protected $key;

    /**
     * @var int|null
     */
    protected $platformMask;

    /**
     * @var string|null
     */
    protected $description;

    /**
     * @var string[]
     */
    protected $tags = [];

    /**
     * @var string[]
     */
    protected $translations = [];

    /**
     * TranslateStringPartial constructor.
     * @param string $key
     */
    public function __construct(string $key)
    {
        $this->key = $key;
    }

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

    /**
     * @return int|null
     */
    public function getPlatformMask()
    {
        return $this->platformMask;
    }

    /**
     * @param int $platformMask
     * @return $this
     */
    public function setPlatformMask($platformMask)
    {
        $this->platformMask = (int)$platformMask;
        return $this;
    }

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

The expression return $this->description could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

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

    /**
     * @return string[]
     */
    public function getTags(): array
    {
        return $this->tags;
    }

    /**
     * @param string[] $tags
     * @return $this
     */
    public function setTags(array $tags)
    {
        $this->tags = (array)$tags;
        return $this;
    }

    /**
     * @param $tag
     * @return $this
     */
    public function addTag(string $tag)
    {
        if (in_array($tag, $this->tags)) {
            return $this;
        }
        $this->tags[] = $tag;

        return $this;
    }

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

    public function addTranslation(Language $language, $translation)
    {
        $isoLang = $language->getIso();
        $this->translations[$isoLang] = $translation;
    }

    public function toArray()
    {
        $data = [
            'key' => $this->key,
            'platform_mask' => $this->platformMask,
            'description' => $this->description,
            'tags' => $this->tags,
            'translations' => $this->translations
        ];

        return array_filter($data);
    }

    public static function buildFromTranslateString(TranslateString $translateString)
    {
        $partial = new self($translateString->getKey());
        $partial->setPlatformMask($translateString->getPlatformMask());
        $partial->setTags($translateString->getTags());

        return $partial;
    }
}