Blame view

sources/3rdparty/Sabre/DAVACL/IPrincipal.php 1.86 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
  <?php
  
  /**
   * IPrincipal interface
   *
   * Implement this interface to define your own principals
   *
   * @package Sabre
   * @subpackage DAVACL
   * @copyright Copyright (C) 2007-2013 Rooftop Solutions. All rights reserved.
   * @author Evert Pot (http://www.rooftopsolutions.nl/)
   * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
   */
  interface Sabre_DAVACL_IPrincipal extends Sabre_DAV_INode {
  
      /**
       * 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();
  
  }