Documentation

AddressBookHome extends Collection
in package

Application

implements IExtendedCollection, IACL Uses ACLTrait

AddressBook Home class.

This collection contains a list of addressbooks associated with one user.

Interfaces, Classes and Traits

IExtendedCollection: The IExtendedCollection interface.
IACL: ACL-enabled node.

$carddavBackend : BackendInterface: carddavBackend.
$principalUri : array<string|int, mixed>: Principal uri.
__construct() : mixed: Constructor.
childExists() : bool: Checks is a child-node exists.
createDirectory() : mixed: Creates a new directory under this object.
createExtendedCollection() : mixed: Creates a new address book.
createFile() : string|null: Creates a new file under this object.
delete() : mixed: Deletes this object.
getACL() : array<string|int, mixed>: Returns a list of ACE's for this node.
getChild() : AddressBook: Returns a single addressbook, by name.
getChildren() : array<string|int, mixed>: Returns a list of addressbooks.
getGroup() : string|null: Returns a group principal.
getLastModified() : int: Returns the last modification date.
getName() : string: Returns the name of this object.
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: Updates the name of this object.

$carddavBackend

carddavBackend.


    protected
        BackendInterface
    $carddavBackend

$principalUri

Principal uri.


    protected
        array<string|int, mixed>
    $principalUri

__construct()

Constructor.


    public
                __construct(BackendInterface $carddavBackend, string $principalUri) : mixed

Parameters

$carddavBackend : BackendInterface
$principalUri : string

Return values

mixed —

childExists()

Checks is a child-node exists.


    public
                childExists(string $name) : bool

It is generally a good idea to try and override this. Usually it can be optimized.

Parameters

$name : string

Return values

bool —

createDirectory()

Creates a new directory under this object.


    public
                createDirectory(string $filename) : mixed

This is currently not allowed.

Parameters

$filename : string

Return values

mixed —

createExtendedCollection()

Creates a new address book.


    public
                createExtendedCollection(string $name, MkCol $mkCol) : mixed

Parameters

$name : string
$mkCol : MkCol

Return values

mixed —

createFile()

Creates a new file under this object.


    public
                createFile(string $filename[, resource $data = null ]) : string|null

This is currently not allowed

Parameters

$filename : string
$data : resource = null

Return values

string|null —

delete()

Deletes this object.


    public
                delete() : mixed

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> —

getChild()

Returns a single addressbook, by name.


    public
                getChild(string $name) : AddressBook

Parameters

$name : string

Return values

AddressBook —

getChildren()

Returns a list of addressbooks.


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

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 date.


    public
                getLastModified() : int

Return values

int —

getName()

Returns the name of this object.


    public
                getName() : string

Return values

string —

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()

Updates the name of this object.


    public
                setName(string $name) : mixed

Parameters

$name : string

Return values

mixed —