Inheritance diagram for Sabre\CalDAV\Subscriptions\Subscription:

Collaboration diagram for Sabre\CalDAV\Subscriptions\Subscription:

Public Member Functions
	__construct (SubscriptionSupport $caldavBackend, array $subscriptionInfo)
	Constructor. More...

	getName ()
	Returns the name of the node. More...

	getLastModified ()
	Returns the last modification time. More...

	delete ()
	Deletes the current node. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	propPatch (PropPatch $propPatch)
	Updates properties on this node. More...

	getProperties ($properties)
	Returns a list of properties for this nodes. More...

	getOwner ()
	Returns the owner principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

Public Member Functions inherited from Sabre\DAV\Collection
	getChild ($name)
	Returns a child object, by its name. More...

	childExists ($name)
	Checks is a child-node exists. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

	delete ()
	Deletes the current node. More...

	setName ($name)
	Renames the node. More...

	delete ()
	Deleted the current node. More...

	getName ()
	Returns the name of the node. More...

	setName ($name)
	Renames the node. More...

	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

	getChild ($name)
	Returns a specific child node, referenced by its name. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	childExists ($name)
	Checks if a child-node with the specified name exists. More...

	propPatch (PropPatch $propPatch)
	Updates properties on this node. More...

	getProperties ($properties)
	Returns a list of properties for this nodes. More...

Public Member Functions inherited from Sabre\DAVACL\IACL
	getOwner ()
	Returns the owner principal. More...

	getGroup ()
	Returns a group principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

	setACL (array $acl)
	Updates the ACL. More...

	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...

Protected Attributes
	$caldavBackend

	$subscriptionInfo

Detailed Description

Subscription Node.

This node represents a subscription.

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

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 21 of file Subscription.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Subscriptions\Subscription::__construct	(	SubscriptionSupport	$caldavBackend,
		array	$subscriptionInfo
	)

Constructor.

Parameters

SubscriptionSupport	$caldavBackend
array	$subscriptionInfo

Definition at line 45 of file Subscription.php.

                                                                                      {
 
        $this->caldavBackend = $caldavBackend;
        $this->subscriptionInfo = $subscriptionInfo;
 
        $required = [
            'id',
            'uri',
            'principaluri',
            'source',
            ];
 
        foreach ($required as $r) {
            if (!isset($subscriptionInfo[$r])) {
                throw new \InvalidArgumentException('The ' . $r . ' field is required when creating a subscription node');
            }
        }
 
    }

References Sabre\CalDAV\Subscriptions\Subscription\$caldavBackend, $r, and Sabre\CalDAV\Subscriptions\Subscription\$subscriptionInfo.

Member Function Documentation

◆ delete()

Sabre\CalDAV\Subscriptions\Subscription::delete ( )

Deletes the current node.

Returns: void

Implements Sabre\DAV\INode.

Definition at line 96 of file Subscription.php.

                      {
 
        $this->caldavBackend->deleteSubscription(
            $this->subscriptionInfo['id']
        );
 
    }

◆ getACL()

Sabre\CalDAV\Subscriptions\Subscription::getACL ( )

Returns a list of ACE's for this node.

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.

Returns: array

Implements Sabre\DAVACL\IACL.

Definition at line 199 of file Subscription.php.

                      {
 
        return [
            [
                'privilege' => '{DAV:}all',
                'principal' => $this->getOwner(),
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}all',
                'principal' => $this->getOwner() . '/calendar-proxy-write',
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}read',
                'principal' => $this->getOwner() . '/calendar-proxy-read',
                'protected' => true,
            ]
        ];
 
    }

References Sabre\CalDAV\Subscriptions\Subscription\getOwner().

Here is the call graph for this function:

◆ getChildren()

Sabre\CalDAV\Subscriptions\Subscription::getChildren ( )

Returns an array with all the child nodes.

Returns: \Sabre\DAV\INode[]

Implements Sabre\DAV\ICollection.

Definition at line 109 of file Subscription.php.

◆ getLastModified()

Sabre\CalDAV\Subscriptions\Subscription::getLastModified ( )

Returns the last modification time.

Returns: int

Implements Sabre\DAV\INode.

Definition at line 83 of file Subscription.php.

                               {
 
        if (isset($this->subscriptionInfo['lastmodified'])) {
            return $this->subscriptionInfo['lastmodified'];
        }
 
    }

◆ getName()

Sabre\CalDAV\Subscriptions\Subscription::getName ( )

Returns the name of the node.

This is used to generate the url.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 72 of file Subscription.php.

                       {
 
        return $this->subscriptionInfo['uri'];
 
    }

◆ getOwner()

Sabre\CalDAV\Subscriptions\Subscription::getOwner ( )

Returns the owner principal.

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

Returns: string|null

Implements Sabre\DAVACL\IACL.

Definition at line 181 of file Subscription.php.

                        {
 
        return $this->subscriptionInfo['principaluri'];
 
    }

Referenced by Sabre\CalDAV\Subscriptions\Subscription\getACL().

Here is the caller graph for this function:

◆ getProperties()

Sabre\CalDAV\Subscriptions\Subscription::getProperties ( $properties )

Returns a list of properties for this nodes.

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

array $properties

Returns: array

Implements Sabre\DAV\IProperties.

Definition at line 151 of file Subscription.php.

                                        {
 
        $r = [];
 
        foreach ($properties as $prop) {
 
            switch ($prop) {
                case '{http://calendarserver.org/ns/}source' :
                    $r[$prop] = new Href($this->subscriptionInfo['source']);
                    break;
                default :
                    if (array_key_exists($prop, $this->subscriptionInfo)) {
                        $r[$prop] = $this->subscriptionInfo[$prop];
                    }
                    break;
            }
 
        }
 
        return $r;
 
    }

References $r.

◆ propPatch()

Sabre\CalDAV\Subscriptions\Subscription::propPatch ( PropPatch $propPatch )

Updates properties on this node.

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

Returns: void

Implements Sabre\DAV\IProperties.

Definition at line 127 of file Subscription.php.

                                             {
 
        return $this->caldavBackend->updateSubscription(
            $this->subscriptionInfo['id'],
            $propPatch
        );
 
    }

Field Documentation

◆ $caldavBackend

Sabre\CalDAV\Subscriptions\Subscription::$caldavBackend

protected

Definition at line 30 of file Subscription.php.

Referenced by Sabre\CalDAV\Subscriptions\Subscription\__construct().

◆ $subscriptionInfo

Sabre\CalDAV\Subscriptions\Subscription::$subscriptionInfo

protected

Definition at line 37 of file Subscription.php.

Referenced by Sabre\CalDAV\Subscriptions\Subscription\__construct().

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/dav/lib/CalDAV/Subscriptions/Subscription.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getACL()

◆ getChildren()

◆ getLastModified()

◆ getName()

◆ getOwner()

◆ getProperties()

◆ propPatch()

Field Documentation

◆ $caldavBackend

◆ $subscriptionInfo