Documentation

Horde_Imap_Client_Data_AclNegative extends Horde_Imap_Client_Data_Acl
in package

ACL *negative* rights for a mailbox (see RFC 2086/4314 [2]).

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2011-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

RFC_2086  = 1
Constants for getString().
RFC_4314  = 2
$_rights  : array<string|int, mixed>
ACL rights.
$_virtual  : array<string|int, mixed>
List of virtual rights (RFC 4314 [2.1.1]).
__construct()  : mixed
Constructor.
__serialize()  : array<string|int, mixed>
__toString()  : string
String representation of the ACL.
__unserialize()  : mixed
diff()  : array<string|int, mixed>
Computes the difference to another rights string.
getIterator()  : mixed
getString()  : string
Returns the raw string to use in IMAP server calls.
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
serialize()  : mixed
unserialize()  : mixed
_normalize()  : mixed
Normalize virtual rights (see RFC 4314 [2.1.1]).

Constants

RFC_2086

Constants for getString().

public mixed RFC_2086 = 1

Properties

$_rights

ACL rights.

protected array<string|int, mixed> $_rights

$_virtual

List of virtual rights (RFC 4314 [2.1.1]).

protected array<string|int, mixed> $_virtual = array(\Horde_Imap_Client::ACL_CREATE => array(\Horde_Imap_Client::ACL_CREATEMBOX, \Horde_Imap_Client::ACL_DELETEMBOX), \Horde_Imap_Client::ACL_DELETE => array( \Horde_Imap_Client::ACL_DELETEMSGS, // Don't put this first - we do checks on the existence of the // first element in this array to determine the RFC type, and this // is duplicate of right contained in ACL_CREATE. \Horde_Imap_Client::ACL_DELETEMBOX, \Horde_Imap_Client::ACL_EXPUNGE, ))

Methods

__construct()

Constructor.

public __construct([string $rights = '' ]) : mixed
Parameters
$rights : string = ''

The rights (see RFC 4314 [2.1]).

Return values
mixed —

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

__toString()

String representation of the ACL.

public __toString() : string
Return values
string —

String representation (RFC 4314 compliant).

__unserialize()

public __unserialize(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed —

diff()

Computes the difference to another rights string.

public diff(string $rights) : array<string|int, mixed>

Virtual rights are ignored.

Parameters
$rights : string

The rights to compute against.

Return values
array<string|int, mixed> —

Two element array: added and removed.

getIterator()

public getIterator() : mixed
Return values
mixed —

getString()

Returns the raw string to use in IMAP server calls.

public getString([int $type = self::RFC_4314 ]) : string
Parameters
$type : int = self::RFC_4314

The RFC type to use (RFC_* constant).

Return values
string —

The string representation of the ACL.

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

serialize()

public serialize() : mixed
Return values
mixed —

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

_normalize()

Normalize virtual rights (see RFC 4314 [2.1.1]).

protected _normalize() : mixed
Return values
mixed —

Search results