This interface represents a file in the directory tree. More...
Inheritance diagram for Sabre\DAV\IFile:
Collaboration diagram for Sabre\DAV\IFile:
Public Member Functions | |
| 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 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.
- Copyright
- Copyright (C) fruux GmbH (https://fruux.com/)
Member Function Documentation
◆ get()
| Sabre\DAV\IFile::get | ( | ) |
Returns the data.
This method may either return a string or a readable stream resource
- Returns
- mixed
Implemented in Sabre\DAV\TreeFileTester, Sabre\DAV\Mock\File, Sabre\DAV\FSExt\File, Sabre\CalDAV\CalendarObject, ilObjFileDAV, Sabre\DAV\SimpleFile, Sabre\DAV\PartialUpdate\FileMock, Sabre\CardDAV\Card, Sabre\CalDAV\Schedule\SchedulingObject, Sabre\DAV\Mock\StreamingFile, Sabre\DAV\File, and Sabre\DAV\FS\File.
◆ getContentType()
| Sabre\DAV\IFile::getContentType | ( | ) |
Returns the mime-type for a file.
If null is returned, we'll assume application/octet-stream
- Returns
- string|null
Implemented in Sabre\DAV\FSExt\File, Sabre\CalDAV\CalendarObject, Sabre\CardDAV\Card, Sabre\DAV\SimpleFile, ilObjFileDAV, Sabre\DAV\File, Sabre\DAV\FS\File, and Sabre\DAV\PartialUpdate\FileMock.
◆ getETag()
| Sabre\DAV\IFile::getETag | ( | ) |
Returns the ETag for a file.
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"';
- Returns
- string|null
Implemented in Sabre\DAV\ServerPreconditionsNode, Sabre\CalDAV\CalendarObject, ilObjFileDAV, Sabre\CardDAV\Card, Sabre\DAV\Mock\File, Sabre\DAV\FSExt\File, Sabre\DAV\SimpleFile, Sabre\DAV\PartialUpdate\FileMock, Sabre\CalDAV\Notifications\Node, Sabre\DAV\File, Sabre\DAV\Mock\StreamingFile, and Sabre\DAV\FS\File.
Referenced by Sabre\DAV\Server\checkPreconditions().
Here is the caller graph for this function:
◆ getSize()
| Sabre\DAV\IFile::getSize | ( | ) |
Returns the size of the node, in bytes.
- Returns
- int
Implemented in Sabre\CalDAV\CalendarObject, Sabre\CardDAV\Card, ilObjFileDAV, Sabre\DAV\FSExt\File, Sabre\DAV\Mock\File, Sabre\DAV\SimpleFile, Sabre\DAV\PartialUpdate\FileMock, Sabre\DAV\Mock\StreamingFile, Sabre\DAV\File, and Sabre\DAV\FS\File.
◆ put()
| Sabre\DAV\IFile::put | ( | $data | ) |
Replaces the contents of the file.
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
-
resource | string $data
- Returns
- string|null
Implemented in Sabre\CalDAV\CalendarObject, Sabre\DAV\Mock\File, Sabre\CardDAV\Card, Sabre\CalDAV\Schedule\SchedulingObject, ilObjFileDAV, Sabre\DAV\Mock\StreamingFile, Sabre\DAV\File, Sabre\DAV\FSExt\File, Sabre\DAV\FS\File, and Sabre\DAV\PartialUpdate\FileMock.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/dav/lib/DAV/IFile.php
