Documentation

Subscription extends Collection
in package

Application

implements ISubscription, IACL Uses ACLTrait

Subscription Node.

This node represents a subscription.

Interfaces, Classes and Traits

ISubscription: ISubscription.
IACL: ACL-enabled node.

$caldavBackend : SubscriptionSupport: caldavBackend.
$subscriptionInfo : array<string|int, mixed>: subscriptionInfo.
__construct() : mixed: Constructor.
childExists() : bool: Checks is a child-node exists.
createDirectory() : mixed: Creates a new subdirectory.
createFile() : string|null: Creates a new file in the directory.
delete() : mixed: Deletes the current node.
getACL() : array<string|int, mixed>: Returns a list of ACE's for this node.
getChild() : INode: Returns a child object, 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: Returns the last modification time.
getName() : string: Returns the name of the node.
getOwner() : string|null: Returns the owner principal.
getProperties() : array<string|int, mixed>: Returns a list of properties for this nodes.
getSupportedPrivilegeSet() : array<string|int, mixed>|null: Returns the list of supported privileges for this node.
propPatch() : mixed: Updates properties on this node.
setACL() : mixed: Updates the ACL.
setName() : mixed: Renames the node.

$caldavBackend

caldavBackend.


    protected
        SubscriptionSupport
    $caldavBackend

$subscriptionInfo

subscriptionInfo.


    protected
        array<string|int, mixed>
    $subscriptionInfo

__construct()

Constructor.


    public
                __construct(SubscriptionSupport $caldavBackend, array<string|int, mixed> $subscriptionInfo) : mixed

Parameters

$caldavBackend : SubscriptionSupport
$subscriptionInfo : array<string|int, mixed>

Return values

mixed —

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

$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()

Deletes 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 child object, by its name.


    public
                getChild(string $name) : 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

$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.


    public
                getLastModified() : int

Return values

int —

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 —

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

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 —

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 —

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

Return values

mixed —