<?php
/**
 * @copyright Copyright (C) 2005 eZ systems as. All rights reserved.
 * @license http://ez.no/licenses/new_bsd New BSD License
 * @version 1.0beta1
 * @filesource
 * @package Translation
 */
/**
 * A container to store one translatable string
 *
 * This struct is used in various classes to store the data accompanying one
 * translatable string.
 *
 * @package Translation
 */
class ezcTranslationData
{
    /**
     * Used when the translated string is up-to-date
     */
    const TRANSLATED = 0;

    /**
     * Used when a translated string has not been translated yet.
     */
    const UNFINISHED = 1;

    /**
     * Used when a translated string is obsolete.
     */
    const OBSOLETE = 2;
       
    /**
     * @var string The original string.
     */
    public $original;
       
    /**
     * @var string The translated string.
     */
    public $translation;

    /**
     * @var string Comment about the translated string.
     */
    public $comment;
       
    /**
     * @var integer The status, which is one of the three constants from above
     */
    public $status;

    /**
     * Constructs an ezcTranslationData object
     *
     * Constructs an ezcTranslationData object with the four elements that make up this struct.
     */
    function __construct( $original, $translation, $comment, $status )
    {
        $this->original = $original;
        $this->translation = $translation;
        $this->comment = $comment;
        $this->status = $status;
    }

    static public function __set_state( array $array )
    {
        return new ezcTranslationData( $array['original'], $array['translation'], $array['comment'], $array['status'] );
    }
}
?>