Class to manage a collection of translations. More...

Inheritance diagram for Gettext\Translations:

Collaboration diagram for Gettext\Translations:

Public Member Functions
	__construct ($input=array(), $flags=0, $iterator_class='ArrayIterator')

	__call ($name, $arguments)
	Magic method to import/export the translations to a specific format For example: $translations->toMoFile($filename); For example: $translations->addFromMoFile($filename);. More...

	__clone ()
	Magic method to clone each translation on clone the translations object. More...

	offsetSet ($index, $value)
	Control the new translations added. More...

	setPluralForms ($count, $rule)
	Set the plural definition. More...

	getPluralForms ()
	Returns the parsed plural definition. More...

	setHeader ($name, $value)
	Set a new header. More...

	getHeader ($name)
	Returns a header value. More...

	getHeaders ()
	Returns all header for this translations. More...

	deleteHeaders ()
	Removes all headers. More...

	deleteHeader ($name)
	Removes one header. More...

	getLanguage ()
	Returns the language value. More...

	setLanguage ($language)
	Sets the language and the plural forms. More...

	hasLanguage ()
	Checks whether the language is empty or not. More...

	setDomain ($domain)
	Set a new domain for this translations. More...

	getDomain ()
	Returns the domain. More...

	hasDomain ()
	Checks whether the domain is empty or not. More...

	find ($context, $original='')
	Search for a specific translation. More...

	insert ($context, $original, $plural='')
	Creates and insert/merges a new translation. More...

	mergeWith (Translations $translations, $method=null)
	Merges this translations with other translations. More...

Static Public Member Functions
static	__callStatic ($name, $arguments)
	Magic method to create new instances using extractors For example: Translations::fromMoFile($filename);. More...

Data Fields
const	MERGE_ADD = 1

const	MERGE_REMOVE = 2

const	MERGE_HEADERS = 4

const	MERGE_REFERENCES = 8

const	MERGE_COMMENTS = 16

const	MERGE_LANGUAGE = 32

const	MERGE_PLURAL = 64

const	MERGE_OVERRIDE = 128

const	HEADER_LANGUAGE = 'Language'

const	HEADER_PLURAL = 'Plural-Forms'

const	HEADER_DOMAIN = 'X-Domain'

Static Public Attributes
static	$mergeDefault = 93

Private Attributes
	$headers

	$translationCount

Detailed Description

Class to manage a collection of translations.

Definition at line 11 of file Translations.php.

Constructor & Destructor Documentation

◆ __construct()

Gettext\Translations::__construct	(	$input = `array()`,
		$flags = `0`,
		$iterator_class = `'ArrayIterator'`
	)

See also: \ArrayObject::__construct()

Definition at line 34 of file Translations.php.

    {
        $this->headers = array(
            'Project-Id-Version' => '',
            'Report-Msgid-Bugs-To' => '',
            'Last-Translator' => '',
            'Language-Team' => '',
            'MIME-Version' => '1.0',
            'Content-Type' => 'text/plain; charset=UTF-8',
            'Content-Transfer-Encoding' => '8bit',
            'POT-Creation-Date' => date('c'),
            'PO-Revision-Date' => date('c'),
        );
        $this->headers[self::HEADER_LANGUAGE] = '';
        parent::__construct($input, $flags, $iterator_class);
    }

References $input.

Member Function Documentation

◆ __call()

Gettext\Translations::__call	(	$name,
		$arguments
	)

Magic method to import/export the translations to a specific format For example: $translations->toMoFile($filename); For example: $translations->addFromMoFile($filename);.

Returns: self|bool

Definition at line 73 of file Translations.php.

    {
        if (!preg_match('/^(addFrom|to)(\w+)(File|String)$/i', $name, $matches)) {
            throw new BadMethodCallException("The method $name does not exists");
        }
 
        if ($matches[1] === 'addFrom') {
            $arguments[] = $this;
 
            call_user_func_array('Gettext\\Extractors\\'.$matches[2].'::from'.$matches[3], $arguments);
 
            return $this;
        }
 
        array_unshift($arguments, $this);
 
        return call_user_func_array('Gettext\\Generators\\'.$matches[2].'::to'.$matches[3], $arguments);
    }

References $name.

◆ __callStatic()

static Gettext\Translations::__callStatic	(	$name,
		$arguments
	)

static

Magic method to create new instances using extractors For example: Translations::fromMoFile($filename);.

Returns: Translations

Definition at line 57 of file Translations.php.

    {
        if (!preg_match('/^from(\w+)(File|String)$/i', $name, $matches)) {
            throw new BadMethodCallException("The method $name does not exists");
        }
 
        return call_user_func_array('Gettext\\Extractors\\'.$matches[1].'::from'.$matches[2], $arguments);
    }

References $name.

◆ __clone()

Gettext\Translations::__clone ( )

Magic method to clone each translation on clone the translations object.

Definition at line 95 of file Translations.php.

    {
        $array = array();
 
        foreach ($this as $key => $translation) {
            $array[$key] = clone $translation;
        }
 
        $this->exchangeArray($array);
    }

References $key.

◆ deleteHeader()

Gettext\Translations::deleteHeader ( $name )

Removes one header.

Parameters

string $name

Definition at line 222 of file Translations.php.

    {
        unset($this->headers[$name]);
    }

References $name.

◆ deleteHeaders()

Gettext\Translations::deleteHeaders ( )

Removes all headers.

Definition at line 212 of file Translations.php.

    {
        $this->headers = array();
    }

◆ find()

Gettext\Translations::find	(	$context,
		$original = `''`
	)

Search for a specific translation.

Parameters

string \| Translation	$context	The context of the translation or a translation instance
string	$original	The original string

Returns: Translation|false

Definition at line 309 of file Translations.php.

    {
        if ($context instanceof Translation) {
            $id = $context->getId();
        } else {
            $id = Translation::generateId($context, $original);
        }
 
        return $this->offsetExists($id) ? $this[$id] : false;
    }

References $context, and $id.

Referenced by Gettext\Translations\mergeWith().

Here is the caller graph for this function:

◆ getDomain()

Gettext\Translations::getDomain ( )

Returns the domain.

Returns: string

Definition at line 284 of file Translations.php.

    {
        return $this->getHeader(self::HEADER_DOMAIN);
    }

References Dflydev\FigCookies\getHeader().

Referenced by Gettext\Utils\FunctionsScanner\saveGettextFunctions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeader()

Gettext\Translations::getHeader ( $name )

Returns a header value.

Parameters

string $name

Returns: null|string

Definition at line 194 of file Translations.php.

    {
        return isset($this->headers[$name]) ? $this->headers[$name] : null;
    }

References $name.

Referenced by Gettext\Extractors\Po\parseHeaders().

Here is the caller graph for this function:

◆ getHeaders()

Gettext\Translations::getHeaders ( )

Returns all header for this translations.

Returns: array

Definition at line 204 of file Translations.php.

    {
        return $this->headers;
    }

Referenced by Gettext\Translations\mergeWith(), Gettext\Generators\Mo\toString(), and Gettext\Generators\Po\toString().

Here is the caller graph for this function:

◆ getLanguage()

Gettext\Translations::getLanguage ( )

Returns the language value.

Returns: string $language

Definition at line 232 of file Translations.php.

    {
        return $this->getHeader(self::HEADER_LANGUAGE);
    }

References Dflydev\FigCookies\getHeader().

Referenced by Gettext\Translations\mergeWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluralForms()

Gettext\Translations::getPluralForms ( )

Returns the parsed plural definition.

Parameters

null|array [count, rule]

Definition at line 154 of file Translations.php.

    {
        $header = $this->getHeader(self::HEADER_PLURAL);
 
        if (!empty($header) && preg_match('/^nplurals\s*=\s*(\d+)\s*;\s*plural\s*=\s*([^;]+)\s*;$/', $header, $matches)) {
            return array(intval($matches[1]), $matches[2]);
        }
    }

References $header, and Dflydev\FigCookies\getHeader().

Referenced by Gettext\Translations\mergeWith().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasDomain()

Gettext\Translations::hasDomain ( )

Checks whether the domain is empty or not.

Returns: bool

Definition at line 294 of file Translations.php.

    {
        $domain = $this->getDomain();
 
        return (is_string($domain) && ($domain !== '')) ? true : false;
    }

References $domain.

◆ hasLanguage()

Gettext\Translations::hasLanguage ( )

Checks whether the language is empty or not.

Returns: bool

Definition at line 262 of file Translations.php.

    {
        $language = $this->getLanguage();
 
        return (is_string($language) && ($language !== '')) ? true : false;
    }

References $language.

◆ insert()

Gettext\Translations::insert	(	$context,
		$original,
		$plural = `''`
	)

Creates and insert/merges a new translation.

Parameters

string	$context	The translation context
string	$original	The translation original string
string	$plural	The translation original plural string

Returns: Translation The translation created

Definition at line 329 of file Translations.php.

    {
        return $this->offsetSet(null, new Translation($context, $original, $plural));
    }

References $context.

Referenced by Gettext\Extractors\Jed\insertTranslation(), Gettext\Extractors\PhpArray\insertTranslation(), and Gettext\Utils\FunctionsScanner\saveGettextFunctions().

Here is the caller graph for this function:

◆ mergeWith()

Gettext\Translations::mergeWith	(	Translations	$translations,
			$method = `null`
	)

Merges this translations with other translations.

Parameters

Translations	$translations	The translations instance to merge with
int \| null	$method	One or various Translations::MERGE_* constants to define how to merge the translations

Definition at line 340 of file Translations.php.

    {
        if ($method === null) {
            $method = self::$mergeDefault;
        }
 
        if ($method & self::MERGE_HEADERS) {
            foreach ($translations->getHeaders() as $name => $value) {
                if (!$this->getHeader($name)) {
                    $this->setHeader($name, $value);
                }
            }
        }
 
        $add = (boolean) ($method & self::MERGE_ADD);
 
        foreach ($translations as $entry) {
            if (($existing = $this->find($entry))) {
                $existing->mergeWith($entry, $method);
            } elseif ($add) {
                $this[] = clone $entry;
            }
        }
 
        if ($method & self::MERGE_REMOVE) {
            $filtered = array();
 
            foreach ($this as $entry) {
                if ($translations->find($entry)) {
                    $filtered[] = $entry;
                }
            }
 
            $this->exchangeArray($filtered);
        }
 
        if ($method & self::MERGE_LANGUAGE) {
            $language = $translations->getLanguage();
            $pluralForm = $translations->getPluralForms();
 
            if (!$pluralForm) {
                if (!empty($language)) {
                    $this->setLanguage($language);
                }
            } else {
                if (!empty($language)) {
                    $this->setHeader(self::HEADER_LANGUAGE, $language);
                }
 
                $this->setPluralForms($pluralForm[0], $pluralForm[1]);
            }
        }
    }

References $language, $name, Gettext\Translations\find(), Dflydev\FigCookies\getHeader(), Gettext\Translations\getHeaders(), Gettext\Translations\getLanguage(), Gettext\Translations\getPluralForms(), and Sabre\HTTP\setHeader().

Here is the call graph for this function:

◆ offsetSet()

Gettext\Translations::offsetSet	(	$index,
		$value
	)

Control the new translations added.

Parameters

mixed	$index
Translation	$value

Exceptions

InvalidArgumentException If the value is not an instance of Gettext\Translation

Returns: Translation

Definition at line 116 of file Translations.php.

    {
        if (!($value instanceof Translation)) {
            throw new \InvalidArgumentException('Only instances of Gettext\\Translation must be added to a Gettext\\Translations');
        }
 
        $id = $value->getId();
 
        if ($this->offsetExists($id)) {
            $this[$id]->mergeWith($value);
            $this[$id]->setTranslationCount($this->translationCount);
 
            return $this[$id];
        }
 
        $value->setTranslationCount($this->translationCount);
 
        parent::offsetSet($id, $value);
 
        return $value;
    }

References $id.

◆ setDomain()

Gettext\Translations::setDomain ( $domain )

Set a new domain for this translations.

Parameters

string $domain

Definition at line 274 of file Translations.php.

    {
        $this->setHeader(self::HEADER_DOMAIN, trim($domain));
    }

References $domain, and Sabre\HTTP\setHeader().

Referenced by Gettext\Extractors\PhpArray\handleArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHeader()

Gettext\Translations::setHeader	(	$name,
		$value
	)

Set a new header.

Parameters

string	$name
string	$value

Definition at line 169 of file Translations.php.

    {
        $name = trim($name);
        $this->headers[$name] = trim($value);
 
        if ($name === self::HEADER_PLURAL) {
            if ($forms = $this->getPluralForms()) {
                $this->translationCount = $forms[0];
 
                foreach ($this as $t) {
                    $t->setTranslationCount($this->translationCount);
                }
            } else {
                $this->translationCount = null;
            }
        }
    }

References $name, and $t.

Referenced by Gettext\Extractors\Po\parseHeaders().

Here is the caller graph for this function:

◆ setLanguage()

Gettext\Translations::setLanguage ( $language )

Sets the language and the plural forms.

Parameters

string $language

Returns: bool Returns true if the plural rules has been updated, false if $language hasn't been recognized

Definition at line 244 of file Translations.php.

    {
        $this->setHeader(self::HEADER_LANGUAGE, trim($language));
 
        if (($info = Language::getById($language))) {
            $this->setPluralForms(count($info->categories), $info->formula);
 
            return true;
        }
 
        return false;
    }

References $info, $language, and Sabre\HTTP\setHeader().

Here is the call graph for this function:

◆ setPluralForms()

Gettext\Translations::setPluralForms	(	$count,
		$rule
	)

Set the plural definition.

Parameters

int	$count
string	$rule

Definition at line 144 of file Translations.php.

    {
        $this->setHeader(self::HEADER_PLURAL, "nplurals={$count}; plural={$rule};");
    }

References Sabre\HTTP\setHeader().

Here is the call graph for this function:

Field Documentation

◆ $headers

Gettext\Translations::$headers

private

Definition at line 28 of file Translations.php.

◆ $mergeDefault

Gettext\Translations::$mergeDefault = 93

static

Definition at line 26 of file Translations.php.

◆ $translationCount

Gettext\Translations::$translationCount

private

Definition at line 29 of file Translations.php.

◆ HEADER_DOMAIN

const Gettext\Translations::HEADER_DOMAIN = 'X-Domain'

Definition at line 24 of file Translations.php.

◆ HEADER_LANGUAGE

const Gettext\Translations::HEADER_LANGUAGE = 'Language'

Definition at line 22 of file Translations.php.

◆ HEADER_PLURAL

const Gettext\Translations::HEADER_PLURAL = 'Plural-Forms'

Definition at line 23 of file Translations.php.

◆ MERGE_ADD

const Gettext\Translations::MERGE_ADD = 1

Definition at line 13 of file Translations.php.

◆ MERGE_COMMENTS

const Gettext\Translations::MERGE_COMMENTS = 16

Definition at line 17 of file Translations.php.

◆ MERGE_HEADERS

const Gettext\Translations::MERGE_HEADERS = 4

Definition at line 15 of file Translations.php.

◆ MERGE_LANGUAGE

const Gettext\Translations::MERGE_LANGUAGE = 32

Definition at line 18 of file Translations.php.

◆ MERGE_OVERRIDE

const Gettext\Translations::MERGE_OVERRIDE = 128

Definition at line 20 of file Translations.php.

◆ MERGE_PLURAL

const Gettext\Translations::MERGE_PLURAL = 64

Definition at line 19 of file Translations.php.

◆ MERGE_REFERENCES

const Gettext\Translations::MERGE_REFERENCES = 8

Definition at line 16 of file Translations.php.

◆ MERGE_REMOVE

const Gettext\Translations::MERGE_REMOVE = 2

Definition at line 14 of file Translations.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/gettext/gettext/src/Translations.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ __callStatic()

◆ __clone()

◆ deleteHeader()

◆ deleteHeaders()

◆ find()

◆ getDomain()

◆ getHeader()

◆ getHeaders()

◆ getLanguage()

◆ getPluralForms()

◆ hasDomain()

◆ hasLanguage()

◆ insert()

◆ mergeWith()

◆ offsetSet()

◆ setDomain()

◆ setHeader()

◆ setLanguage()

◆ setPluralForms()

Field Documentation

◆ $headers

◆ $mergeDefault

◆ $translationCount

◆ HEADER_DOMAIN

◆ HEADER_LANGUAGE

◆ HEADER_PLURAL

◆ MERGE_ADD

◆ MERGE_COMMENTS

◆ MERGE_HEADERS

◆ MERGE_LANGUAGE

◆ MERGE_OVERRIDE

◆ MERGE_PLURAL

◆ MERGE_REFERENCES

◆ MERGE_REMOVE