Kronolith_Attendee
in package
implements
Serializable
Kronolith_Attendee represents an attendee.
Tags
Interfaces, Classes and Traits
- Serializable
Table of Contents
- $addressObject : Horde_Mail_Rfc822_Address
- $displayName : string
- $email : string
- The attendee's email address.
- $id : string
- $name : string
- The attendee's full name.
- $response : int
- The attendee's response.
- $role : int
- The attendee's role.
- $user : string
- The attendee's user name.
- __construct() : mixed
- Constructor.
- __get() : mixed
- __toString() : mixed
- matchesEmail() : bool
- Returns whether an email address matches this attendee.
- migrate() : mixed
- Migrates data from an old attendee structure.
- serialize() : mixed
- toHash() : array<string|int, mixed>
- Returns hash representing this attendee.
- toJson() : object
- Returns a simple object suitable for JSON transport representing this attendee.
- unserialize() : mixed
Properties
$addressObject read-only
public
Horde_Mail_Rfc822_Address
$addressObject
An address object representation of this attendee.
$displayName read-only
public
string
$displayName
A simple label to identify the attendee.
The attendee's email address.
public
string
$email
$id read-only
public
string
$id
An ID for this attendee.
$name
The attendee's full name.
public
string
$name
$response
The attendee's response.
public
int
$response
One of the Kronolith::RESPONSE_* constants
$role
The attendee's role.
public
int
$role
One of the Kronolith::PART_* constants
$user
The attendee's user name.
public
string
$user
Methods
__construct()
Constructor.
public
__construct(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
-
Attendee properties:
- 'user': (string) A user name.
- 'email': (string) The email address of the attendee.
- 'role': (integer) The role code of the attendee. One of the Kronolith::PART_* constants. Default: Kronolith::PART_REQUIRED
- 'response': (integer) The response code of the attendee. One of the Kronolith::RESPONSE_* constants. Default: Kronolith::RESPONSE_NONE
- 'name': (string) The name of the attendee.
- 'identities': (Horde_Core_Factory_Identity) An identity factory used to complete 'email' and 'name' for 'user' if not specified explicitly.
Return values
mixed —__get()
public
__get(mixed $what) : mixed
Parameters
- $what : mixed
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —matchesEmail()
Returns whether an email address matches this attendee.
public
matchesEmail(string $email, bool $caseSensitive) : bool
Parameters
- $email : string
-
An email address.
- $caseSensitive : bool
-
Whether to match case-sensitive.
Return values
bool —True if the email address matches this attendee.
migrate()
Migrates data from an old attendee structure.
public
static migrate(string $email, array<string|int, mixed> $data) : mixed
Parameters
- $email : string
-
The attendee's email address.
- $data : array<string|int, mixed>
-
The attendee data from before Kronolith 5.
Return values
mixed —serialize()
public
serialize() : mixed
Return values
mixed —toHash()
Returns hash representing this attendee.
public
toHash() : array<string|int, mixed>
Return values
array<string|int, mixed> —An hash respresenting this attendee.
toJson()
Returns a simple object suitable for JSON transport representing this attendee.
public
toJson() : object
Return values
object —An object respresenting this attendee.
unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed