PHP Класс Kronolith_Attendee_List, horde

Автор: Jan Schneider ([email protected])
Наследование: implements ArrayAccess, implements Countable, implements IteratorAggregate, implements Serializable
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_list array A list of Kronolith_Attendee objects.

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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

__toString() публичный Метод

public __toString ( )

add() публичный Метод

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.
Результат Kronolith_Attendee_List This list with the attendee(s) added.

count() публичный Метод

* Countable method.
public count ( )

getEmailList() публичный Метод

Returns a list of email address objects.
public getEmailList ( ) : Horde_Mail_Rfc822_List
Результат Horde_Mail_Rfc822_List This list of attendees.

getIterator() публичный Метод

public getIterator ( )

has() публичный Метод

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.
Результат boolean True if the specified attendee is present in this list.

offsetExists() публичный Метод

public offsetExists ( $index )

offsetGet() публичный Метод

public offsetGet ( $index )

offsetSet() публичный Метод

public offsetSet ( $index, $value )

offsetUnset() публичный Метод

public offsetUnset ( $index )

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
$newAttendees string A comma separated attendee list.
$notification Horde_Notification_Handler A notification handler.
Результат Kronolith_Attendee_List The parsed attendee list.

serialize() публичный Метод

public serialize ( )

unserialize() публичный Метод

public unserialize ( $data )

without() публичный Метод

Returns a copy this list with some attendees removed.
public without ( array $excluded ) : Kronolith_Attendee_List
$excluded array List of email addresses to remove.
Результат Kronolith_Attendee_List A reduced attendee list.

Описание свойств

$_list защищенное свойство

A list of Kronolith_Attendee objects.
protected array $_list
Результат array