Documentation

ReadInterface

Table of Contents

getMetadata()  : array<string|int, mixed>|false
Get all the meta data of a file or directory.
getMimetype()  : array<string|int, mixed>|false
Get the mimetype of a file.
getSize()  : array<string|int, mixed>|false
Get the size of a file.
getTimestamp()  : array<string|int, mixed>|false
Get the last modified time of a file as a timestamp.
getVisibility()  : array<string|int, mixed>|false
Get the visibility of a file.
has()  : array<string|int, mixed>|bool|null
Check whether a file exists.
listContents()  : array<string|int, mixed>
List contents of a directory.
read()  : array<string|int, mixed>|false
Read a file.
readStream()  : array<string|int, mixed>|false
Read a file as a stream.

Methods

getMetadata()

Get all the meta data of a file or directory.

public getMetadata(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

getMimetype()

Get the mimetype of a file.

public getMimetype(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

getSize()

Get the size of a file.

public getSize(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

getTimestamp()

Get the last modified time of a file as a timestamp.

public getTimestamp(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

getVisibility()

Get the visibility of a file.

public getVisibility(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

has()

Check whether a file exists.

public has(string $path) : array<string|int, mixed>|bool|null
Parameters
$path : string
Return values
array<string|int, mixed>|bool|null

listContents()

List contents of a directory.

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

read()

Read a file.

public read(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

readStream()

Read a file as a stream.

public readStream(string $path) : array<string|int, mixed>|false
Parameters
$path : string
Return values
array<string|int, mixed>|false

Search results