class TranslationString

Same name in other branches
  1. 9 core/modules/locale/src/TranslationString.php \Drupal\locale\TranslationString
  2. 10 core/modules/locale/src/TranslationString.php \Drupal\locale\TranslationString
  3. 11.x core/modules/locale/src/TranslationString.php \Drupal\locale\TranslationString

Defines the locale translation string object.

This class represents a translation of a source string to a given language, thus it must have at least a 'language' which is the language code and a 'translation' property which is the translated text of the source string in the specified language.

Hierarchy

Expanded class hierarchy of TranslationString

1 file declares its use of TranslationString
LocaleConfigSubscriberTest.php in core/modules/locale/tests/src/Kernel/LocaleConfigSubscriberTest.php

File

core/modules/locale/src/TranslationString.php, line 13

Namespace

Drupal\locale
View source
class TranslationString extends StringBase {
    
    /**
     * The language code.
     *
     * @var string
     */
    public $language;
    
    /**
     * The string translation.
     *
     * @var string
     */
    public $translation;
    
    /**
     * Integer indicating whether this string is customized.
     *
     * @var int
     */
    public $customized;
    
    /**
     * Boolean indicating whether the string object is new.
     *
     * @var bool
     */
    protected $isNew;
    
    /**
     * {@inheritdoc}
     */
    public function __construct($values = []) {
        parent::__construct($values);
        if (!isset($this->isNew)) {
            // We mark the string as not new if it is a complete translation.
            // This will work when loading from database, otherwise the storage
            // controller that creates the string object must handle it.
            $this->isNew = !$this->isTranslation();
        }
    }
    
    /**
     * Sets the string as customized / not customized.
     *
     * @param bool $customized
     *   (optional) Whether the string is customized or not. Defaults to TRUE.
     *
     * @return $this
     *   The called object.
     */
    public function setCustomized($customized = TRUE) {
        $this->customized = $customized ? LOCALE_CUSTOMIZED : LOCALE_NOT_CUSTOMIZED;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isSource() {
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isTranslation() {
        return !empty($this->lid) && !empty($this->language) && isset($this->translation);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getString() {
        return isset($this->translation) ? $this->translation : '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function setString($string) {
        $this->translation = $string;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isNew() {
        return $this->isNew;
    }
    
    /**
     * {@inheritdoc}
     */
    public function save() {
        parent::save();
        $this->isNew = FALSE;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete() {
        parent::delete();
        $this->isNew = TRUE;
        return $this;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
StringBase::$context public property The string context.
StringBase::$lid public property The string identifier.
StringBase::$locations public property The string locations indexed by type.
StringBase::$source public property The source string.
StringBase::$storage protected property The locale storage this string comes from or is to be saved to.
StringBase::$version public property The string version.
StringBase::addLocation public function Adds a location for this string. Overrides StringInterface::addLocation
StringBase::getId public function Gets the string unique identifier. Overrides StringInterface::getId
StringBase::getLocations public function Gets location information for this string. Overrides StringInterface::getLocations
StringBase::getPlurals public function Splits string to work with plural values. Overrides StringInterface::getPlurals
StringBase::getStorage public function Gets the string storage. Overrides StringInterface::getStorage
StringBase::getValues public function Gets field values that are set for given field names. Overrides StringInterface::getValues
StringBase::getVersion public function Gets the string version. Overrides StringInterface::getVersion
StringBase::hasLocation public function Checks whether the string has a given location. Overrides StringInterface::hasLocation
StringBase::setId public function Sets the string unique identifier. Overrides StringInterface::setId
StringBase::setPlurals public function Sets this string using array of plural values. Overrides StringInterface::setPlurals
StringBase::setStorage public function Sets the string storage. Overrides StringInterface::setStorage
StringBase::setValues public function Sets an array of values as object properties. Overrides StringInterface::setValues
StringBase::setVersion public function Sets the string version. Overrides StringInterface::setVersion
TranslationString::$customized public property Integer indicating whether this string is customized.
TranslationString::$isNew protected property Boolean indicating whether the string object is new.
TranslationString::$language public property The language code.
TranslationString::$translation public property The string translation.
TranslationString::delete public function Deletes string object from storage. Overrides StringBase::delete
TranslationString::getString public function Gets plain string contained in this object. Overrides StringInterface::getString
TranslationString::isNew public function Checks whether the object is not saved to storage yet. Overrides StringInterface::isNew
TranslationString::isSource public function Checks whether the object is a source string. Overrides StringInterface::isSource
TranslationString::isTranslation public function Checks whether the object is a translation string. Overrides StringInterface::isTranslation
TranslationString::save public function Saves string object to storage. Overrides StringBase::save
TranslationString::setCustomized public function Sets the string as customized / not customized.
TranslationString::setString public function Sets the string contained in this object. Overrides StringInterface::setString
TranslationString::__construct public function Constructs a new locale string object. Overrides StringBase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.