Inheritance diagram for Sabre\DAVACL\PrincipalBackend\Mock:

Collaboration diagram for Sabre\DAVACL\PrincipalBackend\Mock:

Public Member Functions
	__construct (array $principals=null)

	getPrincipalsByPrefix ($prefix)
	Returns a list of principals based on a prefix. More...

	addPrincipal (array $principal)

	getPrincipalByPath ($path)
	Returns a specific principal, specified by it's path. More...

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

	getGroupMemberSet ($path)
	Returns the list of members for a group-principal. More...

	getGroupMembership ($path)
	Returns the list of groups a principal is a member of. More...

	setGroupMemberSet ($path, array $members)
	Updates the list of group members for a group principal. More...

	updatePrincipal ($path, \Sabre\DAV\PropPatch $propPatch)
	Updates one ore more webdav properties on a principal. More...

Public Member Functions inherited from Sabre\DAVACL\PrincipalBackend\AbstractBackend
	findByUri ($uri, $principalPrefix)
	Finds a principal by its URI. More...

	getPrincipalsByPrefix ($prefixPath)
	Returns a list of principals based on a prefix. More...

	getPrincipalByPath ($path)
	Returns a specific principal, specified by it's path. More...

	updatePrincipal ($path, \Sabre\DAV\PropPatch $propPatch)
	Updates one ore more webdav properties on a principal. More...

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

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

	getGroupMemberSet ($principal)
	Returns the list of members for a group-principal. More...

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

	setGroupMemberSet ($principal, array $members)
	Updates the list of group members for a group principal. More...

Data Fields
	$groupMembers = []

	$principals

Detailed Description

Definition at line 5 of file Mock.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAVACL\PrincipalBackend\Mock::__construct ( array $principals = null )

Definition at line 10 of file Mock.php.

                                                   {
 
        $this->principals = $principals;
 
        if (is_null($principals)) {
 
            $this->principals = [
                [
                    'uri'                                   => 'principals/user1',
                    '{DAV:}displayname'                     => 'User 1',
                    '{http://sabredav.org/ns}email-address' => 'user1.sabredav@sabredav.org',
                    '{http://sabredav.org/ns}vcard-url'     => 'addressbooks/user1/book1/vcard1.vcf',
                ],
                [
                    'uri'               => 'principals/admin',
                    '{DAV:}displayname' => 'Admin',
                ],
                [
                    'uri'                                   => 'principals/user2',
                    '{DAV:}displayname'                     => 'User 2',
                    '{http://sabredav.org/ns}email-address' => 'user2.sabredav@sabredav.org',
                ],
            ];
 
        }
 
    }

References Sabre\DAVACL\PrincipalBackend\Mock\$principals.

Member Function Documentation

◆ addPrincipal()

Sabre\DAVACL\PrincipalBackend\Mock::addPrincipal ( array $principal )

Definition at line 56 of file Mock.php.

                                            {
 
        $this->principals[] = $principal;
 
    }

◆ getGroupMemberSet()

Sabre\DAVACL\PrincipalBackend\Mock::getGroupMemberSet ( $principal )

Returns the list of members for a group-principal.

Parameters

string $principal

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 99 of file Mock.php.

                                      {
 
        return isset($this->groupMembers[$path]) ? $this->groupMembers[$path] : [];
 
    }

References $path.

◆ getGroupMembership()

Sabre\DAVACL\PrincipalBackend\Mock::getGroupMembership ( $principal )

Returns the list of groups a principal is a member of.

Parameters

string $principal

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 105 of file Mock.php.

                                       {
 
        $membership = [];
        foreach ($this->groupMembers as $group => $members) {
            if (in_array($path, $members)) $membership[] = $group;
        }
        return $membership;
 
    }

References $path.

◆ getPrincipalByPath()

Sabre\DAVACL\PrincipalBackend\Mock::getPrincipalByPath ( $path )

Returns a specific principal, specified by it's path.

The returned structure should be the exact same as from getPrincipalsByPrefix.

Parameters

string $path

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 62 of file Mock.php.

                                       {
 
        foreach ($this->getPrincipalsByPrefix('principals') as $principal) {
            if ($principal['uri'] === $path) return $principal;
        }
 
    }

References $path, and Sabre\DAVACL\PrincipalBackend\Mock\getPrincipalsByPrefix().

Here is the call graph for this function:

◆ getPrincipalsByPrefix()

Sabre\DAVACL\PrincipalBackend\Mock::getPrincipalsByPrefix ( $prefixPath )

Returns a list of principals based on a prefix.

This prefix will often contain something like 'principals'. You are only expected to return principals that are in this base path.

You are expected to return at least a 'uri' for every user, you can return any additional properties if you wish so. Common properties are: {DAV:}displayname {http://sabredav.org/ns}email-address - This is a custom SabreDAV field that's actually injected in a number of other properties. If you have an email address, use this property.

Parameters

string $prefixPath

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 38 of file Mock.php.

                                            {
 
        $prefix = trim($prefix, '/');
        if ($prefix) $prefix .= '/';
        $return = [];
 
        foreach ($this->principals as $principal) {
 
            if ($prefix && strpos($principal['uri'], $prefix) !== 0) continue;
 
            $return[] = $principal;
 
        }
 
        return $return;
 
    }

Referenced by Sabre\DAVACL\PrincipalBackend\Mock\getPrincipalByPath(), and Sabre\DAVACL\PrincipalBackend\Mock\searchPrincipals().

Here is the caller graph for this function:

◆ searchPrincipals()

Sabre\DAVACL\PrincipalBackend\Mock::searchPrincipals	(		$prefixPath,
		array	$searchProperties,
			$test = `'allof'`
	)

This method is used to search for principals matching a set of properties.

This search is specifically used by RFC3744's principal-property-search REPORT.

The actual search should be a unicode-non-case-sensitive search. The keys in searchProperties are the WebDAV property names, while the values are the property values to search on.

By default, if multiple properties are submitted to this method, the various properties should be combined with 'AND'. If $test is set to 'anyof', it should be combined using 'OR'.

This method should simply return an array with full principal uri's.

If somebody attempted to search on a property the backend does not support, you should simply return 0 results.

You can also just return 0 results if you choose to not support searching at all, but keep in mind that this may stop certain features from working.

Parameters

string	$prefixPath
array	$searchProperties
string	$test

Returns: array

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 70 of file Mock.php.

                                                                                     {
 
        $matches = [];
        foreach ($this->getPrincipalsByPrefix($prefixPath) as $principal) {
 
            foreach ($searchProperties as $key => $value) {
 
                if (!isset($principal[$key])) {
                    continue 2;
                }
                if (mb_stripos($principal[$key], $value, 0, 'UTF-8') === false) {
                    continue 2;
                }
 
                // We have a match for this searchProperty!
                if ($test === 'allof') {
                    continue;
                } else {
                    break;
                }
 
            }
            $matches[] = $principal['uri'];
 
        }
        return $matches;
 
    }

References $key, $test, and Sabre\DAVACL\PrincipalBackend\Mock\getPrincipalsByPrefix().

Here is the call graph for this function:

◆ setGroupMemberSet()

Sabre\DAVACL\PrincipalBackend\Mock::setGroupMemberSet	(		$principal,
		array	$members
	)

Updates the list of group members for a group principal.

The principals should be passed as a list of uri's.

Parameters

string	$principal
array	$members

Returns: void

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 115 of file Mock.php.

                                                      {
 
        $this->groupMembers[$path] = $members;
 
    }

References $path.

◆ updatePrincipal()

Sabre\DAVACL\PrincipalBackend\Mock::updatePrincipal	(		$path,
		\Sabre\DAV\PropPatch	$propPatch
	)

Updates one ore more webdav properties on a principal.

The list of mutations is stored in a Sabre\DAV\PropPatch object. To do the actual updates, you must tell this object which properties you're going to process with the handle() method.

Calling the handle method is like telling the PropPatch object "I promise I can handle updating this property".

Read the PropPatch documentation for more info and examples.

Parameters

string	$path
\Sabre\DAV\PropPatch	$propPatch

Implements Sabre\DAVACL\PrincipalBackend\BackendInterface.

Definition at line 136 of file Mock.php.

                                                                     {
 
        $value = null;
        foreach ($this->principals as $principalIndex => $value) {
            if ($value['uri'] === $path) {
                $principal = $value;
                break;
            }
        }
        if (!$principal) return;
 
        $propPatch->handleRemaining(function($mutations) use ($principal, $principalIndex) {
 
            foreach ($mutations as $prop => $value) {
 
                if (is_null($value) && isset($principal[$prop])) {
                    unset($principal[$prop]);
                } else {
                    $principal[$prop] = $value;
                }
 
            }
 
            $this->principals[$principalIndex] = $principal;
 
            return true;
 
        });
 
    }

References $path.

Field Documentation

◆ $groupMembers

Sabre\DAVACL\PrincipalBackend\Mock::$groupMembers = []

Definition at line 7 of file Mock.php.

◆ $principals

Sabre\DAVACL\PrincipalBackend\Mock::$principals

Definition at line 8 of file Mock.php.

Referenced by Sabre\DAVACL\PrincipalBackend\Mock\__construct().

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

libs/composer/vendor/sabre/dav/tests/Sabre/DAVACL/PrincipalBackend/Mock.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPrincipal()

◆ getGroupMemberSet()

◆ getGroupMembership()

◆ getPrincipalByPath()

◆ getPrincipalsByPrefix()

◆ searchPrincipals()

◆ setGroupMemberSet()

◆ updatePrincipal()

Field Documentation

◆ $groupMembers

◆ $principals