Documentation

NullAdapter extends AbstractAdapter
in package
Uses StreamedTrait, StreamedCopyTrait

Table of Contents

$pathPrefix  : string|null
$pathSeparator  : string
applyPathPrefix()  : string
Prefix a path.
copy()  : bool
Copy a file.
createDir()  : mixed
delete()  : mixed
deleteDir()  : mixed
getMetadata()  : mixed
getMimetype()  : mixed
getPathPrefix()  : string|null
Get the path prefix.
getSize()  : mixed
getTimestamp()  : mixed
getVisibility()  : mixed
has()  : bool
Check whether a file is present.
listContents()  : mixed
read()  : mixed
readStream()  : resource
removePathPrefix()  : string
Remove a path prefix.
rename()  : mixed
setPathPrefix()  : void
Set the path prefix.
setVisibility()  : mixed
update()  : mixed
write()  : mixed
writeStream()  : resource

Properties

Methods

applyPathPrefix()

Prefix a path.

public applyPathPrefix(string $path) : string
Parameters
$path : string
Return values
string —

prefixed path

copy()

Copy a file.

public copy(string $path, string $newpath) : bool
Parameters
$path : string
$newpath : string
Return values
bool —

createDir()

public createDir(mixed $dirname, Config $config) : mixed
Parameters
$dirname : mixed
$config : Config
Tags
inheritdoc
Return values
mixed —

delete()

public delete(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

deleteDir()

public deleteDir(mixed $dirname) : mixed
Parameters
$dirname : mixed
Tags
inheritdoc
Return values
mixed —

getMetadata()

public getMetadata(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

getMimetype()

public getMimetype(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

getPathPrefix()

Get the path prefix.

public getPathPrefix() : string|null
Return values
string|null —

path prefix or null if pathPrefix is empty

getSize()

public getSize(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

getTimestamp()

public getTimestamp(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

getVisibility()

public getVisibility(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

has()

Check whether a file is present.

public has(string $path) : bool
Parameters
$path : string
Return values
bool —

listContents()

public listContents([mixed $directory = '' ][, mixed $recursive = false ]) : mixed
Parameters
$directory : mixed = ''
$recursive : mixed = false
Tags
inheritdoc
Return values
mixed —

read()

public read(mixed $path) : mixed
Parameters
$path : mixed
Tags
inheritdoc
Return values
mixed —

readStream()

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

removePathPrefix()

Remove a path prefix.

public removePathPrefix(string $path) : string
Parameters
$path : string
Return values
string —

path without the prefix

rename()

public rename(mixed $path, mixed $newpath) : mixed
Parameters
$path : mixed
$newpath : mixed
Tags
inheritdoc
Return values
mixed —

setPathPrefix()

Set the path prefix.

public setPathPrefix(string $prefix) : void
Parameters
$prefix : string
Return values
void —

setVisibility()

public setVisibility(mixed $path, mixed $visibility) : mixed
Parameters
$path : mixed
$visibility : mixed
Tags
inheritdoc
Return values
mixed —

update()

public update(mixed $path, mixed $contents, Config $config) : mixed
Parameters
$path : mixed
$contents : mixed
$config : Config
Tags
inheritdoc
Return values
mixed —

write()

public write(mixed $path, mixed $contents, Config $config) : mixed
Parameters
$path : mixed
$contents : mixed
$config : Config
Tags
inheritdoc
Return values
mixed —

writeStream()

public abstract writeStream(string $path, resource $resource, Config $config) : resource
Parameters
$path : string
$resource : resource
$config : Config
Return values
resource —

Search results