Documentation

MetadataCachingAdapter
in package
implements FilesystemAdapter, PublicUrlGenerator uses IndirectAdapterTrait

FinalYes

This adapter will cache the results of any of the metadata retrievers and reuse them.

Use this only for adapters that retrieve all metadata for calls to lastModified and mimeType etc

Table of Contents

Interfaces

FilesystemAdapter
PublicUrlGenerator

Properties

$base  : FilesystemAdapter
$fileAttributeCache  : array<string, FileAttributes>

Methods

__construct()  : mixed
copy()  : void
createDirectory()  : void
delete()  : void
deleteDirectory()  : void
directoryExists()  : bool
fileExists()  : bool
fileSize()  : FileAttributes
lastModified()  : FileAttributes
listContents()  : iterable<string|int, StorageAttributes>
mimeType()  : FileAttributes
move()  : void
publicUrl()  : string
read()  : string
readStream()  : resource
setVisibility()  : void
visibility()  : FileAttributes
write()  : void
writeStream()  : void
getAdapter()  : FilesystemAdapter
preparePath()  : string

Properties

Methods

__construct()

public __construct(FilesystemAdapter $base) : mixed
Parameters
$base : FilesystemAdapter

copy()

public copy(string $source, string $destination, Config $config) : void
Parameters
$source : string
$destination : string
$config : Config

createDirectory()

public createDirectory(string $path, Config $config) : void
Parameters
$path : string
$config : Config

deleteDirectory()

public deleteDirectory(string $path) : void
Parameters
$path : string

directoryExists()

public directoryExists(string $path) : bool
Parameters
$path : string
Return values
bool

fileExists()

public fileExists(string $path) : bool
Parameters
$path : string
Return values
bool

fileSize()

public fileSize(string $path) : FileAttributes
Parameters
$path : string
Return values
FileAttributes

lastModified()

public lastModified(string $path) : FileAttributes
Parameters
$path : string
Return values
FileAttributes

listContents()

public listContents(string $path, bool $deep) : iterable<string|int, StorageAttributes>
Parameters
$path : string
$deep : bool
Return values
iterable<string|int, StorageAttributes>

mimeType()

public mimeType(string $path) : FileAttributes
Parameters
$path : string
Return values
FileAttributes

move()

public move(string $source, string $destination, Config $config) : void
Parameters
$source : string
$destination : string
$config : Config

publicUrl()

public publicUrl(string $path, Config $config) : string
Parameters
$path : string
$config : Config
Return values
string

read()

public read(string $path) : string
Parameters
$path : string
Return values
string

readStream()

public readStream(string $path) : resource
Parameters
$path : string
Return values
resource

setVisibility()

public setVisibility(string $path, string $visibility) : void
Parameters
$path : string
$visibility : string

visibility()

public visibility(string $path) : FileAttributes
Parameters
$path : string
Return values
FileAttributes

write()

public write(string $path, string $contents, Config $config) : void
Parameters
$path : string
$contents : string
$config : Config

writeStream()

public writeStream(string $path, resource $contents, Config $config) : void
Parameters
$path : string
$contents : resource
$config : Config

getAdapter()

protected getAdapter(string $rawPath, string $preparedPath) : FilesystemAdapter
Parameters
$rawPath : string
$preparedPath : string
Return values
FilesystemAdapter

preparePath()

protected preparePath(string $path) : string
Parameters
$path : string
Return values
string

        
On this page

Search results