abstract class StringBase in Localization update 7.2

Defines the locale string base class.

This is the base class to be used for locale string objects and contains the common properties and methods for source and translation strings.

Hierarchy

• class \StringBase implements StringInterface

File

includes/locale/StringBase.php, line 14

Definition of StringBase.

abstract class StringBase implements StringInterface {

  /**
   * The string identifier.
   *
   * @var integer
   */
  public $lid;

  /**
   * The parent string identifier for plural translations.
   *
   * @var integer
   */
  public $plid;

  /**
   * Plural index in case of plural string.
   *
   * @var integer
   */
  public $plural;

  /**
   * The string locations indexed by type.
   *
   * @var string
   */
  public $locations;

  /**
   * The source string.
   *
   * @var string
   */
  public $source;

  /**
   * The string context.
   *
   * @var string
   */
  public $context;

  /**
   * The string group.
   *
   * @var string
   */
  public $textgroup;

  /**
   * The string version.
   *
   * @var string
   */
  public $version;

  /**
   * The locale storage this string comes from or is to be saved to.
   *
   * @var StringStorageInterface
   */
  protected $storage;

  /**
   * Constructs a new locale string object.
   *
   * @param object|array $values
   *   Object or array with initial values.
   */
  public function __construct($values = array()) {
    $this
      ->setValues((array) $values);
  }

  /**
   * Implements StringInterface::getId().
   */
  public function getId() {
    return isset($this->lid) ? $this->lid : NULL;
  }

  /**
   * Implements StringInterface::setId().
   */
  public function setId($lid) {
    $this->lid = $lid;
    return $this;
  }

  /**
   * Implements StringInterface::getParentId().
   */
  public function getParentId() {
    return isset($this->plid) ? $this->plid : 0;
  }

  /**
   * Implements StringInterface::setParentId().
   */
  public function setParentId($plid) {
    $this->plid = $plid;
    return $this;
  }

  /**
   * Implements StringInterface::getVersion().
   */
  public function getVersion() {
    return isset($this->version) ? $this->version : NULL;
  }

  /**
   * Implements StringInterface::setVersion().
   */
  public function setVersion($version) {
    $this->version = $version;
    return $this;
  }

  /**
   * Implements StringInterface::getStorage().
   */
  public function getStorage() {
    return isset($this->storage) ? $this->storage : NULL;
  }

  /**
   * Implements StringInterface::setStorage().
   */
  public function setStorage(StringStorageInterface $storage) {
    $this->storage = $storage;
    return $this;
  }

  /**
   * Implements StringInterface::setValues().
   */
  public function setValues(array $values, $override = TRUE) {
    foreach ($values as $key => $value) {
      if (property_exists($this, $key) && ($override || !isset($this->{$key}))) {
        $this->{$key} = $value;
      }
    }
    return $this;
  }

  /**
   * Implements StringInterface::getValues().
   */
  public function getValues(array $fields) {
    $values = array();
    foreach ($fields as $field) {
      if (isset($this->{$field})) {
        $values[$field] = $this->{$field};
      }
    }
    return $values;
  }

  /**
   * Implements StringInterface::getTextgroup().
   */
  public function getTextgroup() {
    return empty($this->textgroup) ? 'default' : $this->textgroup;
  }

  /**
   * Implements StringInterface::setTextgroup().
   */
  public function setTextgroup($textgroup) {
    $this->textgroup = $textgroup;
  }

  /**
   * Implements LocaleString::save().
   */
  public function save() {
    if ($storage = $this
      ->getStorage()) {
      $storage
        ->save($this);
    }
    else {
      throw new StringStorageException(format_string('The string cannot be saved because its not bound to a storage: @string', array(
        '@string' => $this
          ->getString(),
      )));
    }
    return $this;
  }

  /**
   * Implements LocaleString::delete().
   */
  public function delete() {
    if (!$this
      ->isNew()) {
      if ($storage = $this
        ->getStorage()) {
        $storage
          ->delete($this);
      }
      else {
        throw new StringStorageException(format_string('The string cannot be deleted because its not bound to a storage: @string', array(
          '@string' => $this
            ->getString(),
        )));
      }
    }
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$plid	public	property	The parent string identifier for plural translations.
StringBase::$plural	public	property	Plural index in case of plural string.
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::$textgroup	public	property	The string group.
StringBase::$version	public	property	The string version.
StringBase::delete	public	function	Implements LocaleString::delete(). Overrides StringInterface::delete	1
StringBase::getId	public	function	Implements StringInterface::getId(). Overrides StringInterface::getId
StringBase::getParentId	public	function	Implements StringInterface::getParentId(). Overrides StringInterface::getParentId	1
StringBase::getStorage	public	function	Implements StringInterface::getStorage(). Overrides StringInterface::getStorage
StringBase::getTextgroup	public	function	Implements StringInterface::getTextgroup(). Overrides StringInterface::getTextgroup
StringBase::getValues	public	function	Implements StringInterface::getValues(). Overrides StringInterface::getValues
StringBase::getVersion	public	function	Implements StringInterface::getVersion(). Overrides StringInterface::getVersion
StringBase::save	public	function	Implements LocaleString::save(). Overrides StringInterface::save	1
StringBase::setId	public	function	Implements StringInterface::setId(). Overrides StringInterface::setId
StringBase::setParentId	public	function	Implements StringInterface::setParentId(). Overrides StringInterface::setParentId
StringBase::setStorage	public	function	Implements StringInterface::setStorage(). Overrides StringInterface::setStorage
StringBase::setTextgroup	public	function	Implements StringInterface::setTextgroup(). Overrides StringInterface::setTextgroup
StringBase::setValues	public	function	Implements StringInterface::setValues(). Overrides StringInterface::setValues
StringBase::setVersion	public	function	Implements StringInterface::setVersion(). Overrides StringInterface::setVersion
StringBase::__construct	public	function	Constructs a new locale string object.	1
StringInterface::getString	public	function	Gets plain string contained in this object.	2
StringInterface::isNew	public	function	Checks whether the object is not saved to storage yet.	2
StringInterface::isSource	public	function	Checks whether the object is a source string.	2
StringInterface::isTranslation	public	function	Checks whether the object is a translation string.	2
StringInterface::setString	public	function	Sets the string contained in this object.	2