Class to manage a translation string. More...

Collaboration diagram for Gettext\Translation:

Public Member Functions
	__construct ($context, $original, $plural='')
	Construct. More...

	getClone ($context=null, $original=null)
	Clones this translation. More...

	getId ()
	Returns the id of this translation. More...

	is ($context, $original='')
	Checks whether the translation matches with the arguments. More...

	getOriginal ()
	Gets the original string. More...

	hasOriginal ()
	Checks if the original string is empty or not. More...

	setTranslation ($translation)
	Sets the translation string. More...

	getTranslation ()
	Gets the translation string. More...

	hasTranslation ()
	Checks if the translation string is empty or not. More...

	setPlural ($plural)
	Sets the plural translation string. More...

	getPlural ()
	Gets the plural translation string. More...

	hasPlural ()
	Checks if the plural translation string is empty or not. More...

	setPluralTranslation ($plural, $key=0)
	Set a new plural translation. More...

	getPluralTranslation ($key=null)
	Gets one or all plural translations. More...

	hasPluralTranslation ()
	Checks if there are any plural translation. More...

	deletePluralTranslation ()
	Removes all plural translations. More...

	setTranslationCount ($count)
	Set the number of singular + plural translations allowed. More...

	getTranslationCount ()
	Returns the number of singular + plural translations Returns null if this Translation is not a plural one. More...

	getContext ()
	Gets the context of this translation. More...

	hasContext ()
	Checks if the context is empty or not. More...

	addReference ($filename, $line=null)
	Adds a new reference for this translation. More...

	hasReferences ()
	Checks if the translation has any reference. More...

	getReferences ()
	Return all references for this translation. More...

	deleteReferences ()
	Removes all references. More...

	addComment ($comment)
	Adds a new comment for this translation. More...

	hasComments ()
	Checks if the translation has any comment. More...

	getComments ()
	Returns all comments for this translation. More...

	deleteComments ()
	Removes all comments. More...

	addExtractedComment ($comment)
	Adds a new extracted comment for this translation. More...

	hasExtractedComments ()
	Checks if the translation has any extracted comment. More...

	getExtractedComments ()
	Returns all extracted comments for this translation. More...

	deleteExtractedComments ()
	Removes all extracted comments. More...

	addFlag ($flag)
	Adds a new flat for this translation. More...

	hasFlags ()
	Checks if the translation has any flag. More...

	getFlags ()
	Returns all extracted flags for this translation. More...

	deleteFlags ()
	Removes all flags. More...

	mergeWith (Translation $translation, $method=null)
	Merges this translation with other translation. More...

Static Public Member Functions
static	generateId ($context, $original)
	Generates the id of a translation (context + glue + original). More...

Protected Member Functions
	normalizeTranslationCount ()
	Normalizes the translation count. More...

Protected Attributes
	$context

	$original

	$translation = ''

	$plural

	$pluralTranslation = array()

	$references = array()

	$comments = array()

	$extractedComments = array()

	$flags = array()

	$translationCount

Detailed Description

Class to manage a translation string.

Definition at line 8 of file Translation.php.

Constructor & Destructor Documentation

◆ __construct()

Gettext\Translation::__construct	(	$context,
		$original,
		$plural = `''`
	)

Construct.

Parameters

string	$context	The context of the translation
string	$original	The original string
string	$plural	The original plural string

Definition at line 41 of file Translation.php.

    {
        $this->context = (string) $context;
        $this->original = (string) $original;
 
        $this->setPlural($plural);
    }

Member Function Documentation

◆ addComment()

Gettext\Translation::addComment ( $comment )

Adds a new comment for this translation.

Parameters

string $comment

Definition at line 334 of file Translation.php.

    {
        $this->comments[] = $comment;
    }

References $comment.

◆ addExtractedComment()

Gettext\Translation::addExtractedComment ( $comment )

Adds a new extracted comment for this translation.

Parameters

string $comment

Definition at line 372 of file Translation.php.

    {
        $this->extractedComments[] = $comment;
    }

References $comment.

◆ addFlag()

Gettext\Translation::addFlag ( $flag )

Adds a new flat for this translation.

Parameters

string $flag

Definition at line 410 of file Translation.php.

    {
        $this->flags[] = $flag;
    }

◆ addReference()

Gettext\Translation::addReference	(	$filename,
		$line = `null`
	)

Adds a new reference for this translation.

Parameters

string	$filename	The file path where the translation has been found
null \| int	$line	The line number where the translation has been found

Definition at line 295 of file Translation.php.

    {
        $key = "{$filename}:{$line}";
        $this->references[$key] = array($filename, $line);
    }

References $filename, and $key.

◆ deleteComments()

Gettext\Translation::deleteComments ( )

Removes all comments.

Definition at line 362 of file Translation.php.

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

◆ deleteExtractedComments()

Gettext\Translation::deleteExtractedComments ( )

Removes all extracted comments.

Definition at line 400 of file Translation.php.

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

◆ deleteFlags()

Gettext\Translation::deleteFlags ( )

Removes all flags.

Definition at line 438 of file Translation.php.

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

◆ deletePluralTranslation()

Gettext\Translation::deletePluralTranslation ( )

Removes all plural translations.

Definition at line 216 of file Translation.php.

    {
        $this->pluralTranslation = array();
 
        $this->normalizeTranslationCount();
    }

◆ deleteReferences()

Gettext\Translation::deleteReferences ( )

Removes all references.

Definition at line 324 of file Translation.php.

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

◆ generateId()

static Gettext\Translation::generateId	(	$context,
		$original
	)

static

Generates the id of a translation (context + glue + original).

Parameters

string	$context
string	$original

Returns: string

Definition at line 29 of file Translation.php.

    {
        return "{$context}\004{$original}";
    }

◆ getClone()

Gettext\Translation::getClone	(	$context = `null`,
		$original = `null`
	)

Clones this translation.

Parameters

null \| string	$context	Optional new context
null \| string	$original	Optional new original

Definition at line 55 of file Translation.php.

    {
        $new = clone $this;
 
        if ($context !== null) {
            $new->context = (string) $context;
        }
 
        if ($original !== null) {
            $new->original = (string) $original;
        }
 
        return $new;
    }

References $new.

◆ getComments()

Gettext\Translation::getComments ( )

Returns all comments for this translation.

Returns: array

Definition at line 354 of file Translation.php.

    {
        return $this->comments;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getContext()

Gettext\Translation::getContext ( )

Gets the context of this translation.

Returns: string

Definition at line 274 of file Translation.php.

    {
        return $this->context;
    }

◆ getExtractedComments()

Gettext\Translation::getExtractedComments ( )

Returns all extracted comments for this translation.

Returns: array

Definition at line 392 of file Translation.php.

    {
        return $this->extractedComments;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getFlags()

Gettext\Translation::getFlags ( )

Returns all extracted flags for this translation.

Returns: array

Definition at line 430 of file Translation.php.

    {
        return $this->flags;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getId()

Gettext\Translation::getId ( )

Returns the id of this translation.

Returns: string

Definition at line 75 of file Translation.php.

    {
        return static::generateId($this->context, $this->original);
    }

◆ getOriginal()

Gettext\Translation::getOriginal ( )

Gets the original string.

Returns: string

Definition at line 98 of file Translation.php.

    {
        return $this->original;
    }

◆ getPlural()

Gettext\Translation::getPlural ( )

Gets the plural translation string.

Returns: string

Definition at line 160 of file Translation.php.

    {
        return $this->plural;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getPluralTranslation()

Gettext\Translation::getPluralTranslation ( $key = null )

Gets one or all plural translations.

Parameters

int | null $key The key to return. If is null, return all translations

Returns: string|array

Definition at line 194 of file Translation.php.

    {
        if ($key === null) {
            return $this->pluralTranslation;
        }
 
        return isset($this->pluralTranslation[$key]) ? (string) $this->pluralTranslation[$key] : '';
    }

References $key.

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getReferences()

Gettext\Translation::getReferences ( )

Return all references for this translation.

Returns: array

Definition at line 316 of file Translation.php.

    {
        return array_values($this->references);
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getTranslation()

Gettext\Translation::getTranslation ( )

Gets the translation string.

Returns: string

Definition at line 128 of file Translation.php.

    {
        return $this->translation;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ getTranslationCount()

Gettext\Translation::getTranslationCount ( )

Returns the number of singular + plural translations Returns null if this Translation is not a plural one.

Returns: int|null

Definition at line 241 of file Translation.php.

    {
        return $this->hasPlural() ? $this->translationCount : null;
    }

◆ hasComments()

Gettext\Translation::hasComments ( )

Checks if the translation has any comment.

Returns: bool

Definition at line 344 of file Translation.php.

    {
        return isset($this->comments[0]);
    }

◆ hasContext()

Gettext\Translation::hasContext ( )

Checks if the context is empty or not.

Returns: bool

Definition at line 284 of file Translation.php.

    {
        return (isset($this->context) && ($this->context !== '')) ? true : false;
    }

◆ hasExtractedComments()

Gettext\Translation::hasExtractedComments ( )

Checks if the translation has any extracted comment.

Returns: bool

Definition at line 382 of file Translation.php.

    {
        return isset($this->extractedComments[0]);
    }

◆ hasFlags()

Gettext\Translation::hasFlags ( )

Checks if the translation has any flag.

Returns: bool

Definition at line 420 of file Translation.php.

    {
        return isset($this->flags[0]);
    }

◆ hasOriginal()

Gettext\Translation::hasOriginal ( )

Checks if the original string is empty or not.

Returns: bool

Definition at line 108 of file Translation.php.

    {
        return ($this->original !== '') ? true : false;
    }

◆ hasPlural()

Gettext\Translation::hasPlural ( )

Checks if the plural translation string is empty or not.

Returns: bool

Definition at line 170 of file Translation.php.

    {
        return ($this->plural !== '') ? true : false;
    }

◆ hasPluralTranslation()

Gettext\Translation::hasPluralTranslation ( )

Checks if there are any plural translation.

Returns: bool

Definition at line 208 of file Translation.php.

    {
        return implode('', $this->pluralTranslation) !== '';
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ hasReferences()

Gettext\Translation::hasReferences ( )

Checks if the translation has any reference.

Returns: bool

Definition at line 306 of file Translation.php.

    {
        return !empty($this->references);
    }

◆ hasTranslation()

Gettext\Translation::hasTranslation ( )

Checks if the translation string is empty or not.

Returns: bool

Definition at line 138 of file Translation.php.

    {
        return ($this->translation !== '') ? true : false;
    }

Referenced by Gettext\Translation\mergeWith().

Here is the caller graph for this function:

◆ is()

Gettext\Translation::is	(	$context,
		$original = `''`
	)

Checks whether the translation matches with the arguments.

Parameters

string	$context
string	$original

Returns: bool

Definition at line 88 of file Translation.php.

    {
        return (($this->context === $context) && ($this->original === $original)) ? true : false;
    }

◆ mergeWith()

Gettext\Translation::mergeWith	(	Translation	$translation,
			$method = `null`
	)

Merges this translation with other translation.

Parameters

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

Definition at line 449 of file Translation.php.

    {
        if ($method === null) {
            $method = Translations::$mergeDefault;
        }
 
        if (!$this->hasTranslation() || ($translation->hasTranslation() && ($method & Translations::MERGE_OVERRIDE))) {
            $this->setTranslation($translation->getTranslation());
        }
 
        if (($method & Translations::MERGE_PLURAL) && !$this->hasPlural()) {
            $this->setPlural($translation->getPlural());
        }
 
        if ($this->hasPlural() && !$this->hasPluralTranslation() && $translation->hasPluralTranslation()) {
            $this->pluralTranslation = $translation->getPluralTranslation();
        }
 
        if ($method & Translations::MERGE_REFERENCES) {
            foreach ($translation->getReferences() as $reference) {
                $this->addReference($reference[0], $reference[1]);
            }
        }
 
        if ($method & Translations::MERGE_COMMENTS) {
            $this->comments = array_values(array_unique(array_merge($translation->getComments(), $this->comments)));
            $this->extractedComments = array_values(array_unique(array_merge($translation->getExtractedComments(), $this->extractedComments)));
            $this->flags = array_values(array_unique(array_merge($translation->getFlags(), $this->flags)));
        }
    }

References Gettext\Translation\getComments(), Gettext\Translation\getExtractedComments(), Gettext\Translation\getFlags(), Gettext\Translation\getPlural(), Gettext\Translation\getPluralTranslation(), Gettext\Translation\getReferences(), Gettext\Translation\getTranslation(), Gettext\Translation\hasPluralTranslation(), and Gettext\Translation\hasTranslation().

Here is the call graph for this function:

◆ normalizeTranslationCount()

Gettext\Translation::normalizeTranslationCount ( )

protected

Normalizes the translation count.

Definition at line 249 of file Translation.php.

    {
        if ($this->translationCount === null) {
            return;
        }
 
        if ($this->hasPlural()) {
            $allowed = $this->translationCount - 1;
            $current = count($this->pluralTranslation);
 
            if ($allowed > $current) {
                $this->pluralTranslation = $this->pluralTranslation + array_fill(0, $allowed, '');
            } elseif ($current > $allowed) {
                $this->pluralTranslation = array_slice($this->pluralTranslation, 0, $allowed);
            }
        } else {
            $this->pluralTranslation = array();
        }
    }

References $current.

◆ setPlural()

Gettext\Translation::setPlural ( $plural )

Sets the plural translation string.

Parameters

string $plural

Definition at line 148 of file Translation.php.

    {
        $this->plural = (string) $plural;
 
        $this->normalizeTranslationCount();
    }

◆ setPluralTranslation()

Gettext\Translation::setPluralTranslation	(	$plural,
		$key = `0`
	)

Set a new plural translation.

Parameters

string	$plural	The plural string to add
int	$key	The key of the plural translation.

Definition at line 181 of file Translation.php.

    {
        $this->pluralTranslation[$key] = $plural;
        $this->normalizeTranslationCount();
    }

References $key.

◆ setTranslation()

Gettext\Translation::setTranslation ( $translation )

Sets the translation string.

Parameters

string $translation

Definition at line 118 of file Translation.php.

    {
        $this->translation = (string) $translation;
    }

◆ setTranslationCount()

Gettext\Translation::setTranslationCount ( $count )

Set the number of singular + plural translations allowed.

Parameters

int $count

Definition at line 228 of file Translation.php.

    {
        $this->translationCount = is_null($count) ? null : intval($count);
 
        $this->normalizeTranslationCount();
    }

Field Documentation

◆ $comments

Gettext\Translation::$comments = array()

protected

Definition at line 16 of file Translation.php.

◆ $context

Gettext\Translation::$context

protected

Definition at line 10 of file Translation.php.

◆ $extractedComments

Gettext\Translation::$extractedComments = array()

protected

Definition at line 17 of file Translation.php.

◆ $flags

Gettext\Translation::$flags = array()

protected

Definition at line 18 of file Translation.php.

◆ $original

Gettext\Translation::$original

protected

Definition at line 11 of file Translation.php.

◆ $plural

Gettext\Translation::$plural

protected

Definition at line 13 of file Translation.php.

◆ $pluralTranslation

Gettext\Translation::$pluralTranslation = array()

protected

Definition at line 14 of file Translation.php.

◆ $references

Gettext\Translation::$references = array()

protected

Definition at line 15 of file Translation.php.

◆ $translation

Gettext\Translation::$translation = ''

protected

Definition at line 12 of file Translation.php.

◆ $translationCount

Gettext\Translation::$translationCount

protected

Definition at line 19 of file Translation.php.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addComment()

◆ addExtractedComment()

◆ addFlag()

◆ addReference()

◆ deleteComments()

◆ deleteExtractedComments()

◆ deleteFlags()

◆ deletePluralTranslation()

◆ deleteReferences()

◆ generateId()

◆ getClone()

◆ getComments()

◆ getContext()

◆ getExtractedComments()

◆ getFlags()

◆ getId()

◆ getOriginal()

◆ getPlural()

◆ getPluralTranslation()

◆ getReferences()

◆ getTranslation()

◆ getTranslationCount()

◆ hasComments()

◆ hasContext()

◆ hasExtractedComments()

◆ hasFlags()

◆ hasOriginal()

◆ hasPlural()

◆ hasPluralTranslation()

◆ hasReferences()

◆ hasTranslation()

◆ is()

◆ mergeWith()

◆ normalizeTranslationCount()

◆ setPlural()

◆ setPluralTranslation()

◆ setTranslation()

◆ setTranslationCount()

Field Documentation

◆ $comments

◆ $context

◆ $extractedComments

◆ $flags

◆ $original

◆ $plural

◆ $pluralTranslation

◆ $references

◆ $translation

◆ $translationCount