ecommun / owncloud_ynh

Blame view

sources/3rdparty/sabre/dav/lib/Sabre/DAVACL/IPrincipal.php 1.8 KB
edit raw normal view history
03e52840d   Kload   Init 
1
 
  <?php
6d9380f96   Cédric Dupont   Update sources OC... 
2
3
4
 
  namespace Sabre\DAVACL;
  
  use Sabre\DAV;
03e52840d   Kload   Init 
5
6
7
8
9
 
  /**
   * IPrincipal interface
   *
   * Implement this interface to define your own principals
   *
6d9380f96   Cédric Dupont   Update sources OC... 
10
11
12
 
   * @copyright Copyright (C) 2007-2014 fruux GmbH (https://fruux.com/).
   * @author Evert Pot (http://evertpot.com/)
   * @license http://sabre.io/license/ Modified BSD License
03e52840d   Kload   Init 
13
 
   */
6d9380f96   Cédric Dupont   Update sources OC... 
14
 
  interface IPrincipal extends DAV\INode {
03e52840d   Kload   Init 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
  
      /**
       * Returns a list of alternative urls for a principal
       *
       * This can for example be an email address, or ldap url.
       *
       * @return array
       */
      function getAlternateUriSet();
  
      /**
       * Returns the full principal url
       *
       * @return string
       */
      function getPrincipalUrl();
  
      /**
       * Returns the list of group members
       *
       * If this principal is a group, this function should return
       * all member principal uri's for the group.
       *
       * @return array
       */
      function getGroupMemberSet();
  
      /**
       * 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.
       *
       * @return array
       */
      function getGroupMembership();
  
      /**
       * 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.
       *
       * @param array $principals
       * @return void
       */
      function setGroupMemberSet(array $principals);
  
      /**
       * Returns the displayname
       *
       * This should be a human readable name for the principal.
       * If none is available, return the nodename.
       *
       * @return string
       */
      function getDisplayName();
  
  }