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. More...
Inheritance diagram for Sabre\DAV\PartialUpdate\IPatchSupport:
Collaboration diagram for Sabre\DAV\PartialUpdate\IPatchSupport:
Public Member Functions | |
| patch ($data, $rangeType, $offset=null) | |
| Updates the file based on a range specification. More... | |
| Public Member Functions inherited from Sabre\DAV\IFile | |
| put ($data) | |
| Replaces the contents of the file. More... | |
| get () | |
| Returns the data. More... | |
| getContentType () | |
| Returns the mime-type for a file. More... | |
| getETag () | |
| Returns the ETag for a file. More... | |
| getSize () | |
| Returns the size of the node, in bytes. More... | |
| Public Member Functions inherited from Sabre\DAV\INode | |
| delete () | |
| Deleted the current node. More... | |
| getName () | |
| Returns the name of the node. More... | |
| setName ($name) | |
| Renames the node. More... | |
| getLastModified () | |
| Returns the last modification time, as a unix timestamp. More... | |
Detailed Description
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.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Definition at line 16 of file IPatchSupport.php.
Member Function Documentation
◆ patch()
| Sabre\DAV\PartialUpdate\IPatchSupport::patch | ( | $data, | |
| $rangeType, | |||
$offset = null |
|||
| ) |
Updates the file based on a range specification.
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
- 2. update based on a start byte
- 3. 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
-
resource | string $data int $rangeType int $offset
- Returns
- string|null
Implemented in Sabre\DAV\FSExt\File, and Sabre\DAV\PartialUpdate\FileMock.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAV/PartialUpdate/IPatchSupport.php
