Documentation

SharedNode extends Node
in package
implements ISharedNode

Node class.

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

Interfaces, Classes and Traits

ISharedNode
This interface represents a resource that has sharing capabilities, either because it's possible for an owner to share the resource, or because this is an instance of a shared resource.

Table of Contents

$access  : mixed
$invites  : mixed
$name  : mixed
__construct()  : mixed
delete()  : mixed
Deletes the current node.
getInvites()  : array<string|int, Sharee>
Returns the list of people whom this resource is shared with.
getLastModified()  : int
Returns the last modification time as a unix timestamp.
getName()  : mixed
getShareAccess()  : int
Returns the 'access level' for the instance of this shared resource.
getShareResourceUri()  : string
This function must return a URI that uniquely identifies the shared resource. This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.
setName()  : mixed
Renames the node.
updateInvites()  : mixed
Updates the list of sharees.

Properties

Methods

__construct()

public __construct(mixed $name, mixed $access) : mixed
Parameters
$name : mixed
$access : mixed
Return values
mixed —

delete()

Deletes the current node.

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

getInvites()

Returns the list of people whom this resource is shared with.

public getInvites() : array<string|int, Sharee>

Every item in the returned array must be a Sharee object with at least the following properties set:

  • $href
  • $shareAccess
  • $inviteStatus

and optionally:

  • $properties
Return values
array<string|int, Sharee> —

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 —

getShareAccess()

Returns the 'access level' for the instance of this shared resource.

public getShareAccess() : int

The value should be one of the Sabre\DAV\Sharing\Plugin::ACCESS_ constants.

Return values
int —

getShareResourceUri()

This function must return a URI that uniquely identifies the shared resource. This URI should be identical across instances, and is also used in several other XML bodies to connect invites to resources.

public getShareResourceUri() : string

This may simply be a relative reference to the original shared instance, but it could also be a urn. As long as it's a valid URI and unique.

Return values
string —

setName()

Renames the node.

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

The new name

Tags
throws
Forbidden
Return values
mixed —

updateInvites()

Updates the list of sharees.

public updateInvites(array<string|int, Sharee> $sharees) : mixed

Every item must be a Sharee object.

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

Search results