PHP Class Kronolith_Attendee_List, horde

Author: Jan Schneider ([email protected])

Inheritance: implements ArrayAccess, implements Countable, implements IteratorAggregate, implements Serializable

Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_list	array	A list of Kronolith_Attendee objects.

Public Methods

Method	Description
__construct ( array $attendees = [] )	Constructor.
__toString ( )
add ( Kronolith_Attendee \| Kronolith_Attendee_List $what ) : Kronolith_Attendee_List	Adds one or more attendees to this list.
count ( )	* Countable method.
getEmailList ( ) : Horde_Mail_Rfc822_List	Returns a list of email address objects.
getIterator ( )
has ( string \| Kronolith_Attendee $email ) : boolean	Checks to see whether an attendee exists in this list.
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $value )
offsetUnset ( $index )
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.
serialize ( )
unserialize ( $data )
without ( array $excluded ) : Kronolith_Attendee_List	Returns a copy this list with some attendees removed.

Method Details

__construct() public method

Constructor.

public __construct ( array $attendees = [] )
$attendees	array	A list of Kronolith_Attendee objects.

__toString() public method

public __toString ( )

add() public method

Adds one or more attendees to this list.

public add ( Kronolith_Attendee \| Kronolith_Attendee_List $what ) : Kronolith_Attendee_List
$what	Kronolith_Attendee \| Kronolith_Attendee_List	The attendee(s) to add.
return	Kronolith_Attendee_List	This list with the attendee(s) added.

count() public method

* Countable method.

public count ( )

getEmailList() public method

Returns a list of email address objects.

public getEmailList ( ) : Horde_Mail_Rfc822_List
return	Horde_Mail_Rfc822_List	This list of attendees.

getIterator() public method

public getIterator ( )

has() public method

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

public has ( string \| Kronolith_Attendee $email ) : boolean
$email	string \| Kronolith_Attendee	An attendee or the email address of an attendee.
return	boolean	True if the specified attendee is present in this list.

offsetExists() public method

public offsetExists ( $index )

offsetGet() public method

public offsetGet ( $index )

offsetSet() public method

public offsetSet ( $index, $value )

offsetUnset() public method

public offsetUnset ( $index )

parse() public static method

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
$newAttendees	string	A comma separated attendee list.
$notification	Horde_Notification_Handler	A notification handler.
return	Kronolith_Attendee_List	The parsed attendee list.

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $data )

without() public method

Returns a copy this list with some attendees removed.

public without ( array $excluded ) : Kronolith_Attendee_List
$excluded	array	List of email addresses to remove.
return	Kronolith_Attendee_List	A reduced attendee list.

Property Details

$_list protected_oe property

A list of Kronolith_Attendee objects.

protected array $_list
return	array