Documentation

ISubscription extends ICollection, IProperties
in

ISubscription.

Nodes implementing this interface represent calendar subscriptions.

The subscription node doesn't do much, other than returning and updating subscription-related properties.

The following properties should be supported:

  1. {DAV:}displayname
  2. {http://apple.com/ns/ical/}refreshrate
  3. {http://calendarserver.org/ns/}subscribed-strip-todos (omit if todos should not be stripped).
  4. {http://calendarserver.org/ns/}subscribed-strip-alarms (omit if alarms should not be stripped).
  5. {http://calendarserver.org/ns/}subscribed-strip-attachments (omit if attachments should not be stripped).
  6. {http://calendarserver.org/ns/}source (Must be a Sabre\DAV\Property\Href).
  7. {http://apple.com/ns/ical/}calendar-color
  8. {http://apple.com/ns/ical/}calendar-order

It is recommended to support every property.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Table of Contents

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.
getChild()  : INode
Returns a specific child node, referenced by its name.
getChildren()  : array<string|int, INode>
Returns an array with all the child nodes.
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.
getProperties()  : array<string|int, mixed>
Returns a list of properties for this nodes.
propPatch()  : mixed
Updates properties on this node.
setName()  : mixed
Renames the node.

Methods

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 —

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> —

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 —

getProperties()

Returns a list of properties for this nodes.

public getProperties(array<string|int, mixed> $properties) : array<string|int, mixed>

The properties list is a list of propertynames the client requested, encoded in clark-notation {xmlnamespace}tagname

If the array is empty, it means 'all properties' were requested.

Note that it's fine to liberally give properties back, instead of conforming to the list of requested properties. The Server class will filter out the extra.

Parameters
$properties : array<string|int, mixed>
Return values
array<string|int, mixed> —

propPatch()

Updates properties on this node.

public propPatch(PropPatch $propPatch) : mixed

This method received a PropPatch object, which contains all the information about the update.

To update specific properties, call the 'handle' method on this object. Read the PropPatch documentation for more information.

Parameters
$propPatch : PropPatch
Return values
mixed —

setName()

Renames the node.

public setName(string $name) : mixed
Parameters
$name : string

The new name

Return values
mixed —

Search results