Blame view

sources/3rdparty/sabre/dav/lib/Sabre/DAVACL/IACL.php 1.83 KB
03e52840d   Kload   Init
1
  <?php
6d9380f96   Cédric Dupont   Update sources OC...
2
3
  namespace Sabre\DAVACL;
  use Sabre\DAV;
03e52840d   Kload   Init
4
5
6
7
8
  /**
   * ACL-enabled node
   *
   * If you want to add WebDAV ACL to a node, you must implement this class
   *
6d9380f96   Cédric Dupont   Update sources OC...
9
10
11
   * @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
12
   */
6d9380f96   Cédric Dupont   Update sources OC...
13
  interface IACL extends DAV\INode {
03e52840d   Kload   Init
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
  
      /**
       * Returns the owner principal
       *
       * This must be a url to a principal, or null if there's no owner
       *
       * @return string|null
       */
      function getOwner();
  
      /**
       * Returns a group principal
       *
       * This must be a url to a principal, or null if there's no owner
       *
       * @return string|null
       */
      function getGroup();
  
      /**
       * 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.
       *
       * @return array
       */
      function getACL();
  
      /**
       * Updates the ACL
       *
       * This method will receive a list of new ACE's as an array argument.
       *
       * @param array $acl
       * @return void
       */
      function setACL(array $acl);
  
      /**
       * Returns the list of supported privileges for this node.
       *
       * The returned data structure is a list of nested privileges.
6d9380f96   Cédric Dupont   Update sources OC...
61
       * See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
03e52840d   Kload   Init
62
63
64
65
66
67
68
69
70
71
72
       * standard structure.
       *
       * If null is returned from this method, the default privilege set is used,
       * which is fine for most common usecases.
       *
       * @return array|null
       */
      function getSupportedPrivilegeSet();
  
  
  }