ICalendar
extends
ICalendarObjectContainer, IACL
in
Calendar interface.
Implement this interface to allow a node to be recognized as an calendar.
Tags
Table of Contents
- calendarQuery() : array<string|int, mixed>
- Performs a calendar-query on the contents of this calendar.
- childExists() : bool
- Checks if a child-node with the specified name exists.
- createDirectory() : mixed
- Creates a new subdirectory.
- createFile() : string|null
- Creates a new file in the directory.
- delete() : mixed
- Deleted the current node.
- getACL() : array<string|int, mixed>
- Returns a list of ACE's for this node.
- getChild() : INode
- Returns a specific child node, referenced by its name.
- getChildren() : array<string|int, INode>
- Returns an array with all the child nodes.
- getGroup() : string|null
- Returns a group principal.
- 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.
- getOwner() : string|null
- Returns the owner principal.
- getSupportedPrivilegeSet() : array<string|int, mixed>|null
- Returns the list of supported privileges for this node.
- setACL() : mixed
- Updates the ACL.
- setName() : mixed
- Renames the node.
Methods
calendarQuery()
Performs a calendar-query on the contents of this calendar.
public
calendarQuery(array<string|int, mixed> $filters) : array<string|int, mixed>
The calendar-query is defined in RFC4791 : CalDAV. Using the calendar-query it is possible for a client to request a specific set of object, based on contents of iCalendar properties, date-ranges and iCalendar component types (VTODO, VEVENT).
This method should just return a list of (relative) urls that match this query.
The list of filters are specified as an array. The exact array is documented by \Sabre\CalDAV\CalendarQueryParser.
Parameters
- $filters : array<string|int, mixed>
Return values
array<string|int, mixed> —childExists()
Checks if a child-node with the specified name exists.
public
childExists(string $name) : bool
Parameters
- $name : string
Return values
bool —createDirectory()
Creates a new subdirectory.
public
createDirectory(string $name) : mixed
Parameters
- $name : string
Return values
mixed —createFile()
Creates a new file in the directory.
public
createFile(string $name[, resource|string $data = null ]) : string|null
Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.
After successful creation of the file, you may choose to return the ETag of the new file here.
The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).
If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.
This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.
Parameters
- $name : string
-
Name of the file
- $data : resource|string = null
-
Initial payload
Return values
string|null —delete()
Deleted the current node.
public
delete() : mixed
Return values
mixed —getACL()
Returns a list of ACE's for this node.
public
getACL() : array<string|int, mixed>
Each ACE has the following properties:
- 'privilege', a string such as {DAV:}read or {DAV:}write. These are currently the only supported privileges
- 'principal', a url to the principal who owns the node
- 'protected' (optional), indicating that this ACE is not allowed to be updated.
Return values
array<string|int, mixed> —getChild()
Returns a specific child node, referenced by its name.
public
getChild(string $name) : INode
This method must throw Sabre\DAV\Exception\NotFound if the node does not exist.
Parameters
- $name : string
Return values
INode —getChildren()
Returns an array with all the child nodes.
public
getChildren() : array<string|int, INode>
Return values
array<string|int, INode> —getGroup()
Returns a group principal.
public
getGroup() : string|null
This must be a url to a principal, or null if there's no owner
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 —getOwner()
Returns the owner principal.
public
getOwner() : string|null
This must be a url to a principal, or null if there's no owner
Return values
string|null —getSupportedPrivilegeSet()
Returns the list of supported privileges for this node.
public
getSupportedPrivilegeSet() : array<string|int, mixed>|null
The returned data structure is a list of nested privileges. See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple standard structure.
If null is returned from this method, the default privilege set is used, which is fine for most common usecases.
Return values
array<string|int, mixed>|null —setACL()
Updates the ACL.
public
setACL(array<string|int, mixed> $acl) : mixed
This method will receive a list of new ACE's as an array argument.
Parameters
- $acl : array<string|int, mixed>
Return values
mixed —setName()
Renames the node.
public
setName(string $name) : mixed
Parameters
- $name : string
-
The new name