1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
<?php
/* --------------------------------------------------------------
CustomerEmail.inc.php 2016-07-08
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
MainFactory::load_class('CustomerEmailInterface');
/**
* Value Object
*
* Class CustomerEmail
*
* Represents a customer email
*
* @category System
* @package Customer
* @subpackage ValueObjects
* @implements CustomerEmailInterface
*/
class CustomerEmail implements CustomerEmailInterface
{
/**
* Customer's E-Mail address.
*
* @var string
*/
protected $email;
/**
* Constructor of the class CustomerEmail.
*
* Validates the data type and format of the customer email.
*
* @param string $p_email Customer's E-Mail address.
* @param bool $encodeSpecialCharacters Optional (true), whether to encode the special unicode characters to ASCII.
*
* @throws InvalidArgumentException If $p_email is not a string.
* @throws UnexpectedValueException If $p_email is not a valid e-mail address.
*/
public function __construct($p_email, $encodeSpecialCharacters = true)
{
if(!is_string($p_email))
{
throw new InvalidArgumentException('$p_email is not a string');
}
if($encodeSpecialCharacters)
{
$punycode = new TrueBV\Punycode();
$email = $punycode->encode($p_email);
}
else
{
$email = $p_email;
}
if(!filter_var($email, FILTER_VALIDATE_EMAIL))
{
throw new UnexpectedValueException('$p_email is not a valid e-mail address: ' . $p_email);
}
$this->email = trim($p_email); // Store the original string and not the encoded one.
}
/**
* Returns the equivalent string value.
*
* @return string Equivalent string value.
*/
public function __toString()
{
return $this->email;
}
}