ICalendarObject
extends
IFile
in
CalendarObject interface.
Extend the ICalendarObject interface to allow your custom nodes to be picked up as CalendarObjects.
Calendar objects are resources such as Events, Todo's or Journals.
Tags
Table of Contents
- delete() : mixed
- Deleted 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|null
- Returns the last modification time, as a unix timestamp. Return null if the information is not available.
- getName() : string
- Returns the name of the node.
- getSize() : int
- Returns the size of the node, in bytes.
- put() : string|null
- Replaces the contents of the file.
- setName() : mixed
- Renames the node.
Methods
delete()
Deleted the current node.
public
delete() : mixed
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.
The ETag must be surrounded by double-quotes, so something like this would make a valid ETag:
return '"someetag"';
Return values
string|null —getLastModified()
Returns the last modification time, as a unix timestamp. Return null if the information is not available.
public
getLastModified() : int|null
Return values
int|null —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()
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
- $data : resource|string
Return values
string|null —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name