interface LocaleProjectStorageInterface
Same name in other branches
- 9 core/modules/locale/src/LocaleProjectStorageInterface.php \Drupal\locale\LocaleProjectStorageInterface
- 8.9.x core/modules/locale/src/LocaleProjectStorageInterface.php \Drupal\locale\LocaleProjectStorageInterface
- 10 core/modules/locale/src/LocaleProjectStorageInterface.php \Drupal\locale\LocaleProjectStorageInterface
Defines the locale project storage interface.
Hierarchy
- interface \Drupal\locale\LocaleProjectStorageInterface
Expanded class hierarchy of LocaleProjectStorageInterface
All classes that implement LocaleProjectStorageInterface
File
-
core/
modules/ locale/ src/ LocaleProjectStorageInterface.php, line 8
Namespace
Drupal\localeView source
interface LocaleProjectStorageInterface {
/**
* Returns the stored value for a given key.
*
* @param string $key
* The key of the data to retrieve.
* @param mixed $default
* The default value to use if the key is not found.
*
* @return mixed
* The stored value, or the default value if no value exists.
*/
public function get($key, $default = NULL);
/**
* Returns a list of project records.
*
* @param array $keys
* A list of keys to retrieve.
*
* @return array
* An associative array of items successfully returned, indexed by key.
*/
public function getMultiple(array $keys);
/**
* Creates or updates the project record.
*
* @param string $key
* The key of the data to store.
* @param mixed $value
* The data to store.
*/
public function set($key, $value);
/**
* Creates or updates multiple project records.
*
* @param array $data
* An associative array of key/value pairs.
*/
public function setMultiple(array $data);
/**
* Deletes project records for a given key.
*
* @param string $key
* The key of the data to delete.
*/
public function delete($key);
/**
* Deletes multiple project records.
*
* @param array $keys
* A list of item names to delete.
*/
public function deleteMultiple(array $keys);
/**
* Returns all the project records.
*
* @return array
* An associative array of items successfully returned, indexed by key.
*/
public function getAll();
/**
* Deletes all projects records.
*
* @return array
* An associative array of items successfully returned, indexed by key.
*/
public function deleteAll();
/**
* Mark all projects as disabled.
*/
public function disableAll();
/**
* Resets the project storage cache.
*/
public function resetCache();
/**
* Returns the count of project records.
*
* @return int
* The number of saved items.
*/
public function countProjects();
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
LocaleProjectStorageInterface::countProjects | public | function | Returns the count of project records. |
LocaleProjectStorageInterface::delete | public | function | Deletes project records for a given key. |
LocaleProjectStorageInterface::deleteAll | public | function | Deletes all projects records. |
LocaleProjectStorageInterface::deleteMultiple | public | function | Deletes multiple project records. |
LocaleProjectStorageInterface::disableAll | public | function | Mark all projects as disabled. |
LocaleProjectStorageInterface::get | public | function | Returns the stored value for a given key. |
LocaleProjectStorageInterface::getAll | public | function | Returns all the project records. |
LocaleProjectStorageInterface::getMultiple | public | function | Returns a list of project records. |
LocaleProjectStorageInterface::resetCache | public | function | Resets the project storage cache. |
LocaleProjectStorageInterface::set | public | function | Creates or updates the project record. |
LocaleProjectStorageInterface::setMultiple | public | function | Creates or updates multiple project records. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.