\Kronolith_Attendee_List

This is a list of attendees.

Summary

Methods
Properties
Constants
__construct()
parse()
add()
has()
without()
getEmailList()
__toString()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
count()
getIterator()
serialize()
unserialize()
No public properties found
No constants found
No protected methods found
$_list
N/A
No private methods found
No private properties found
N/A

Properties

$_list

$_list : array

A list of Kronolith_Attendee objects.

Type

array

Methods

__construct()

__construct(array  $attendees = array()) 

Constructor.

Parameters

array $attendees

A list of Kronolith_Attendee objects.

parse()

parse(string  $newAttendees, \Horde_Notification_Handler  $notification) : \Kronolith_Attendee_List

Parses a comma separated list of names and e-mail addresses into a list of attendees.

Parameters

string $newAttendees

A comma separated attendee list.

\Horde_Notification_Handler $notification

A notification handler.

Returns

\Kronolith_Attendee_List

The parsed attendee list.

has()

has(string|\Kronolith_Attendee  $email) : boolean

Checks to see whether an attendee exists in this list.

This is a case-insensitive version of offsetExists().

Parameters

string|\Kronolith_Attendee $email

An attendee or the email address of an attendee.

Returns

boolean —

True if the specified attendee is present in this list.

without()

without(array  $excluded) : \Kronolith_Attendee_List

Returns a copy this list with some attendees removed.

Parameters

array $excluded

List of email addresses to remove.

Returns

\Kronolith_Attendee_List

A reduced attendee list.

getEmailList()

getEmailList() : \Horde_Mail_Rfc822_List

Returns a list of email address objects.

Returns

\Horde_Mail_Rfc822_List —

This list of attendees.

__toString()

__toString() 

offsetExists()

offsetExists(  $index) 

Parameters

$index

offsetGet()

offsetGet(  $index) 

Parameters

$index

offsetSet()

offsetSet(  $index,   $value) 

Parameters

$index
$value

offsetUnset()

offsetUnset(  $index) 

Parameters

$index

count()

count() 

getIterator()

getIterator() 

serialize()

serialize() 

unserialize()

unserialize(  $data) 

Parameters

$data