\Kronolith_Attendee

Kronolith_Attendee represents an attendee.

Summary

Methods
Properties
Constants
__construct()
migrate()
__get()
matchesEmail()
__toString()
toHash()
toJson()
serialize()
unserialize()
$user
$email
$name
$role
$response
$addressObject
$displayName
$id
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$user

$user : string

The attendee's user name.

Type

string

$email

$email : string

The attendee's email address.

Type

string

$name

$name : string

The attendee's full name.

Type

string

$role

$role : integer

The attendee's role.

One of the Kronolith::PART_* constants

Type

integer

$response

$response : integer

The attendee's response.

One of the Kronolith::RESPONSE_* constants

Type

integer

$addressObject

$addressObject : \Horde_Mail_Rfc822_Address

An address object representation of this attendee.

Type

\Horde_Mail_Rfc822_Address

$displayName

$displayName : string

A simple label to identify the attendee.

Type

string

$id

$id : string

An ID for this attendee.

Type

string

Methods

__construct()

__construct(array  $params) 

Constructor.

Parameters

array $params

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.

migrate()

migrate(string  $email, array  $data) 

Migrates data from an old attendee structure.

Parameters

string $email

The attendee's email address.

array $data

The attendee data from before Kronolith 5.

__get()

__get(  $what) 

Parameters

$what

matchesEmail()

matchesEmail(string  $email, boolean  $caseSensitive) : boolean

Returns whether an email address matches this attendee.

Parameters

string $email

An email address.

boolean $caseSensitive

Whether to match case-sensitive.

Returns

boolean —

True if the email address matches this attendee.

__toString()

__toString() 

toHash()

toHash() : array

Returns hash representing this attendee.

Returns

array —

An hash respresenting this attendee.

toJson()

toJson() : object

Returns a simple object suitable for JSON transport representing this attendee.

Returns

object —

An object respresenting this attendee.

serialize()

serialize() 

unserialize()

unserialize(  $data) 

Parameters

$data