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 83 84 85 86 87 88 
<?php
/* --------------------------------------------------------------
   CustomerPassword.inc.php 2016-09-09
   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('CustomerPasswordInterface');

/**
 * Class CustomerPassword
 *
 * Represents a customer's password.
 *
 * @deprecated This class is deprecated and will be deleted in GX 3.7. Use CustomerHashedPassword instead.
 * 
 * @category   System
 * @package    Customer
 * @subpackage ValueObjects
 * @implements CustomerPasswordInterface
 */
class CustomerPassword implements CustomerPasswordInterface
{
    /**
     * Customer's password.
     * 
     * @var string
     */
    protected $password;


    /**
     * Constructor for the class CustomerPassword.
     *
     * Validates password and build md5-hash.
     *
     * @param string $p_password    Customer's password.
     * @param bool   $p_disableHash (optional) Will not hash the provided password string.
     *
     * @throws InvalidArgumentException If $p_password is not a string.
     */
    public function __construct($p_password, $p_disableHash = false)
    {
        if(!is_string($p_password))
        {
            throw new InvalidArgumentException('$p_password is not a string');
        }
        
        if(!is_bool($p_disableHash))
        {
            throw new InvalidArgumentException('$p_disableHash is not a bool');
        }
        
        $this->password = $p_disableHash === false ? $this->_getHash($p_password) : $p_password;
    }


    /**
     * Returns the password string value (either hashed or not).
     * 
     * @return string
     */
    public function __toString()
    {
        return $this->password;
    }
    
    
    /**
     * Get password hash string.
     *
     * @deprecated Automatic password hashing is deprecated. Use the AuthService::getHash() for hashing instead.
     *
     * @param string $p_password Password to be hashed.
     *
     * @return string
     * 
     * @throws RuntimeException If the password_hash function fails to hash the password. 
     */
    protected function _getHash($p_password)
    {
        return md5($p_password);
    }
}