ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Sabre\DAVACL\FS\File Class Reference

This is an ACL-enabled file node. More...

+ Inheritance diagram for Sabre\DAVACL\FS\File:
+ Collaboration diagram for Sabre\DAVACL\FS\File:

Public Member Functions

 __construct ($path, array $acl, $owner=null)
 Constructor. More...
 
 getOwner ()
 Returns the owner principal. More...
 
 getACL ()
 Returns a list of ACE's for this node. More...
 
- Public Member Functions inherited from Sabre\DAV\FSExt\File
 put ($data)
 Updates the data. More...
 
 patch ($data, $rangeType, $offset=null)
 Updates the file based on a range specification. More...
 
 get ()
 Returns the data. More...
 
 delete ()
 Delete the current file. More...
 
 getETag ()
 Returns the ETag for a file. More...
 
 getContentType ()
 Returns the mime-type for a file. More...
 
 getSize ()
 Returns the size of the file, in bytes. More...
 
- Public Member Functions inherited from Sabre\DAV\FS\Node
 __construct ($path)
 Sets up the node, expects a full path name. More...
 
 getName ()
 Returns the name of the node. More...
 
 setName ($name)
 Renames the node. More...
 
 getLastModified ()
 Returns the last modification time, as a unix timestamp. More...
 
- Public Member Functions inherited from Sabre\DAVACL\IACL
 getGroup ()
 Returns a group principal. More...
 
 setACL (array $acl)
 Updates the ACL. More...
 
 getSupportedPrivilegeSet ()
 Returns the list of supported privileges for this node. More...
 

Protected Attributes

 $acl
 
 $owner
 
- Protected Attributes inherited from Sabre\DAV\FS\Node
 $path
 

Detailed Description

This is an ACL-enabled file node.

Author
Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 16 of file File.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAVACL\FS\File::__construct (   $path,
array  $acl,
  $owner = null 
)

Constructor.

Parameters
string$pathon-disk path.
array$aclACL rules.
string | null$ownerprincipal owner string.

Definition at line 41 of file File.php.

References Sabre\DAVACL\FS\File\$acl, Sabre\DAVACL\FS\File\$owner, and Sabre\DAV\FS\Node\$path.

41  {
42 
43  parent::__construct($path);
44  $this->acl = $acl;
45  $this->owner = $owner;
46 
47  }

Member Function Documentation

◆ getACL()

Sabre\DAVACL\FS\File::getACL ( )

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.
Returns
array

Implements Sabre\DAVACL\IACL.

Definition at line 74 of file File.php.

References Sabre\DAVACL\FS\File\$acl.

74  {
75 
76  return $this->acl;
77 
78  }

◆ getOwner()

Sabre\DAVACL\FS\File::getOwner ( )

Returns the owner principal.

This must be a url to a principal, or null if there's no owner

Returns
string|null

Implements Sabre\DAVACL\IACL.

Definition at line 56 of file File.php.

References Sabre\DAVACL\FS\File\$owner.

56  {
57 
58  return $this->owner;
59 
60  }

Field Documentation

◆ $acl

Sabre\DAVACL\FS\File::$acl
protected

Definition at line 25 of file File.php.

Referenced by Sabre\DAVACL\FS\File\__construct(), and Sabre\DAVACL\FS\File\getACL().

◆ $owner

Sabre\DAVACL\FS\File::$owner
protected

Definition at line 32 of file File.php.

Referenced by Sabre\DAVACL\FS\File\__construct(), and Sabre\DAVACL\FS\File\getOwner().


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