diff options
Diffstat (limited to 'sites/all/modules/l10n_update/includes/locale/StringBase.php')
-rw-r--r-- | sites/all/modules/l10n_update/includes/locale/StringBase.php | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/sites/all/modules/l10n_update/includes/locale/StringBase.php b/sites/all/modules/l10n_update/includes/locale/StringBase.php new file mode 100644 index 000000000..a623a4da5 --- /dev/null +++ b/sites/all/modules/l10n_update/includes/locale/StringBase.php @@ -0,0 +1,184 @@ +<?php + +/** + * @file + * Definition of StringBase. + */ + +/** + * 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. + */ +abstract class StringBase implements StringInterface { + /** + * The string identifier. + * + * @var integer + */ + public $lid; + + /** + * 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 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::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::getPlurals(). + */ + public function getPlurals() { + return explode(L10N_UPDATE_PLURAL_DELIMITER, $this->getString()); + } + + /** + * Implements StringInterface::setPlurals(). + */ + public function setPlurals($plurals) { + $this->setString(implode(L10N_UPDATE_PLURAL_DELIMITER, $plurals)); + return $this; + } + + /** + * Implements StringInterface::getStorage(). + */ + public function getStorage() { + return isset($this->storage) ? $this->storage : NULL; + } + + /** + * Implements StringInterface::setStorage(). + */ + public function setStorage($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 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; + } + +} |