Documentation

FileMock
in package
implements IPatchSupport

Interfaces, Classes and Traits

IPatchSupport
This interface provides a way to modify only part of a target resource It may be used to update a file chunk, upload big a file into smaller chunks or resume an upload.

Table of Contents

$data  : mixed
delete()  : mixed
get()  : mixed
getContentType()  : mixed
getETag()  : mixed
getLastModified()  : mixed
getName()  : mixed
getSize()  : mixed
patch()  : string|null
Updates the file based on a range specification.
put()  : mixed
setName()  : mixed

Properties

Methods

delete()

public delete() : mixed
Return values
mixed —

get()

public get() : mixed
Return values
mixed —

getContentType()

public getContentType() : mixed
Return values
mixed —

getETag()

public getETag() : mixed
Return values
mixed —

getLastModified()

public getLastModified() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getSize()

public getSize() : mixed
Return values
mixed —

patch()

Updates the file based on a range specification.

public patch(resource|string $data, int $rangeType[, int $offset = null ]) : string|null

The first argument is the data, which is either a readable stream resource or a string.

The second argument is the type of update we're doing. This is either:

    1. append
    1. update based on a start byte
    1. update based on an end byte ; The third argument is the start or end byte.

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.

Parameters
$data : resource|string
$rangeType : int
$offset : int = null
Return values
string|null —

put()

public put(mixed $str) : mixed
Parameters
$str : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

Search results