FileStorage
class FileStorage implements PhpStorageInterface (View source)
Stores the code as regular PHP files.
Properties
| protected string | $directory | The directory where the files should be stored. |
Methods
Constructs this FileStorage object.
Checks whether the PHP code exists in storage.
Loads PHP code from storage.
Saves PHP code to storage.
Returns the standard .htaccess lines that Drupal writes to file directories.
Ensures the directory exists, has the right permissions, and a .htaccess.
Ensures the requested directory exists and has the right permissions.
Deletes PHP code from storage.
Gets the full file path.
Whether this is a writable storage.
Removes all files in this bin.
Deletes files and/or directories in the specified path.
Lists all the files in the storage.
Performs garbage collection on the storage.
Details
__construct(array $configuration)
Constructs this FileStorage object.
bool
exists(string $name)
Checks whether the PHP code exists in storage.
load(string $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).
bool
save(string $name, string $code)
Saves PHP code to storage.
static string
htaccessLines(bool $private = TRUE)
deprecated
deprecated
Returns the standard .htaccess lines that Drupal writes to file directories.
protected
ensureDirectory(string $directory, int $mode = 0777)
Ensures the directory exists, has the right permissions, and a .htaccess.
For compatibility with open_basedir, the requested directory is created using a recursion logic that is based on the relative directory path/tree: It works from the end of the path recursively back towards the root directory, until an existing parent directory is found. From there, the subdirectories are created.
protected bool
createDirectory(string $directory, int $mode = 0777)
Ensures the requested directory exists and has the right permissions.
For compatibility with open_basedir, the requested directory is created using a recursion logic that is based on the relative directory path/tree: It works from the end of the path recursively back towards the root directory, until an existing parent directory is found. From there, the subdirectories are created.
bool
delete(string $name)
Deletes PHP code from storage.
string|false
getFullPath(string $name)
Gets the full file path.
bool
writeable()
Whether this is a writable storage.
deleteAll()
Removes all files in this bin.
protected bool
unlink(string $path)
Deletes files and/or directories in the specified path.
If the specified path is a directory the method will call itself recursively to process the contents. Once the contents have been removed the directory will also be removed.
array
listAll()
Lists all the files in the storage.
garbageCollection()
Performs garbage collection on the storage.
The storage may choose to delete expired or invalidated items.