1. class
  2. Biigle
  3. \
  4. Filesystem
  5. \
  6. ElementsAdapter

ElementsAdapter

class ElementsAdapter extends ElementsAdapter

Properties

protected Client $client from  ElementsAdapter
protected array $cache

File information cache.

 from  ElementsAdapter
protected array $volumePathsCache

Caches the Elements volume paths.

 from  ElementsAdapter
protected array $contentCache

Directory content cache.

 from  ElementsAdapter

Methods

__construct(Client $client)

Constructor

from  ElementsAdapter
bool
fileExists(string $path)

{@inheritdoc}

from  ElementsAdapter
bool
directoryExists(string $path)

{@inheritdoc}

from  ElementsAdapter
void
write(string $path, string $contents, Config $config)

{@inheritdoc}

from  ElementsAdapter
void
writeStream(string $path, $contents, Config $config)

{@inheritdoc}

from  ElementsAdapter
string
read(string $path)

{@inheritdoc}

from  ElementsAdapter
readStream(string $path)

{@inheritdoc}

from  ElementsAdapter
void
delete(string $path)

{@inheritdoc}

from  ElementsAdapter
void
deleteDirectory(string $path)

{@inheritdoc}

from  ElementsAdapter
void
createDirectory(string $path, Config $config)

{@inheritdoc}

from  ElementsAdapter
void
setVisibility(string $path, string $visibility)

{@inheritdoc}

from  ElementsAdapter
FileAttributes
visibility(string $path)

{@inheritdoc}

from  ElementsAdapter
FileAttributes
mimeType(string $path)

{@inheritdoc}

from  ElementsAdapter
FileAttributes
lastModified(string $path)

{@inheritdoc}

from  ElementsAdapter
FileAttributes
fileSize(string $path)

{@inheritdoc}

from  ElementsAdapter
iterable
listContents(string $path, bool $deep)

{@inheritdoc}

from  ElementsAdapter
void
move(string $source, string $destination, Config $config)

{@inheritdoc}

from  ElementsAdapter
void
copy(string $source, string $destination, Config $config)

{@inheritdoc}

from  ElementsAdapter
array|null
getMediaFile(string $path)

Get the media file information.

from  ElementsAdapter
array
getMediaFiles(string $path)

Get the media file information for all files of a given parent.

from  ElementsAdapter
Response
getMediaFileDownload(string $path)

Get the content of a media file.

from  ElementsAdapter
FileAttributes
getFileMetadata(string $path, string $type)

No description

from  ElementsAdapter
DirectoryAttributes
getMetadata(string $path, string $type)

No description

from  ElementsAdapter
DirectoryAttributes
parseStorageAttributes(array $attributes)

No description

from  ElementsAdapter
void
fetchVolumePaths()

No description

from  ElementsAdapter
array
processFileRoots(array $roots)

No description

from  ElementsAdapter

Details

in ElementsAdapter at line 55
__construct(Client $client)

Constructor

Parameters

Client $client

in ElementsAdapter at line 66
bool fileExists(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

bool

in ElementsAdapter at line 80
bool directoryExists(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

bool

in ElementsAdapter at line 94
void write(string $path, string $contents, Config $config)

{@inheritdoc}

Parameters

string $path
string $contents
Config $config

Return Value

void

in ElementsAdapter at line 102
void writeStream(string $path, $contents, Config $config)

{@inheritdoc}

Parameters

string $path
$contents
Config $config

Return Value

void

in ElementsAdapter at line 110
string read(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

string

in ElementsAdapter at line 124
readStream(string $path)

{@inheritdoc}

Parameters

string $path

in ElementsAdapter at line 138
void delete(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

void

in ElementsAdapter at line 146
void deleteDirectory(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

void

in ElementsAdapter at line 154
void createDirectory(string $path, Config $config)

{@inheritdoc}

Parameters

string $path
Config $config

Return Value

void

in ElementsAdapter at line 162
void setVisibility(string $path, string $visibility)

{@inheritdoc}

Parameters

string $path
string $visibility

Return Value

void

in ElementsAdapter at line 170
FileAttributes visibility(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

FileAttributes

in ElementsAdapter at line 178
FileAttributes mimeType(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

FileAttributes

in ElementsAdapter at line 186
FileAttributes lastModified(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

FileAttributes

in ElementsAdapter at line 194
FileAttributes fileSize(string $path)

{@inheritdoc}

Parameters

string $path

Return Value

FileAttributes

in ElementsAdapter at line 202
iterable listContents(string $path, bool $deep)

{@inheritdoc}

Parameters

string $path
bool $deep

Return Value

iterable

in ElementsAdapter at line 214
void move(string $source, string $destination, Config $config)

{@inheritdoc}

Parameters

string $source
string $destination
Config $config

Return Value

void

in ElementsAdapter at line 222
void copy(string $source, string $destination, Config $config)

{@inheritdoc}

Parameters

string $source
string $destination
Config $config

Return Value

void

in ElementsAdapter at line 234
protected array|null getMediaFile(string $path)

Get the media file information.

Parameters

string $path

Return Value

array|null

in ElementsAdapter at line 257
protected array getMediaFiles(string $path)

Get the media file information for all files of a given parent.

Parameters

string $path

Path to the parent (directory)

Return Value

array

in ElementsAdapter at line 307
protected Response getMediaFileDownload(string $path)

Get the content of a media file.

Parameters

string $path

Return Value

Response

in ElementsAdapter at line 320
protected FileAttributes getFileMetadata(string $path, string $type)

No description

Parameters

string $path
string $type

Return Value

FileAttributes

in ElementsAdapter at line 331
protected DirectoryAttributes getMetadata(string $path, string $type)

No description

Parameters

string $path
string $type

Return Value

DirectoryAttributes

in ElementsAdapter at line 342
protected DirectoryAttributes parseStorageAttributes(array $attributes)

No description

Parameters

array $attributes

Return Value

DirectoryAttributes

in ElementsAdapter at line 364
protected void fetchVolumePaths()

No description

Return Value

void

in ElementsAdapter at line 373
protected array processFileRoots(array $roots)

No description

Parameters

array $roots

Return Value

array