1. interface
  2. Drupal
  3. \
  4. locale
  5. \
  6. StringInterface

StringInterface

interface StringInterface (View source)

Defines the locale string interface.

Methods

int
getId()

Gets the string unique identifier.

$this
setId(int $id)

Sets the string unique identifier.

string
getVersion()

Gets the string version.

$this
setVersion(string $version)

Sets the string version.

string
getString()

Gets plain string contained in this object.

$this
setString(string $string)

Sets the string contained in this object.

array
getPlurals()

Splits string to work with plural values.

$this
setPlurals(array $plurals)

Sets this string using array of plural values.

StringStorageInterface
getStorage()

Gets the string storage.

$this
setStorage(StringStorageInterface $storage)

Sets the string storage.

bool
isNew()

Checks whether the object is not saved to storage yet.

bool
isSource()

Checks whether the object is a source string.

bool
isTranslation()

Checks whether the object is a translation string.

$this
setValues(array $values, bool $override = TRUE)

Sets an array of values as object properties.

array
getValues(array $fields)

Gets field values that are set for given field names.

array
getLocations(bool $check_only = FALSE)

Gets location information for this string.

$this
addLocation(string $type, string $name)

Adds a location for this string.

bool
hasLocation(string $type, string $name)

Checks whether the string has a given location.

$this
save()

Saves string object to storage.

$this
delete()

Deletes string object from storage.

Details

at line 16
int getId()

Gets the string unique identifier.

Return Value

int

The string identifier.

at line 26
$this setId(int $id)

Sets the string unique identifier.

Parameters

int $id

The string identifier.

Return Value

$this

at line 34
string getVersion()

Gets the string version.

Return Value

string

Version identifier.

at line 44
$this setVersion(string $version)

Sets the string version.

Parameters

string $version

Version identifier.

Return Value

$this

at line 52
string getString()

Gets plain string contained in this object.

Return Value

string

The string contained in this object.

at line 62
$this setString(string $string)

Sets the string contained in this object.

Parameters

string $string

String to set as value.

Return Value

$this

at line 70
array getPlurals()

Splits string to work with plural values.

Return Value

array

Array of strings that are plural variants.

at line 83
$this setPlurals(array $plurals)

Sets this string using array of plural values.

Serializes plural variants in one string glued by \Drupal\Component\Gettext\PoItem::DELIMITER.

Parameters

array $plurals

Array of strings with plural variants.

Return Value

$this

at line 91
StringStorageInterface getStorage()

Gets the string storage.

Return Value

StringStorageInterface

The storage used for this string.

at line 101
$this setStorage(StringStorageInterface $storage)

Sets the string storage.

Parameters

StringStorageInterface $storage

The storage to use for this string.

Return Value

$this

at line 109
bool isNew()

Checks whether the object is not saved to storage yet.

Return Value

bool

TRUE if the object exists in the storage, FALSE otherwise.

at line 117
bool isSource()

Checks whether the object is a source string.

Return Value

bool

TRUE if the object is a source string, FALSE otherwise.

at line 125
bool isTranslation()

Checks whether the object is a translation string.

Return Value

bool

TRUE if the object is a translation string, FALSE otherwise.

at line 137
$this setValues(array $values, bool $override = TRUE)

Sets an array of values as object properties.

Parameters

array $values

Array with values indexed by property name.
bool $override

(optional) Whether to override already set fields, defaults to TRUE.

Return Value

$this

at line 148
array getValues(array $fields)

Gets field values that are set for given field names.

Parameters

array $fields

Array of field names.

Return Value

array

Array of field values indexed by field name.

at line 167
array getLocations(bool $check_only = FALSE)

Gets location information for this string.

Locations are arbitrary pairs of type and name strings, used to store information about the origins of the string, like the file name it was found on, the path on which it was discovered, etc.

A string can have any number of locations since the same string may be found on different places of Drupal code and configuration.

Parameters

bool $check_only

(optional) Set to TRUE to get only new locations added during the current page request and not loading all existing locations.

Return Value

array

Location ids indexed by type and name.

at line 182
$this addLocation(string $type, string $name)

Adds a location for this string.

Parameters

string $type

Location type that may be any arbitrary string. Types used in Drupal core are: 'javascript', 'path', 'code', 'configuration'.
string $name

Location name. Drupal path in case of online discovered translations, file path in case of imported strings, configuration name for strings that come from configuration, etc.

Return Value

$this

at line 195
bool hasLocation(string $type, string $name)

Checks whether the string has a given location.

Parameters

string $type

Location type.
string $name

Location name.

Return Value

bool

TRUE if the string has a location with this type and name.

at line 205
$this save()

Saves string object to storage.

Return Value

$this

Exceptions

StringStorageException

at line 215
$this delete()

Deletes string object from storage.

Return Value

$this

Exceptions

StringStorageException