Kronolith_Attendee_List
in package
implements
ArrayAccess, Countable, IteratorAggregate, Serializable
This is a list of attendees.
Tags
Interfaces, Classes, Traits and Enums
- ArrayAccess
- Countable
- IteratorAggregate
- Serializable
Table of Contents
- $_list : array<string|int, mixed>
- A list of Kronolith_Attendee objects.
- __construct() : mixed
- Constructor.
- __serialize() : array<string|int, mixed>
- __toString() : mixed
- __unserialize() : void
- add() : Kronolith_Attendee_List
- Adds one or more attendees to this list.
- count() : mixed
- getEmailList() : Horde_Mail_Rfc822_List
- Returns a list of email address objects.
- getIterator() : Traversable
- has() : bool
- Checks to see whether an attendee exists in this list.
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- parse() : Kronolith_Attendee_List
- Parses a comma separated list of names and e-mail addresses into a list of attendees.
- serialize() : mixed
- unserialize() : mixed
- without() : Kronolith_Attendee_List
- Returns a copy this list with some attendees removed.
Properties
$_list
A list of Kronolith_Attendee objects.
protected
array<string|int, mixed>
$_list
= array()
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $attendees = array() ]) : mixed
Parameters
- $attendees : array<string|int, mixed> = array()
-
A list of Kronolith_Attendee objects.
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__toString()
public
__toString() : mixed
Return values
mixed —__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —add()
Adds one or more attendees to this list.
public
add(Kronolith_Attendee|Kronolith_Attendee_List $what) : Kronolith_Attendee_List
Parameters
- $what : Kronolith_Attendee|Kronolith_Attendee_List
-
The attendee(s) to add.
Return values
Kronolith_Attendee_List —This list with the attendee(s) added.
count()
public
count() : mixed
Return values
mixed —getEmailList()
Returns a list of email address objects.
public
getEmailList() : Horde_Mail_Rfc822_List
Return values
Horde_Mail_Rfc822_List —This list of attendees.
getIterator()
public
getIterator() : Traversable
Return values
Traversable —has()
Checks to see whether an attendee exists in this list.
public
has(string|Kronolith_Attendee $email) : bool
This is a case-insensitive version of offsetExists().
Parameters
- $email : string|Kronolith_Attendee
-
An attendee or the email address of an attendee.
Return values
bool —True if the specified attendee is present in this list.
offsetExists()
public
offsetExists(mixed $index) : mixed
Parameters
- $index : mixed
Return values
mixed —offsetGet()
public
& offsetGet(mixed $index) : mixed
Parameters
- $index : mixed
Return values
mixed —offsetSet()
public
offsetSet(mixed $index, mixed $value) : mixed
Parameters
- $index : mixed
- $value : mixed
Return values
mixed —offsetUnset()
public
offsetUnset(mixed $index) : mixed
Parameters
- $index : mixed
Return values
mixed —parse()
Parses a comma separated list of names and e-mail addresses into a list of attendees.
public
static parse(string $newAttendees, Horde_Notification_Handler $notification) : Kronolith_Attendee_List
Parameters
- $newAttendees : string
-
A comma separated attendee list.
- $notification : Horde_Notification_Handler
-
A notification handler.
Return values
Kronolith_Attendee_List —The parsed attendee list.
serialize()
public
serialize() : mixed
Return values
mixed —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —without()
Returns a copy this list with some attendees removed.
public
without(array<string|int, mixed> $excluded) : Kronolith_Attendee_List
Parameters
- $excluded : array<string|int, mixed>
-
List of email addresses to remove.
Return values
Kronolith_Attendee_List —A reduced attendee list.