Skip to content

IFile

This interface represents a file in the directory tree.

A file is a bit of a broad definition. In general it implies that on this specific node a PUT or GET method may be performed, to either update, or retrieve the contents of the file.

Methods

put

Replaces the contents of the file.

public put(resource|string $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 resource|string

get

Returns the data.

public get(): mixed

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

getContentType

Returns the mime-type for a file.

public getContentType(): string|null

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

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.

Return null if the ETag can not effectively be determined.

The ETag must be surrounded by double-quotes, so something like this would make a valid ETag:

return '"someetag"';

getSize

Returns the size of the node, in bytes.

public getSize(): int

Inherited methods

delete

Deleted the current node.

public delete(): mixed

getName

Returns the name of the node.

public getName(): string

This is used to generate the url.

setName

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter Type Description
$name string The new name

getLastModified

Returns the last modification time, as a unix timestamp. Return null if the information is not available.

public getLastModified(): int|null

Automatically generated on 2025-03-18