PHP Interface Webiny\Component\Storage\Driver\DriverInterface

Public Methods

Method	Description
createDateFolderStructure ( ) : boolean	Does this storage create a date folder structure?
deleteKey ( string $key ) : boolean	Deletes the file
getContents ( string $key ) : string \| boolean	Reads the contents of the file
getKeys ( string $key = '', boolean \| integer $recursive = false ) : array	Returns an array of all keys (files and directories)
getRecentKey ( ) : string \| null	Returns most recent file key that was used by a storage
getTimeModified ( string $key ) : integer \| boolean	Returns the last modified time
getURL ( $key ) : mixed	Returns public file URL
keyExists ( string $key ) : boolean	Checks whether the file exists
renameKey ( string $sourceKey, string $targetKey ) : boolean	Renames a file
setContents ( $key, $contents, boolean $append = false ) : boolean \| integer	Writes the given File

Does this storage create a date folder structure?

public createDateFolderStructure ( ) : boolean
return	boolean

Deletes the file

public deleteKey ( string $key ) : boolean
$key	string
return	boolean

Reads the contents of the file

public getContents ( string $key ) : string \| boolean
$key	string
return	string \| boolean	if cannot read content

For storages that do not support directories, both parameters are irrelevant.

public getKeys ( string $key = '', boolean \| integer $recursive = false ) : array
$key	string	(Optional) Key of a directory to get keys from. If not set - keys will be read from the storage root.
$recursive	boolean \| integer	(Optional) Read all items recursively. Pass integer value to specify recursion depth.
return	array

Returns most recent file key that was used by a storage

public getRecentKey ( ) : string \| null
return	string \| null

Returns the last modified time

public getTimeModified ( string $key ) : integer \| boolean
$key	string
return	integer \| boolean	A UNIX like timestamp or false

Returns public file URL

Checks whether the file exists

public keyExists ( string $key ) : boolean
$key	string
return	boolean

Renames a file

public renameKey ( string $sourceKey, string $targetKey ) : boolean
$sourceKey	string
$targetKey	string
return	boolean

Writes the given File

public setContents ( $key, $contents, boolean $append = false ) : boolean \| integer
$key
$contents
$append	boolean
return	boolean \| integer	The number of bytes that were written into the file