Sabre\DAVACL\MockACLNode Class Reference

Inheritance diagram for Sabre\DAVACL\MockACLNode:

Collaboration diagram for Sabre\DAVACL\MockACLNode:

Public Member Functions
	__construct ($name, array $acl=[])
	getName ()
	Returns the name of the node. More...
	getOwner ()
	Returns the owner principal. More...
	getGroup ()
	Returns a group principal. More...
	getACL ()
	Returns a list of ACE's for this node. More...
	setACL (array $acl)
	Updates the ACL. More...
	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...
Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($name)
	Renames the node. More...

Data Fields
	$name
	$acl

Detailed Description

Definition at line 7 of file MockACLNode.php.

Constructor & Destructor Documentation

__construct()

Sabre\DAVACL\MockACLNode::__construct	(		$name,
		array	$acl = []
	)

Definition at line 12 of file MockACLNode.php.

References Sabre\DAVACL\MockACLNode\$acl, and Sabre\DAVACL\MockACLNode\$name.

                                                 {

        $this->name = $name;
        $this->acl = $acl;

    }

Member Function Documentation

getACL()

Sabre\DAVACL\MockACLNode::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 37 of file MockACLNode.php.

References Sabre\DAVACL\MockACLNode\$acl.

                      {

        return $this->acl;

    }

getGroup()

Sabre\DAVACL\MockACLNode::getGroup

(

)

Returns a group 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 31 of file MockACLNode.php.

                        {

        return null;

    }

getName()

Sabre\DAVACL\MockACLNode::getName

(

)

Returns the name of the node.

This is used to generate the url.

Returns

string

Implements Sabre\DAV\INode.

Definition at line 19 of file MockACLNode.php.

References Sabre\DAVACL\MockACLNode\$name.

                       {

        return $this->name;

    }

getOwner()

Sabre\DAVACL\MockACLNode::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 25 of file MockACLNode.php.

                        {

        return null;

    }

getSupportedPrivilegeSet()

Sabre\DAVACL\MockACLNode::getSupportedPrivilegeSet

(

)

Returns the list of supported privileges for this node.

The returned data structure is a list of nested privileges. See Sabre::getDefaultSupportedPrivilegeSet for a simple standard structure.

If null is returned from this method, the default privilege set is used, which is fine for most common usecases.

Returns

array|null

Implements Sabre\DAVACL\IACL.

Definition at line 49 of file MockACLNode.php.

                                        {

        return null;

    }

setACL()

Sabre\DAVACL\MockACLNode::setACL

(

array

$acl

)

Updates the ACL.

This method will receive a list of new ACE's as an array argument.

Parameters

array

$acl

Returns

void

Implements Sabre\DAVACL\IACL.

Definition at line 43 of file MockACLNode.php.

References Sabre\DAVACL\MockACLNode\$acl.

                                {

        $this->acl = $acl;

    }

Field Documentation

$acl

Sabre\DAVACL\MockACLNode::$acl

Definition at line 10 of file MockACLNode.php.

Referenced by Sabre\DAVACL\MockACLNode\__construct(), Sabre\DAVACL\MockACLNode\getACL(), and Sabre\DAVACL\MockACLNode\setACL().

$name

Sabre\DAVACL\MockACLNode::$name

Definition at line 9 of file MockACLNode.php.

Referenced by Sabre\DAVACL\MockACLNode\__construct(), and Sabre\DAVACL\MockACLNode\getName().

---

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

• libs/composer/vendor/sabre/dav/tests/Sabre/DAVACL/MockACLNode.php