Stores and loads PHP code.
Each interface function takes $name as a parameter. This is a virtual file name: for example, 'foo.php' or 'some/relative/path/to/foo.php'. The storage implementation may store these as files within the local file system, use a remote stream, combine multiple virtual files into an archive, store them in database records, or use some other storage technique.
Expanded class hierarchy of PhpStorageInterface
All classes that implement PhpStorageInterface
interface PhpStorageInterface {
/**
* Checks whether the PHP code exists in storage.
*
* @param string $name
* The virtual file name. Can be a relative path.
*
* @return bool
* TRUE if the virtual file exists, FALSE otherwise.
*/
public function exists($name);
/**
* Loads PHP code from storage.
*
* Depending on storage implementation, exists() checks can be expensive, so
* this function may be called for a file that doesn't exist, and that should
* not result in errors. This function does not return anything, so it is
* up to the caller to determine if any code was loaded (for example, check
* class_exists() or function_exists() for what was expected in the code).
*
* @param string $name
* The virtual file name. Can be a relative path.
*/
public function load($name);
/**
* Saves PHP code to storage.
*
* @param string $name
* The virtual file name. Can be a relative path.
* @param string $code
* The PHP code to be saved.
*
* @return bool
* TRUE if the save succeeded, FALSE if it failed.
*/
public function save($name, $code);
/**
* Whether this is a writeable storage.
*
* @return bool
*/
public function writeable();
/**
* Deletes PHP code from storage.
*
* @param string $name
* The virtual file name. Can be a relative path.
*
* @return bool
* TRUE if the delete succeeded, FALSE if it failed.
*/
public function delete($name);
/**
* Removes all files in this bin.
*/
public function deleteAll();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PhpStorageInterface:: |
public | function | Whether this is a writeable storage. | 2 |
PhpStorageInterface:: |
public | function | Saves PHP code to storage. | 2 |
PhpStorageInterface:: |
public | function | Loads PHP code from storage. | 2 |
PhpStorageInterface:: |
public | function | Checks whether the PHP code exists in storage. | 2 |
PhpStorageInterface:: |
public | function | Removes all files in this bin. | 2 |
PhpStorageInterface:: |
public | function | Deletes PHP code from storage. | 2 |