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 
<?php
/* --------------------------------------------------------------
   AgreementCustomerEmail.inc.php 2018-05-16
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2018 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 AgreementCustomerEmail
 *
 * Represents an agreement customer email
 *
 * @category   System
 * @package    Customer
 * @subpackage ValueObjects
 * @implements CustomerEmailInterface
 */
class AgreementCustomerEmail implements CustomerEmailInterface
{
    /**
     * Customers E-Mail address.
     *
     * @var string
     */
    protected $email;
    
    
    /**
     * AgreementCustomerEmail constructor.
     *
     * @param string $email                   Customer email.
     * @param bool   $encodeSpecialCharacters Encode special characters?
     */
    public function __construct($email, $encodeSpecialCharacters = true)
    {
        if(!is_string($email))
        {
            throw new InvalidArgumentException('$email is not a string');
        }
        
        if(!empty($email) && $encodeSpecialCharacters)
        {
            $punycode = new TrueBV\Punycode();
            $email    = $punycode->encode($email);
        }
        
        if(!empty(trim($email)) && !filter_var($email, FILTER_VALIDATE_EMAIL))
        {
            throw new UnexpectedValueException('$email is not a valid e-mail address: ' . $email);
        }
        
        $this->email = trim($email);
    }
    
    
    /**
     * Returns the equivalent string value.
     *
     * @return string Equivalent string value.
     */
    public function __toString()
    {
        return $this->email;
    }
}