Subscription

Subscription Node.

This node represents a subscription.

• Full name: \Sabre\CalDAV\Subscriptions\Subscription
• Parent class: \Sabre\DAV\Collection
• This class implements: \Sabre\CalDAV\Subscriptions\ISubscription, \Sabre\DAVACL\IACL

Properties

caldavBackend

caldavBackend.

protected \Sabre\CalDAV\Backend\SubscriptionSupport $caldavBackend

---

subscriptionInfo

subscriptionInfo.

protected array $subscriptionInfo

---

Methods

__construct

Constructor.

public __construct(\Sabre\CalDAV\Backend\SubscriptionSupport $caldavBackend, array $subscriptionInfo): mixed

Parameters:

Parameter	Type	Description
$caldavBackend	\Sabre\CalDAV\Backend\SubscriptionSupport
$subscriptionInfo	array

---

getName

Returns the name of the node.

public getName(): string

This is used to generate the url.

---

getLastModified

Returns the last modification time.

public getLastModified(): int|null

---

delete

Deletes the current node.

public delete(): mixed

---

getChildren

Returns an array with all the child nodes.

public getChildren(): \Sabre\DAV\INode[]

---

propPatch

Updates properties on this node.

public propPatch(\Sabre\DAV\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:

Parameter	Type	Description
$propPatch	\Sabre\DAV\PropPatch

---

getProperties

Returns a list of properties for this nodes.

public getProperties(array $properties): array

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:

Parameter	Type	Description
$properties	array

---

getOwner

Returns the owner principal.

public getOwner(): string|null

This must be a url to a principal, or null if there's no owner

---

getACL

Returns a list of ACE's for this node.

public getACL(): array

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.

---

Inherited methods

getLastModified

Returns the last modification time as a unix timestamp.

public getLastModified(): int

If the information is not available, return null.

---

delete

Deletes the current node.

public delete(): mixed

Throws:

• Forbidden

---

setName

Renames the node.

public setName(string $name): mixed

Parameters:

Parameter	Type	Description
$name	string	The new name

Throws:

• Forbidden

---

getChild

Returns a child object, by its name.

public getChild(string $name): \Sabre\DAV\INode

This method makes use of the getChildren method to grab all the child nodes, and compares the name. Generally its wise to override this, as this can usually be optimized

This method must throw Sabre\DAV\Exception\NotFound if the node does not exist.

Parameters:

Parameter	Type	Description
$name	string

Throws:

• NotFound

---

childExists

Checks is a child-node exists.

public childExists(string $name): bool

It is generally a good idea to try and override this. Usually it can be optimized.

Parameters:

Parameter	Type	Description
$name	string

---

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:

Parameter	Type	Description
$name	string	Name of the file
$data	resource|string	Initial payload

---

createDirectory

Creates a new subdirectory.

public createDirectory(string $name): mixed

Parameters:

Parameter	Type	Description
$name	string

Throws:

• Forbidden

---

getOwner

Returns the owner principal.

public getOwner(): string|null

This must be a url to a principal, or null if there's no owner

---

getGroup

Returns a group principal.

public getGroup(): string|null

This must be a url to a principal, or null if there's no owner

---

getACL

Returns a list of ACE's for this node.

public getACL(): array

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.

---

setACL

Updates the ACL.

public setACL(array $acl): mixed

This method will receive a list of new ACE's as an array argument.

Parameters:

Parameter	Type	Description
$acl	array

---

getSupportedPrivilegeSet

Returns the list of supported privileges for this node.

public getSupportedPrivilegeSet(): array|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.

---

---

Automatically generated on 2025-03-18