Principals Collection. More...

Inheritance diagram for Sabre\DAVACL\PrincipalCollection:

Collaboration diagram for Sabre\DAVACL\PrincipalCollection:

Public Member Functions
	getChildForPrincipal (array $principal)
	This method returns a node for a principal. More...

	createExtendedCollection ($name, MkCol $mkCol)
	Creates a new collection. More...

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

Public Member Functions inherited from Sabre\DAVACL\AbstractPrincipalCollection
	__construct (PrincipalBackend\BackendInterface $principalBackend, $principalPrefix='principals')
	Creates the object. More...

	getChildForPrincipal (array $principalInfo)
	This method returns a node for a principal. More...

	getName ()
	Returns the name of this collection. More...

	getChildren ()
	Return the list of users. More...

	getChild ($name)
	Returns a child object, by its name. More...

	searchPrincipals (array $searchProperties, $test='allof')
	This method is used to search for principals matching a set of properties. More...

	findByUri ($uri)
	Finds a principal by its URI. 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...

	searchPrincipals (array $searchProperties, $test='allof')
	This method is used to search for principals matching a set of properties. More...

	findByUri ($uri)
	Finds a principal by its URI. More...

	createExtendedCollection ($name, MkCol $mkCol)
	Creates a new collection. 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...

Additional Inherited Members
Data Fields inherited from Sabre\DAVACL\AbstractPrincipalCollection
	$disableListing = false

Protected Attributes inherited from Sabre\DAVACL\AbstractPrincipalCollection
	$principalBackend

	$principalPrefix

Detailed Description

Principals Collection.

This collection represents a list of users. The users are instances of Sabre\DAVACL\Principal

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 19 of file PrincipalCollection.php.

Member Function Documentation

◆ createExtendedCollection()

Sabre\DAVACL\PrincipalCollection::createExtendedCollection	(		$name,
		MkCol	$mkCol
	)

Creates a new collection.

This method will receive a MkCol object with all the information about the new collection that's being created.

The MkCol object contains information about the resourceType of the new collection. If you don't support the specified resourceType, you should throw Exception\InvalidResourceType.

The object also contains a list of WebDAV properties for the new collection.

You should call the handle() method on this object to specify exactly which properties you are storing. This allows the system to figure out exactly which properties you didn't store, which in turn allows other plugins (such as the propertystorage plugin) to handle storing the property for you.

Parameters

string	$name
MkCol	$mkCol

Exceptions

InvalidResourceType

Returns: void

Implements Sabre\DAV\IExtendedCollection.

Definition at line 63 of file PrincipalCollection.php.

                                                           {
 
        if (!$mkCol->hasResourceType('{DAV:}principal')) {
            throw new InvalidResourceType('Only resources of type {DAV:}principal may be created here');
        }
 
        $this->principalBackend->createPrincipal(
            $this->principalPrefix . '/' . $name,
            $mkCol
        );
 
    }

References $name, and Sabre\DAV\MkCol\hasResourceType().

Here is the call graph for this function:

◆ getACL()

Sabre\DAVACL\PrincipalCollection::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 88 of file PrincipalCollection.php.

                      {
        return [
            [
                'principal' => '{DAV:}authenticated',
                'privilege' => '{DAV:}read',
                'protected' => true,
            ],
        ];
    }

◆ getChildForPrincipal()

Sabre\DAVACL\PrincipalCollection::getChildForPrincipal ( array $principal )

This method returns a node for a principal.

The passed array contains principal information, and is guaranteed to at least contain a uri item. Other properties may or may not be supplied by the authentication backend.

Parameters

array $principal

Returns: \Sabre\DAV\INode

Reimplemented from Sabre\DAVACL\AbstractPrincipalCollection.

Reimplemented in Sabre\CalDAV\Principal\Collection.

Definition at line 33 of file PrincipalCollection.php.

                                                    {
 
        return new Principal($this->principalBackend, $principal);
 
    }

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

libs/composer/vendor/sabre/dav/lib/DAVACL/PrincipalCollection.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createExtendedCollection()

◆ getACL()

◆ getChildForPrincipal()