Documentation

DropboxAdapter extends AbstractAdapter
in package
Uses NotSupportingVisibilityTrait

Table of Contents

$client  : Client
$pathPrefix  : string|null
$pathSeparator  : string
__construct()  : mixed
applyPathPrefix()  : string
Prefix a path.
copy()  : bool
{@inheritdoc}
createDir()  : mixed
{@inheritdoc}
createSharedLinkWithSettings()  : mixed
delete()  : bool
{@inheritdoc}
deleteDir()  : bool
{@inheritdoc}
getClient()  : Client
getMetadata()  : mixed
{@inheritdoc}
getMimetype()  : mixed
{@inheritdoc}
getPathPrefix()  : string|null
Get the path prefix.
getSize()  : mixed
{@inheritdoc}
getTemporaryLink()  : string
getTemporaryUrl()  : string
getThumbnail()  : mixed
getTimestamp()  : mixed
{@inheritdoc}
getUrl()  : string
getVisibility()  : mixed
Get the visibility of a file.
has()  : mixed
{@inheritdoc}
listContents()  : array<string|int, mixed>
{@inheritdoc}
read()  : mixed
{@inheritdoc}
readStream()  : mixed
{@inheritdoc}
removePathPrefix()  : string
Remove a path prefix.
rename()  : bool
{@inheritdoc}
setPathPrefix()  : void
Set the path prefix.
setVisibility()  : mixed
Set the visibility for a file.
update()  : mixed
{@inheritdoc}
updateStream()  : mixed
{@inheritdoc}
write()  : mixed
{@inheritdoc}
writeStream()  : mixed
{@inheritdoc}
normalizeResponse()  : array<string|int, mixed>
upload()  : array<string|int, mixed>|false

Properties

Methods

__construct()

public __construct(Client $client[, string $prefix = '' ]) : mixed
Parameters
$client : Client
$prefix : string = ''
Return values
mixed —

applyPathPrefix()

Prefix a path.

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

prefixed path

copy()

{@inheritdoc}

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

createDir()

{@inheritdoc}

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

createSharedLinkWithSettings()

public createSharedLinkWithSettings(mixed $path, mixed $settings) : mixed
Parameters
$path : mixed
$settings : mixed
Return values
mixed —

delete()

{@inheritdoc}

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

deleteDir()

{@inheritdoc}

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

getMetadata()

{@inheritdoc}

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

getMimetype()

{@inheritdoc}

public getMimetype(mixed $path) : mixed
Parameters
$path : mixed
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()

{@inheritdoc}

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

getTemporaryLink()

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

getTemporaryUrl()

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

getThumbnail()

public getThumbnail(string $path[, string $format = 'jpeg' ][, string $size = 'w64h64' ]) : mixed
Parameters
$path : string
$format : string = 'jpeg'
$size : string = 'w64h64'
Return values
mixed —

getTimestamp()

{@inheritdoc}

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

getUrl()

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

getVisibility()

Get the visibility of a file.

public getVisibility(string $path) : mixed
Parameters
$path : string
Tags
throws
LogicException
Return values
mixed —

has()

{@inheritdoc}

public has(mixed $path) : mixed
Parameters
$path : mixed
Return values
mixed —

listContents()

{@inheritdoc}

public listContents([mixed $directory = '' ][, mixed $recursive = false ]) : array<string|int, mixed>
Parameters
$directory : mixed = ''
$recursive : mixed = false
Return values
array<string|int, mixed> —

read()

{@inheritdoc}

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

readStream()

{@inheritdoc}

public readStream(mixed $path) : mixed
Parameters
$path : mixed
Return values
mixed —

removePathPrefix()

Remove a path prefix.

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

path without the prefix

rename()

{@inheritdoc}

public rename(mixed $path, mixed $newPath) : bool
Parameters
$path : mixed
$newPath : mixed
Return values
bool —

setPathPrefix()

Set the path prefix.

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

setVisibility()

Set the visibility for a file.

public setVisibility(string $path, string $visibility) : mixed
Parameters
$path : string
$visibility : string
Tags
throws
LogicException
Return values
mixed —

update()

{@inheritdoc}

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

updateStream()

{@inheritdoc}

public updateStream(mixed $path, mixed $resource, Config $config) : mixed
Parameters
$path : mixed
$resource : mixed
$config : Config
Return values
mixed —

write()

{@inheritdoc}

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

writeStream()

{@inheritdoc}

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

normalizeResponse()

protected normalizeResponse(array<string|int, mixed> $response) : array<string|int, mixed>
Parameters
$response : array<string|int, mixed>
Return values
array<string|int, mixed> —

upload()

protected upload(string $path, resource|string $contents, string $mode) : array<string|int, mixed>|false
Parameters
$path : string
$contents : resource|string
$mode : string
Return values
array<string|int, mixed>|false —

file metadata

Search results