Translation.php

<?php

namespace Liip\TranslationBundle\Model;

/**
 * Representation of a translation element.
 *
 * This file is part of the LiipTranslationBundle. For more information concerning
 * the bundle, see the README.md file at the project root.
 *
 * @version 0.0.1
 *
 * @license http://opensource.org/licenses/MIT MIT License
 * @author David Jeanmonod <david.jeanmonod@liip.ch>
 * @author Gilles Crettenand <gilles.crettenand@liip.ch>
 * @author Sylvain Fankhauser <sylvain.fankhauser@liip.ch>
 * @copyright Copyright (c) 2013, Liip, http://www.liip.ch
 */
class Translation extends Persistent
{
    /** @var string */
    private $value;
    /** @var string */
    private $locale;
    /** @var Unit */
    private $unit;
    /** @var array */
    private $metadata;

    /**
     * @param string $value    value (ie translation)
     * @param string $locale   locale
     * @param Unit   $unit     unit related to this translation
     * @param array  $metadata
     */
    public function __construct($value, $locale, Unit $unit, array $metadata = array())
    {
        $this->value = $value;
        $this->locale = $locale;
        $this->unit = $unit;
        $this->metadata = $metadata;
    }

    /**
     * Mark this translation as deleted (will be remove at the next persist).
     */
    public function delete()
    {
        $this->setIsDeleted();
    }

    /**
     * @param array $m the new metadata
     */
    public function setMetadata(array $m = array())
    {
        $this->metadata = $m;
    }

    /**
     * @return array metadata as array
     */
    public function getMetadata()
    {
        return $this->metadata;
    }

    public function getValue()
    {
        return $this->value;
    }

    public function setValue($t)
    {
        $this->value = $t;

        $this->setIsModified(true);
    }

    public function getModificationDate()
    {
        // TODO fetch from the metadata
        return '-';
    }

    public function getLocale()
    {
        return $this->locale;
    }

    public function getUnit()
    {
        return $this->unit;
    }

    public function getKey()
    {
        return $this->getUnit()->getKey();
    }

    public function getDomain()
    {
        return $this->getUnit()->getDomain();
    }

    public function __toString()
    {
        return $this->getValue();
    }
}