Inheritance diagram for Sabre\CalDAV\Principal\ProxyWrite:

Collaboration diagram for Sabre\CalDAV\Principal\ProxyWrite:

Public Member Functions
	__construct (DAVACL\PrincipalBackend\BackendInterface $principalBackend, array $principalInfo)
	Creates the object. More...

	getName ()
	Returns this principals name. More...

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

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

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

	getAlternateUriSet ()
	Returns a list of alternative urls for a principal. More...

	getPrincipalUrl ()
	Returns the full principal url. More...

	getGroupMemberSet ()
	Returns the list of group members. More...

	getGroupMembership ()
	Returns the list of groups this principal is member of. More...

	setGroupMemberSet (array $principals)
	Sets a list of group members. More...

	getDisplayName ()
	Returns the displayname. More...

Protected Attributes
	$principalInfo

	$principalBackend

Detailed Description

ProxyWrite principal.

This class represents a principal group, hosted under the main principal. This is needed to implement 'Calendar delegation' support. This class is instantiated by User.

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

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

Definition at line 19 of file ProxyWrite.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Principal\ProxyWrite::__construct	(	DAVACL\PrincipalBackend\BackendInterface	$principalBackend,
		array	$principalInfo
	)

Creates the object.

Note that you MUST supply the parent principal information.

Parameters

DAVACL\PrincipalBackend\BackendInterface	$principalBackend
array	$principalInfo

Definition at line 43 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\$principalBackend, and Sabre\CalDAV\Principal\ProxyWrite\$principalInfo.

                                                                                                            {
 
         $this->principalInfo = $principalInfo;
         $this->principalBackend = $principalBackend;
 
     }

Member Function Documentation

◆ delete()

Sabre\CalDAV\Principal\ProxyWrite::delete ( )

Deletes the current node.

Exceptions

DAV

Implements Sabre\DAV\INode.

Definition at line 78 of file ProxyWrite.php.

                       {
 
         throw new DAV\Exception\Forbidden('Permission denied to delete node');
 
     }

◆ getAlternateUriSet()

Sabre\CalDAV\Principal\ProxyWrite::getAlternateUriSet ( )

Returns a list of alternative urls for a principal.

This can for example be an email address, or ldap url.

Returns: array

Implements Sabre\DAVACL\IPrincipal.

Definition at line 105 of file ProxyWrite.php.

◆ getDisplayName()

Sabre\CalDAV\Principal\ProxyWrite::getDisplayName ( )

Returns the displayname.

This should be a human readable name for the principal. If none is available, return the nodename.

Returns: string

Implements Sabre\DAVACL\IPrincipal.

Definition at line 175 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\getName().

                               {
 
         return $this->getName();
 
     }

Here is the call graph for this function:

◆ getGroupMemberSet()

Sabre\CalDAV\Principal\ProxyWrite::getGroupMemberSet ( )

Returns the list of group members.

If this principal is a group, this function should return all member principal uri's for the group.

Returns: array

Implements Sabre\DAVACL\IPrincipal.

Definition at line 130 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\getPrincipalUrl().

                                  {
 
         return $this->principalBackend->getGroupMemberSet($this->getPrincipalUrl());
 
     }

Here is the call graph for this function:

◆ getGroupMembership()

Sabre\CalDAV\Principal\ProxyWrite::getGroupMembership ( )

Returns the list of groups this principal is member of.

If this principal is a member of a (list of) groups, this function should return a list of principal uri's for it's members.

Returns: array

Implements Sabre\DAVACL\IPrincipal.

Definition at line 144 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\getPrincipalUrl().

                                   {
 
         return $this->principalBackend->getGroupMembership($this->getPrincipalUrl());
 
     }

Here is the call graph for this function:

◆ getLastModified()

Sabre\CalDAV\Principal\ProxyWrite::getLastModified ( )

Returns the last modification time.

Returns: null

Implements Sabre\DAV\INode.

Definition at line 66 of file ProxyWrite.php.

                                {
 
         return null;
 
     }

◆ getName()

Sabre\CalDAV\Principal\ProxyWrite::getName ( )

Returns this principals name.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 55 of file ProxyWrite.php.

Referenced by Sabre\CalDAV\Principal\ProxyWrite\getDisplayName(), and Sabre\CalDAV\Principal\ProxyWrite\getPrincipalUrl().

                        {
 
         return 'calendar-proxy-write';
 
     }

Here is the caller graph for this function:

◆ getPrincipalUrl()

Sabre\CalDAV\Principal\ProxyWrite::getPrincipalUrl ( )

Returns the full principal url.

Returns: string

Implements Sabre\DAVACL\IPrincipal.

Definition at line 116 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\getName().

Referenced by Sabre\CalDAV\Principal\ProxyWrite\getGroupMemberSet(), Sabre\CalDAV\Principal\ProxyWrite\getGroupMembership(), and Sabre\CalDAV\Principal\ProxyWrite\setGroupMemberSet().

                                {
 
         return $this->principalInfo['uri'] . '/' . $this->getName();
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGroupMemberSet()

Sabre\CalDAV\Principal\ProxyWrite::setGroupMemberSet ( array $principals )

Sets a list of group members.

If this principal is a group, this method sets all the group members. The list of members is always overwritten, never appended to.

This method should throw an exception if the members could not be set.

Parameters

array $principals

Returns: void

Implements Sabre\DAVACL\IPrincipal.

Definition at line 161 of file ProxyWrite.php.

References Sabre\CalDAV\Principal\ProxyWrite\getPrincipalUrl().

                                                   {
 
         $this->principalBackend->setGroupMemberSet($this->getPrincipalUrl(), $principals);
 
     }

Here is the call graph for this function:

◆ setName()

Sabre\CalDAV\Principal\ProxyWrite::setName ( $name )

Renames the node.

Parameters

string $name The new name

Exceptions

DAV

Implements Sabre\DAV\INode.

Definition at line 91 of file ProxyWrite.php.

                             {
 
         throw new DAV\Exception\Forbidden('Permission denied to rename file');
 
     }

Field Documentation

◆ $principalBackend

Sabre\CalDAV\Principal\ProxyWrite::$principalBackend

protected

Definition at line 33 of file ProxyWrite.php.

Referenced by Sabre\CalDAV\Principal\ProxyWrite\__construct().

◆ $principalInfo

Sabre\CalDAV\Principal\ProxyWrite::$principalInfo

protected

Definition at line 26 of file ProxyWrite.php.

Referenced by Sabre\CalDAV\Principal\ProxyWrite\__construct().

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

libs/composer/vendor/sabre/dav/lib/CalDAV/Principal/ProxyWrite.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getAlternateUriSet()

◆ getDisplayName()

◆ getGroupMemberSet()

◆ getGroupMembership()

◆ getLastModified()

◆ getName()

◆ getPrincipalUrl()

◆ setGroupMemberSet()

◆ setName()

Field Documentation

◆ $principalBackend

◆ $principalInfo