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 
<?php
/* --------------------------------------------------------------
   CustomerCity.inc.php 2015-01-30 gm
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2015 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

MainFactory::load_class('CustomerCityInterface');
require_once __DIR__ . '/../../../../Shared/Utility/StringUtilityTrait.inc.php';

/**
 * Value Object
 *
 * Class CustomerCity
 *
 * Represents a customer city
 *
 * @category   System
 * @package    Customer
 * @subpackage ValueObjects
 * @implements CustomerCityInterface
 */
class CustomerCity implements CustomerCityInterface
{
    use StringUtilityTrait;
    
    /**
     * Customer's city.
     * @var string
     */
    protected $city;


    /**
     * Constructor of the class CustomerCity.
     *
     * Validates the length and the data type of the customer city.
     *
     * @param string $p_city Customer's city.
     *
     * @throws InvalidArgumentException If $p_city is not a string.
     * @throws LengthException If $p_city contains more characters than 32.
     */
    public function __construct($p_city)
    {
        if(!is_string($p_city))
        {
            throw new InvalidArgumentException('$p_city is not a string');
        }

        $dbFieldLength = 32;
        $city          = trim($p_city);

        if($this->strlenWrapper($city) > $dbFieldLength)
        {
            throw new LengthException('$city is longer than ' . $dbFieldLength . ' characters VARCHAR(32)');
        }
        
        $this->city = $city;
    }


    /**
     * Returns the equivalent string value.
     * @return string Equivalent string value.
     */
    public function __toString()
    {
        return $this->city;
    }
}