API Documentation
\

\Horde_Imap_Client_Data_Acl

ACL rights for a mailbox (see RFC 2086/4314).

Summary

Methods
Properties
Constants
getString()
__construct()
__toString()
diff()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
getIterator()
serialize()
unserialize()
No public properties found
RFC_2086
RFC_4314
_normalize()
$_virtual
$_rights
N/A
No private methods found
No private properties found
N/A

Constants

RFC_2086

RFC_2086

Constants for getString().

RFC_4314

RFC_4314

Properties

$_virtual

$_virtual : array

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

Type

array

$_rights

$_rights : array

ACL rights.

Type

array

Methods

getString()

getString(integer  $type = self::RFC_4314) : string

Returns the raw string to use in IMAP server calls.

Parameters

integer $type

The RFC type to use (RFC_* constant).

Returns

string —

The string representation of the ACL.

__construct()

__construct(string  $rights = '')

Constructor.

Parameters

string $rights

The rights (see RFC 4314 [2.1]).

__toString()

__toString() : string

String representation of the ACL.

Returns

string —

String representation (RFC 4314 compliant).

diff()

diff(string  $rights) : array

Computes the difference to another rights string.

Virtual rights are ignored.

Parameters

string $rights

The rights to compute against.

Returns

array —

Two element array: added and removed.

offsetExists()

offsetExists(  $offset)

Parameters

$offset

offsetGet()

offsetGet(  $offset)

Parameters

$offset

offsetSet()

offsetSet(  $offset,   $value)

Parameters

$offset
$value

offsetUnset()

offsetUnset(  $offset)

Parameters

$offset

getIterator()

getIterator()

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data

_normalize()

_normalize()

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