This is an ACL-enabled collection. More...

Inheritance diagram for Sabre\DAVACL\FS\Collection:

Collaboration diagram for Sabre\DAVACL\FS\Collection:

Public Member Functions
	__construct ($path, array $acl, $owner=null)
	Constructor. More...

	getChild ($name)
	Returns a specific child node, referenced by its name. 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\Directory
	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

	getChild ($name)
	Returns a specific child node, referenced by its name. More...

	childExists ($name)
	Checks if a child exists. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	delete ()
	Deletes all files in this directory, and then itself. More...

	getQuotaInfo ()
	Returns available diskspace information. More...

	moveInto ($targetName, $sourcePath, DAV\INode $sourceNode)
	Moves a node into this collection. 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\DAV\IMoveTarget
	moveInto ($targetName, $sourcePath, INode $sourceNode)
	Moves a node into this collection. 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 collection.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

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

Definition at line 18 of file Collection.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$path	on-disk path.
array	$acl	ACL rules.
string \| null	$owner	principal owner string.

Definition at line 43 of file Collection.php.

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

                                                            {
 
         parent::__construct($path);
         $this->acl = $acl;
         $this->owner = $owner;
 
     }

Member Function Documentation

◆ getACL()

Sabre\DAVACL\FS\Collection::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 105 of file Collection.php.

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

                       {
 
         return $this->acl;
 
     }

◆ getChild()

Sabre\DAVACL\FS\Collection::getChild ( $name )

Returns a specific child node, referenced by its name.

This method must throw Sabre if the node does not exist.

Parameters

string $name

Exceptions

NotFound

Returns

Implements Sabre\DAV\ICollection.

Definition at line 61 of file Collection.php.

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

                              {
 
         $path = $this->path . '/' . $name;
 
         if (!file_exists($path)) throw new NotFound('File could not be located');
         if ($name == '.' || $name == '..') throw new Forbidden('Permission denied to . and ..');
 
         if (is_dir($path)) {
 
             return new self($path, $this->acl, $this->owner);
 
         } else {
 
             return new File($path, $this->acl, $this->owner);
 
         }
 
     }

◆ getOwner()

Sabre\DAVACL\FS\Collection::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 87 of file Collection.php.

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

                         {
 
         return $this->owner;
 
     }

Field Documentation

◆ $acl

Sabre\DAVACL\FS\Collection::$acl

protected

Definition at line 27 of file Collection.php.

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

◆ $owner

Sabre\DAVACL\FS\Collection::$owner

protected

Definition at line 34 of file Collection.php.

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

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

libs/composer/vendor/sabre/dav/lib/DAVACL/FS/Collection.php

Public Member Functions

Protected Attributes