<?php

/**
 * This file is part of the POMO package.
 *
 * @copyright 2014 POMO
 * @license GPL
 */

namespace POMO\Translations;

/**
 * EntryTranslations class encapsulates a translatable string.
 */
#[AllowDynamicProperties]
class EntryTranslations
{
    /**
     * Whether the entry contains a string and its plural form, default is false.
     *
     * @var bool
     */
    public $is_plural = false;

    public $context             = null;
    public $singular            = null;
    public $plural              = null;
    public $translations        = array();
    public $translator_comments = '';
    public $extracted_comments  = '';
    public $references          = array();
    public $flags               = array();

    /**
     * @param array $args {
     *     Arguments array, supports the following keys:
     *
     *     @type string $singular            The string to translate, if omitted an
     *                                       empty entry will be created.
     *     @type string $plural              The plural form of the string, setting
     *                                       this will set `$is_plural` to true.
     *     @type array  $translations        Translations of the string and possibly
     *                                       its plural forms.
     *     @type string $context             A string differentiating two equal strings
     *                                       used in different contexts.
     *     @type string $translator_comments Comments left by translators.
     *     @type string $extracted_comments  Comments left by developers.
     *     @type array  $references          Places in the code this string is used, in
     *                                       relative_to_root_path/file.php:linenum form.
     *     @type array  $flags               Flags like php-format.
     * }
     */
    public function __construct($args = array())
    {
        // If no singular -- empty object.
        if (! isset($args['singular'])) {
            return;
        }
        // Get member variable values from args hash.
        foreach ($args as $varname => $value) {
            $this->$varname = $value;
        }
        if (isset($args['plural']) && $args['plural']) {
            $this->is_plural = true;
        }
        if (! is_array($this->translations)) {
            $this->translations = array();
        }
        if (! is_array($this->references)) {
            $this->references = array();
        }
        if (! is_array($this->flags)) {
            $this->flags = array();
        }
    }

    /**
     * Generates a unique key for this entry.
     *
     * @return string|false The key or false if the entry is null.
     */
    public function key()
    {
        if (null === $this->singular) {
            return false;
        }

        // Prepend context and EOT, like in MO files.
        $key = ! $this->context ? $this->singular : $this->context . "\4" . $this->singular;
        // Standardize on \n line endings.
        $key = str_replace(array( "\r\n", "\r" ), "\n", $key);

        return $key;
    }

    /**
     * @param object $other
     */
    public function merge_with(&$other)
    {
        $this->flags      = array_unique(array_merge($this->flags, $other->flags));
        $this->references = array_unique(array_merge($this->references, $other->references));
        if ($this->extracted_comments != $other->extracted_comments) {
            $this->extracted_comments .= $other->extracted_comments;
        }
    }
}
