ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Data Fields
Sabre\DAVACL\PrincipalBackend\Mock Class Reference
+ 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...
 

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.

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

10  {
11 
12  $this->principals = $principals;
13 
14  if (is_null($principals)) {
15 
16  $this->principals = [
17  [
18  'uri' => 'principals/user1',
19  '{DAV:}displayname' => 'User 1',
20  '{http://sabredav.org/ns}email-address' => 'user1.sabredav@sabredav.org',
21  '{http://sabredav.org/ns}vcard-url' => 'addressbooks/user1/book1/vcard1.vcf',
22  ],
23  [
24  'uri' => 'principals/admin',
25  '{DAV:}displayname' => 'Admin',
26  ],
27  [
28  'uri' => 'principals/user2',
29  '{DAV:}displayname' => 'User 2',
30  '{http://sabredav.org/ns}email-address' => 'user2.sabredav@sabredav.org',
31  ],
32  ];
33 
34  }
35 
36  }

Member Function Documentation

◆ addPrincipal()

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

Definition at line 56 of file Mock.php.

56  {
57 
58  $this->principals[] = $principal;
59 
60  }

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

References $path.

99  {
100 
101  return isset($this->groupMembers[$path]) ? $this->groupMembers[$path] : [];
102 
103  }
$path
$path
Definition: aliased.php:25

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

References $path.

105  {
106 
107  $membership = [];
108  foreach ($this->groupMembers as $group => $members) {
109  if (in_array($path, $members)) $membership[] = $group;
110  }
111  return $membership;
112 
113  }
$path
$path
Definition: aliased.php:25

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

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

62  {
63 
64  foreach ($this->getPrincipalsByPrefix('principals') as $principal) {
65  if ($principal['uri'] === $path) return $principal;
66  }
67 
68  }
Sabre\DAVACL\PrincipalBackend\Mock\getPrincipalsByPrefix
getPrincipalsByPrefix($prefix)
Returns a list of principals based on a prefix.
Definition: Mock.php:38
$path
$path
Definition: aliased.php:25
+ 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.

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

38  {
39 
40  $prefix = trim($prefix, '/');
41  if ($prefix) $prefix .= '/';
42  $return = [];
43 
44  foreach ($this->principals as $principal) {
45 
46  if ($prefix && strpos($principal['uri'], $prefix) !== 0) continue;
47 
48  $return[] = $principal;
49 
50  }
51 
52  return $return;
53 
54  }
+ 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.

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

70  {
71 
72  $matches = [];
73  foreach ($this->getPrincipalsByPrefix($prefixPath) as $principal) {
74 
75  foreach ($searchProperties as $key => $value) {
76 
77  if (!isset($principal[$key])) {
78  continue 2;
79  }
80  if (mb_stripos($principal[$key], $value, 0, 'UTF-8') === false) {
81  continue 2;
82  }
83 
84  // We have a match for this searchProperty!
85  if ($test === 'allof') {
86  continue;
87  } else {
88  break;
89  }
90 
91  }
92  $matches[] = $principal['uri'];
93 
94  }
95  return $matches;
96 
97  }
Sabre\DAVACL\PrincipalBackend\Mock\getPrincipalsByPrefix
getPrincipalsByPrefix($prefix)
Returns a list of principals based on a prefix.
Definition: Mock.php:38
$key
$key
Definition: croninfo.php:18
$test
$test
Definition: Utf8Test.php:84
+ 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.

References $path.

115  {
116 
117  $this->groupMembers[$path] = $members;
118 
119  }
$path
$path
Definition: aliased.php:25

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

References $path.

136  {
137 
138  $value = null;
139  foreach ($this->principals as $principalIndex => $value) {
140  if ($value['uri'] === $path) {
141  $principal = $value;
142  break;
143  }
144  }
145  if (!$principal) return;
146 
147  $propPatch->handleRemaining(function($mutations) use ($principal, $principalIndex) {
148 
149  foreach ($mutations as $prop => $value) {
150 
151  if (is_null($value) && isset($principal[$prop])) {
152  unset($principal[$prop]);
153  } else {
154  $principal[$prop] = $value;
155  }
156 
157  }
158 
159  $this->principals[$principalIndex] = $principal;
160 
161  return true;
162 
163  });
164 
165  }
$path
$path
Definition: aliased.php:25

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: