Overview

Namespaces

  • Avisota
    • Event
    • Message
    • Queue
    • Recipient
    • RecipientSource
    • Renderer
    • Templating
    • Test
      • Database
      • Imap
      • Message
      • Queue
      • Renderer
      • Transport
    • Transport

Classes

  • MutableRecipient

Interfaces

  • RecipientInterface

Exceptions

  • MutableRecipientDataException
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class MutableRecipient

A mutable recipient object.

Avisota\Recipient\MutableRecipient implements Avisota\Recipient\RecipientInterface
Namespace: Avisota\Recipient
Package: avisota-core
Located at src/Avisota/Recipient/MutableRecipient.php
Methods summary
public
# __construct( mixed $email, array $details = array() )

Parameters

$email
mixed
$email
$details
array
$details
public string
# getEmail( )

Get the recipient email address.

Get the recipient email address.

Returns

string

Implementation of

Avisota\Recipient\RecipientInterface::getEmail()
public
# setEmail( mixed $email )

Set the email address.

Set the email address.

Parameters

$email
mixed
$email

Throws

Avisota\Recipient\MutableRecipientDataException
public boolean
# hasDetails( )

Check if this recipient has personal data.

Check if this recipient has personal data.

Returns

boolean

Implementation of

Avisota\Recipient\RecipientInterface::hasDetails()
public mixed
# get( string $name )

Get a single personal data field value. Return null if the field does not exists.

Get a single personal data field value. Return null if the field does not exists.

Parameters

$name
string
$name

Returns

mixed

Implementation of

Avisota\Recipient\RecipientInterface::get()
public
# set( string $name, mixed $value )

Set a personal data field.

Set a personal data field.

Parameters

$name
string
$name The name of the field.
$value
mixed
$value The value of the field. A value of <span class="php-keyword1">null</span> delete the field.
public array
# getDetails( )

Get all personal data values as associative array.

Get all personal data values as associative array.

Returns

array

Implementation of

Avisota\Recipient\RecipientInterface::getDetails()
public
# setDetails( array $details )

Set multiple personal data fields.

Set multiple personal data fields.

Parameters

$details
array
$details
public array
# getKeys( )

Get all personal data keys.

Get all personal data keys.

Returns

array

Implementation of

Avisota\Recipient\RecipientInterface::getKeys()
Properties summary
protected array $data array()
#
avisota/core API documentation generated by ApiGen 2.8.0