PHP Class Kronolith_Attendee, horde

Author: Jan Schneider ([email protected])
Inheritance: implements Serializable
Datei anzeigen Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$email string The attendee's email address.
$name string The attendee's full name.
$response integer One of the Kronolith::RESPONSE_* constants
$role integer One of the Kronolith::PART_* constants
$user string The attendee's user name.

Public Methods

Method Description
__construct ( array $params ) Constructor.
__get ( $what )
__toString ( )
matchesEmail ( string $email, boolean $caseSensitive ) : boolean Returns whether an email address matches this attendee.
migrate ( string $email, array $data ) Migrates data from an old attendee structure.
serialize ( )
toJson ( ) : object Returns a simple object suitable for JSON transport representing this event.
unserialize ( $data )

Method Details

__construct() public method

Constructor.
public __construct ( array $params )
$params array 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.

__get() public method

public __get ( $what )

__toString() public method

public __toString ( )

matchesEmail() public method

Returns whether an email address matches this attendee.
public matchesEmail ( string $email, boolean $caseSensitive ) : boolean
$email string An email address.
$caseSensitive boolean Whether to match case-sensitive.
return boolean True if the email address matches this attendee.

migrate() public static method

Migrates data from an old attendee structure.
public static migrate ( string $email, array $data )
$email string The attendee's email address.
$data array The attendee data from before Kronolith 5.

serialize() public method

public serialize ( )

toJson() public method

Returns a simple object suitable for JSON transport representing this event.
public toJson ( ) : object
return object An object respresenting this attendee.

unserialize() public method

public unserialize ( $data )

Property Details

$email public_oe property

The attendee's email address.
public string $email
return string

$name public_oe property

The attendee's full name.
public string $name
return string

$response public_oe property

One of the Kronolith::RESPONSE_* constants
public int $response
return integer

$role public_oe property

One of the Kronolith::PART_* constants
public int $role
return integer

$user public_oe property

The attendee's user name.
public string $user
return string