Skip to content

File

File class.

This is a helper class, that should aid in getting file classes setup. Most of its methods are implemented, and throw permission denied exceptions

Methods

put

Replaces the contents of the file.

public put(string|resource $data): string|null

The data argument is a readable stream resource.

After a successful put operation, you may choose to return an ETag. The etag must always be surrounded by double-quotes. These quotes must appear in the actual string you're returning.

Clients may use the ETag from a PUT request to later on make sure that when they update the file, the contents haven't changed in the mean time.

If you don't plan to store the file byte-by-byte, and you return a different object on a subsequent GET you are strongly recommended to not return an ETag, and just return null.

Parameters:

Parameter Type Description
$data string|resource

get

Returns the data.

public get(): mixed

This method may either return a string or a readable stream resource

getSize

Returns the size of the file, in bytes.

public getSize(): int

getETag

Returns the ETag for a file.

public getETag(): string|null

An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change. The ETag is an arbitrary string, but MUST be surrounded by double-quotes.

Return null if the ETag can not effectively be determined

getContentType

Returns the mime-type for a file.

public getContentType(): string|null

If null is returned, we'll assume application/octet-stream

Inherited methods

getLastModified

Returns the last modification time as a unix timestamp.

public getLastModified(): int

If the information is not available, return null.

delete

Deletes the current node.

public delete(): mixed

Throws:

setName

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter Type Description
$name string The new name

Throws:

Automatically generated on 2025-03-18