Horde_Imap_Client_Data_AclRights
extends Horde_Imap_Client_Data_AclCommon
in package
implements
ArrayAccess, Iterator, Serializable
Available ACL rights for a mailbox/identifier (see RFC 2086/4314).
Tags
Interfaces, Classes, Traits and Enums
- ArrayAccess
- Iterator
- Serializable
Table of Contents
- RFC_2086 = 1
- Constants for getString().
- RFC_4314 = 2
- $_optional : array<string|int, mixed>
- ACL optional rights.
- $_required : array<string|int, mixed>
- ACL required 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
- current() : mixed
- getString() : string
- Returns the raw string to use in IMAP server calls.
- key() : mixed
- next() : mixed
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- rewind() : mixed
- serialize() : mixed
- unserialize() : mixed
- valid() : mixed
- _normalize() : mixed
- Normalize virtual rights (see RFC 4314 [2.1.1]).
Constants
RFC_2086
Constants for getString().
public
mixed
RFC_2086
= 1
RFC_4314
public
mixed
RFC_4314
= 2
Properties
$_optional
ACL optional rights.
protected
array<string|int, mixed>
$_optional
= array()
$_required
ACL required rights.
protected
array<string|int, mixed>
$_required
= array()
$_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([array<string|int, mixed> $required = array() ][, array<string|int, mixed> $optional = array() ]) : mixed
Parameters
- $required : array<string|int, mixed> = array()
-
The required rights (see RFC 4314 [2.1]).
- $optional : array<string|int, mixed> = array()
-
The optional 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 —current()
public
current() : 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.
key()
public
key() : mixed
Return values
mixed —next()
public
next() : mixed
Return values
mixed —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 —rewind()
public
rewind() : mixed
Return values
mixed —serialize()
public
serialize() : mixed
Return values
mixed —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —valid()
public
valid() : mixed
Return values
mixed —_normalize()
Normalize virtual rights (see RFC 4314 [2.1.1]).
protected
_normalize() : mixed