Documentation

StreamingFile extends File
in package

Mock Streaming File File.

Works similar to the mock file, but this one works with streams and has no content-length or etags.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Table of Contents

$contents  : mixed
$lastModified  : mixed
$name  : mixed
$parent  : mixed
$size  : mixed
__construct()  : mixed
Creates the object.
delete()  : mixed
Deletes the current node.
get()  : mixed
Returns the data.
getContentType()  : string|null
Returns the mime-type for a file.
getETag()  : string|null
Returns the ETag for a file.
getLastModified()  : int
Returns the last modification time as a unix timestamp.
getName()  : string
Returns the name of the node.
getSize()  : int
Returns the size of the node, in bytes.
put()  : string|null
Updates the data.
setName()  : mixed
Renames the node.
setSize()  : mixed
Allows testing scripts to set the resource's file size.

Properties

$contents

protected mixed $contents

$lastModified

protected mixed $lastModified

$name

protected mixed $name

$parent

protected mixed $parent

Methods

__construct()

Creates the object.

public __construct(string $name, resource $contents[, Collection $parent = null ][, int $lastModified = -1 ]) : mixed
Parameters
$name : string
$contents : resource
$parent : Collection = null
$lastModified : int = -1
Return values
mixed —

delete()

Deletes the current node.

public delete() : mixed
Tags
throws
Forbidden
Return values
mixed —

get()

Returns the data.

public get() : mixed

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

Return values
mixed —

getContentType()

Returns the mime-type for a file.

public getContentType() : string|null

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

Return values
string|null —

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

Return values
string|null —

getLastModified()

Returns the last modification time as a unix timestamp.

public getLastModified() : int

If the information is not available, return null.

Return values
int —

getName()

Returns the name of the node.

public getName() : string

This is used to generate the url.

Return values
string —

getSize()

Returns the size of the node, in bytes.

public getSize() : int
Return values
int —

put()

Updates the data.

public put(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
$data : resource
Return values
string|null —

setName()

Renames the node.

public setName(string $name) : mixed
Parameters
$name : string

The new name

Tags
throws
Forbidden
Return values
mixed —

setSize()

Allows testing scripts to set the resource's file size.

public setSize(int $size) : mixed
Parameters
$size : int
Return values
mixed —

Search results