\GettextTranslation

Class to manage a translation string.

Summary

Methods

Properties

Constants

generateId()
__construct()
getClone()
getId()
is()
setDisabled()
isDisabled()
getOriginal()
hasOriginal()
setTranslation()
getTranslation()
hasTranslation()
setPlural()
getPlural()
hasPlural()
setPluralTranslations()
getPluralTranslations()
hasPluralTranslations()
deletePluralTranslation()
getContext()
hasContext()
addReference()
hasReferences()
getReferences()
deleteReferences()
addComment()
hasComments()
getComments()
deleteComments()
addExtractedComment()
hasExtractedComments()
getExtractedComments()
deleteExtractedComments()
addFlag()
hasFlags()
getFlags()
deleteFlags()
mergeWith()

No public properties found

No constants found

No protected methods found

$context
$original
$translation
$plural
$pluralTranslation
$references
$comments
$extractedComments
$flags
$disabled

N/A

No private methods found

No private properties found

N/A

File: Gettext/Translation.php
Package: Default
Class hierarchy: \Gettext\Translation

Properties

$context

$context :

Type

$original

$original :

Type

$translation

$translation :

Type

$plural

$plural :

Type

$pluralTranslation

$pluralTranslation :

Type

$references

$references :

Type

$comments

$comments :

Type

$extractedComments

$extractedComments :

Type

$flags

$flags :

Type

$disabled

$disabled :

Type

Methods

generateId()

generateId(string  $context, string  $original) : string

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

Parameters

string	$context
string	$original

Returns

string

__construct()

__construct(string  $context, string  $original, string  $plural = '')

Construct.

Parameters

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

getClone()

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

Clones this translation.

Parameters

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

Returns

\Gettext\Translation

getId()

getId() : string

Returns the id of this translation.

Returns

string

is()

is(string  $context, string  $original = '') : boolean

Checks whether the translation matches with the arguments.

Parameters

string	$context
string	$original

Returns

boolean

setDisabled()

setDisabled(boolean  $disabled) : self

Enable or disable the translation

Parameters

boolean

$disabled

Returns

self

isDisabled()

isDisabled() : boolean

Returns whether the translation is disabled

Returns

boolean

getOriginal()

getOriginal() : string

Gets the original string.

Returns

string

hasOriginal()

hasOriginal() : boolean

Checks if the original string is empty or not.

Returns

boolean

setTranslation()

setTranslation(string  $translation) : self

Sets the translation string.

Parameters

string

$translation

Returns

self

getTranslation()

getTranslation() : string

Gets the translation string.

Returns

string

hasTranslation()

hasTranslation() : boolean

Checks if the translation string is empty or not.

Returns

boolean

setPlural()

setPlural(string  $plural) : self

Sets the plural translation string.

Parameters

string

$plural

Returns

self

getPlural()

getPlural() : string

Gets the plural translation string.

Returns

string

hasPlural()

hasPlural() : boolean

Checks if the plural translation string is empty or not.

Returns

boolean

setPluralTranslations()

setPluralTranslations(array  $plural) : self

Set a new plural translation.

Parameters

array

$plural

Returns

self

getPluralTranslations()

getPluralTranslations(integer  $size = null) : array

Gets all plural translations.

Parameters

integer

$size

Returns

array

hasPluralTranslations()

hasPluralTranslations(boolean  $checkContent = false) : boolean

Checks if there are any plural translation.

Parameters

boolean

$checkContent

Returns

boolean

deletePluralTranslation()

deletePluralTranslation() : self

Removes all plural translations.

Returns

self

getContext()

getContext() : string

Gets the context of this translation.

Returns

string

hasContext()

hasContext() : boolean

Checks if the context is empty or not.

Returns

boolean

addReference()

addReference(string  $filename, null|integer  $line = null) : self

Adds a new reference for this translation.

Parameters

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

Returns

self

hasReferences()

hasReferences() : boolean

Checks if the translation has any reference.

Returns

boolean

getReferences()

getReferences() : array

Return all references for this translation.

Returns

array

deleteReferences()

deleteReferences() : self

Removes all references.

Returns

self

addComment()

addComment(string  $comment) : self

Adds a new comment for this translation.

Parameters

string

$comment

Returns

self

hasComments()

hasComments() : boolean

Checks if the translation has any comment.

Returns

boolean

getComments()

getComments() : array

Returns all comments for this translation.

Returns

array

deleteComments()

deleteComments() : self

Removes all comments.

Returns

self

addExtractedComment()

addExtractedComment(string  $comment) : self

Adds a new extracted comment for this translation.

Parameters

string

$comment

Returns

self

hasExtractedComments()

hasExtractedComments() : boolean

Checks if the translation has any extracted comment.

Returns

boolean

getExtractedComments()

getExtractedComments() : array

Returns all extracted comments for this translation.

Returns

array

deleteExtractedComments()

deleteExtractedComments() : self

Removes all extracted comments.

Returns

self

addFlag()

addFlag(string  $flag) : self

Adds a new flag for this translation.

Parameters

string

$flag

Returns

self

hasFlags()

hasFlags() : boolean

Checks if the translation has any flag.

Returns

boolean

getFlags()

getFlags() : array

Returns all extracted flags for this translation.

Returns

array

deleteFlags()

deleteFlags() : self

Removes all flags.

Returns

self

mergeWith()

mergeWith(\Gettext\Translation  $translation, integer  $options = \Gettext\Merge::DEFAULTS) : self

Merges this translation with other translation.

Parameters

\Gettext\Translation	$translation	The translation to merge with
integer	$options

Returns

self