phpDocumentor

CustomerEmail
in package
implements CustomerEmailInterface

Value Object

Class CustomerEmail

Represents a customer email

Tags
category

System

subpackage

ValueObjects

implements

CustomerEmailInterface

Interfaces, Classes and Traits

CustomerEmailInterface
Value Object.

Table of Contents

$email  : string
Customer's E-Mail address.
__construct()  : mixed
Constructor of the class CustomerEmail.
__toString()  : string
Returns the equivalent string value.

Properties

Methods

__construct()

Constructor of the class CustomerEmail.

public __construct(string $p_email[, bool $encodeSpecialCharacters = true ]) : mixed

Validates the data type and format of the customer email.

Parameters
$p_email : string

Customer's E-Mail address.

$encodeSpecialCharacters : bool = true

Optional (true), whether to encode the special unicode characters to ASCII.

Tags
throws
InvalidArgumentException

If $p_email is not a string.

throws
UnexpectedValueException

If $p_email is not a valid e-mail address.

Return values
mixed

__toString()

Returns the equivalent string value.

public __toString() : string
Return values
string

Equivalent string value.

Search results