Documentation

MockACLNode extends Node
in package
implements IACL

Node class.

This is a helper class, that should aid in getting nodes setup.

Interfaces, Classes and Traits

IACL
ACL-enabled node.

Table of Contents

$acl  : mixed
$name  : mixed
__construct()  : mixed
delete()  : mixed
Deletes the current node.
getACL()  : array<string|int, mixed>
Returns a list of ACE's for this node.
getGroup()  : string|null
Returns a group principal.
getLastModified()  : int
Returns the last modification time as a unix timestamp.
getName()  : mixed
getOwner()  : string|null
Returns the owner principal.
getSupportedPrivilegeSet()  : array<string|int, mixed>|null
Returns the list of supported privileges for this node.
setACL()  : mixed
Updates the ACL.
setName()  : mixed
Renames the node.

Properties

Methods

__construct()

public __construct(mixed $name[, array<string|int, mixed> $acl = [] ]) : mixed
Parameters
$name : mixed
$acl : array<string|int, mixed> = []
Return values
mixed —

delete()

Deletes the current node.

public delete() : mixed
Tags
throws
Forbidden
Return values
mixed —

getACL()

Returns a list of ACE's for this node.

public getACL() : array<string|int, mixed>

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 values
array<string|int, mixed> —

getGroup()

Returns a group principal.

public getGroup() : string|null

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

Return values
string|null —

getLastModified()

Returns the last modification time as a unix timestamp.

public getLastModified() : int

If the information is not available, return null.

Return values
int —

getName()

public getName() : mixed
Return values
mixed —

getOwner()

Returns the owner principal.

public getOwner() : string|null

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

Return values
string|null —

getSupportedPrivilegeSet()

Returns the list of supported privileges for this node.

public getSupportedPrivilegeSet() : array<string|int, mixed>|null

The returned data structure is a list of nested privileges. See Sabre\DAVACL\Plugin::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.

Return values
array<string|int, mixed>|null —

setACL()

Updates the ACL.

public setACL(array<string|int, mixed> $acl) : mixed

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

Parameters
$acl : array<string|int, mixed>
Return values
mixed —

setName()

Renames the node.

public setName(string $name) : mixed
Parameters
$name : string

The new name

Tags
throws
Forbidden
Return values
mixed —

Search results