File Services/Core/Customer/CustomerInputValidator.inc.php

  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  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

<?php
/* --------------------------------------------------------------
   CustomerInputValidator.inc.php 2016-06-27
   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('CustomerInputValidatorInterface');


/**
 * Class CustomerInputValidator
 *
 * Validator class that checks the entered user data.
 *
 * @category   System
 * @package    Customer
 * @subpackage Validation
 * @implements CustomerInputValidatorInterface
 */
class CustomerInputValidator implements CustomerInputValidatorInterface
{
    /**
     * Customer country repository.
     * @var CustomerCountryRepositoryInterface
     */
    protected $customerCountryRepository;

    /**
     * Customer country zone repository.
     * @var CustomerCountryZoneRepositoryInterface
     */
    protected $customerCountryZoneRepository;

    /**
     * Customer service.
     * @var CustomerServiceInterface
     */
    protected $customerService;

    /**
     * Country service.
     * @var CountryServiceInterface
     */
    protected $countryService;

    /**
     * Customer input validator settings.
     * @var CustomerInputValidatorSettingsInterface
     */
    protected $settings;

    /**
     * VAT number validator.
     * @var VatNumberValidatorInterface
     */
    protected $vatNumberValidator;

    /**
     * Error message collection.
     * @var EditableKeyValueCollection
     */
    protected $errorMessageCollection;

    /**
     * Error status.
     * @var bool
     */
    protected $errorStatus = false;


    /**
     * Constructor of the class CustomerInputValidator.
     *
     * @param CustomerServiceInterface                $customerService                Customer service.
     * @param CountryServiceInterface                 $countryService                 Country service.
     * @param CustomerInputValidatorSettingsInterface $customerInputValidatorSettings Customer input validator settings.
     * @param CustomerCountryRepositoryInterface      $customerCountryRepository      Customer country repository.
     * @param CustomerCountryZoneRepositoryInterface  $customerCountryZoneRepository  Customer country zone repository.
     * @param VatNumberValidatorInterface             $vatNumberValidator             VAT number validator.
     */
    public function __construct(CustomerServiceInterface $customerService,
                                CountryServiceInterface $countryService,
                                CustomerInputValidatorSettingsInterface $customerInputValidatorSettings,
                                CustomerCountryRepositoryInterface $customerCountryRepository,
                                CustomerCountryZoneRepositoryInterface $customerCountryZoneRepository,
                                VatNumberValidatorInterface $vatNumberValidator)
    {
        $this->customerService               = $customerService;
        $this->countryService                = $countryService;
        $this->settings                      = $customerInputValidatorSettings;
        $this->customerCountryRepository     = $customerCountryRepository;
        $this->customerCountryZoneRepository = $customerCountryZoneRepository;
        $this->vatNumberValidator            = $vatNumberValidator;
        
        $this->errorMessageCollection = MainFactory::create('EditableKeyValueCollection', array());
    }
    

    /**
     * Checks if the entered customer's gender is valid.
     *
     * @param string $p_gender Customer's gender.
     *
     * @return bool Is valid?
     */
    public function validateGender($p_gender)
    {
        if(!$this->settings->getDisplayGender())
        {
            return true;
        }
        if((string)$p_gender != 'm' && (string)$p_gender != 'f')
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_gender', $this->settings->getGenderErrorMessage());

            return false;
        }

        return true;
    }
    

    /**
     * Checks if the entered customer's first name is valid.
     *
     * @param string $p_firstname Customer's first name.
     *
     * @return bool Is valid?
     */
    public function validateFirstname($p_firstname)
    {
        if(strlen_wrapper(trim((string)$p_firstname)) > $this->settings->getFirstnameMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_first_name', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_firstname) < $this->settings->getFirstnameMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_first_name', $this->settings->getFirstnameErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered customer's last name is valid.
     *
     * @param string $p_lastname Customer's last name.
     *
     * @return bool Is valid?
     */
    public function validateLastname($p_lastname)
    {
        if(strlen_wrapper(trim((string)$p_lastname)) > $this->settings->getLastnameMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_last_name', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_lastname) < $this->settings->getLastnameMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_last_name', $this->settings->getLastnameErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered customer's date of birth is valid.
     * Valid format is: dd.mm.yyyy
     *
     * @param string $p_dateOfBirth Customer's date of birth.
     *
     * @return bool Is valid?
     */
    public function validateDateOfBirth($p_dateOfBirth)
    {
        // @todo DisplayDateOfBirth setting is blocking the unit tests of the class.
        if(!$this->settings->getDisplayDateOfBirth())
        {
            return true;
        }
        $dateOfBirth = (string)$p_dateOfBirth;
        $minLength   = $this->settings->getDateOfBirthMinLength();
        
        if($minLength > 0 || ($dateOfBirth != '' && $minLength === 0))
        {
            if(xtc_date_raw($dateOfBirth) === '' || !preg_match('/^[0-9]{2}[\.\/]{1}[0-9]{2}[\.\/]{1}[0-9]{4}$/', $dateOfBirth)
               || checkdate(substr(xtc_date_raw($dateOfBirth), 4, 2), substr(xtc_date_raw($dateOfBirth), 6, 2),
                            substr(xtc_date_raw($dateOfBirth), 0, 4)) == false
            )
            {
                $this->errorStatus = true;
                $this->errorMessageCollection->setValue('error_birth_day',
                                                        $this->settings->getDateOfBirthErrorMessage());

                return false;
            }
        }

        return true;
    }


    /**
     * Checks if the entered customer's company is valid.
     *
     * @param string $p_company Customer's company.
     *
     * @return bool Is valid?
     */
    public function validateCompany($p_company)
    {
        if(!$this->settings->getDisplayCompany())
        {
            return true;
        }
        $company = (string)$p_company;

        if(strlen_wrapper(trim($company)) > $this->settings->getCompanyMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_company', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper($company) > 0 && strlen_wrapper($company) < $this->settings->getCompanyMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_company', $this->settings->getCompanyErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered parameters are in a valid format.
     *
     * @param string $p_vatNumber VAT number.
     * @param int    $p_countryId Country ID.
     * @param bool   $p_isGuest   Is customer a guest?
     *
     * @return bool Is valid?
     */
    public function validateVatNumber($p_vatNumber, $p_countryId, $p_isGuest)
    {
        if(strlen_wrapper(trim((string)$p_vatNumber)) > $this->settings->getVatNumberMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_vat', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if($this->vatNumberValidator->getErrorStatus($p_vatNumber, $p_countryId, $p_isGuest))
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_vat', $this->settings->getVatNumberErrorMessage());

            return false;
        }

        return true;
    }
    

    /**
     * Checks if the entered email and email confirmation are valid.
     * It will check the minimum length, address syntax, confirmation matching and existence of e-mail address.
     *
     * @param string $p_email             Customer's E-Mail address.
     * @param string $p_emailConfirmation Confirmation E-Mail address.
     *
     * @return bool Is valid?
     */
    public function validateEmailAndConfirmation($p_email, $p_emailConfirmation)
    {
        if($p_email != $p_emailConfirmation)
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_mail', $this->settings->getEmailConfirmationErrorMessage());

            return false;
        }

        if(!$this->validateEmail($p_email))
        {
            return false;
        }

        if(!$this->validateEmailExists($p_email))
        {
            return false;
        }

        return true;
    }


    /**
     * Checks if the entered email is valid.
     *
     * @param string $p_email Customer's E-Mail address.
     *
     * @return bool Is valid?
     */
    public function validateEmail($p_email)
    {
        if(strlen_wrapper($p_email) < $this->settings->getEmailMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_mail', $this->settings->getEmailErrorMessage());

            return false;
        }
        elseif(xtc_validate_email($p_email) == false)
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_mail', $this->settings->getEmailAddressCheckErrorMessage());

            return false;
        }
        elseif(!filter_var($p_email, FILTER_VALIDATE_EMAIL))
        {
            // @codeCoverageIgnoreStart
            # code coverage ignore this edge case, xtc_validate_email usually recognize invalid email addresses.
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_mail', $this->settings->getEmailAddressCheckErrorMessage());

            return false;
            // @codeCoverageIgnoreEnd
        }

        return true;
    }
    
    
    /**
     * Checks if the entered email already exists.
     *
     * @param string            $p_email  Customer's E-Mail address-
     * @param CustomerInterface $customer Customer.
     *
     * @return bool Is valid?
     */
    public function validateEmailExists($p_email, CustomerInterface $customer = null)
    {
        if($this->customerService->registreeEmailExists(MainFactory::create('CustomerEmail', $p_email))
           && ($customer === null
               || $customer->getEmail() != $p_email)
        )
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_mail', $this->settings->getEmailExistsErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered street is valid.
     *
     * @param string $p_street Customer's street.
     *
     * @return bool Is valid?
     */
    public function validateStreet($p_street)
    {
        if(strlen_wrapper(trim((string)$p_street)) > $this->settings->getStreetMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_street', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_street) < $this->settings->getStreetMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_street', $this->settings->getStreetErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered postcode is valid.
     *
     * @param string $p_postcode Customer's post code.
     *
     * @return bool Is valid?
     */
    public function validatePostcode($p_postcode)
    {
        if(strlen_wrapper(trim((string)$p_postcode)) > $this->settings->getPostcodeMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_post_code', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_postcode) < $this->settings->getPostcodeMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_post_code', $this->settings->getPostcodeErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered city is valid.
     *
     * @param string $p_city Customer's city.
     *
     * @return bool Is valid?
     */
    public function validateCity($p_city)
    {
        if(strlen_wrapper(trim((string)$p_city)) > $this->settings->getCityMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_city', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_city) < $this->settings->getCityMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_city', $this->settings->getCityErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered country exists.
     *
     * @param int $p_countryId Customer's country ID.
     *
     * @return bool Is valid?
     */
    public function validateCountry($p_countryId)
    {
        $country = $this->customerCountryRepository->findById(new IdType($p_countryId));
        
        if($country === null || $country->getStatus() === false)
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_country', $this->settings->getCountryErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered country zone is valid.
     *
     * Cases:
     * - If country has zones: It checks if zone belongs to country.
     * - If country does not contain zones: It checks the minimum length of zone name.
     *
     * @param $p_countryZoneName Customer's country zone name.
     * @param $p_countryId       Customer's country ID.
     *
     * @return bool Is valid?
     */
    public function validateCountryZone($p_countryZone, $p_countryId)
    {
        if(!$this->settings->getDisplayCountryZone())
        {
            return true;
        }

        $country = $this->customerCountryRepository->findById(new IdType($p_countryId));
        
        if($country !== null && $this->countryService->countryHasCountryZones($country))
        {
            if(is_numeric($p_countryZone))
            {
                $countryZone = $this->customerCountryZoneRepository->findById(new IdType($p_countryZone));
            }
            else
            {
                if(strlen_wrapper(trim((string)$p_countryZone)) > $this->settings->getCountryZoneMaxLength())
                {
                    $this->errorStatus = true;
                    $this->errorMessageCollection->setValue('error_state',
                                                            $this->settings->getInvalidInputErrorMessage());

                    return false;
                }
                
                $countryZone = $this->customerCountryZoneRepository->findByNameAndCountry(MainFactory::create('CustomerCountryZoneName',
                                                                                                              $p_countryZone),
                                                                                          $country);
            }
            
            if($countryZone === null
               || $country->getStatus() === false
               || !$this->countryService->countryZoneExistsInCountry($countryZone, $country)
            )
            {
                $this->errorStatus = true;
                $this->errorMessageCollection->setValue('error_state',
                                                        $this->settings->getCountryZoneSelectionErrorMessage());

                return false;
            }
        }
        elseif(is_numeric($p_countryZone)
               || strlen_wrapper((string)$p_countryZone) < $this->settings->getCountryZoneMinLength()
        )
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_state', $this->settings->getCountryZoneErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered suburb is valid.
     *
     * @param $p_suburb Customer's suburb.
     *
     * @return bool Is valid?
     */
    public function validateSuburb($p_suburb)
    {
        if(!$this->settings->getDisplaySuburb())
        {
            return true;
        }

        if(strlen_wrapper(trim((string)$p_suburb)) > $this->settings->getSuburbMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_suburb', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        return true;
    }


    /**
     * Checks if the entered telephone number is valid.
     *
     * @param string $p_telephoneNumber Customer's telephone number.
     *
     * @return bool Is valid?
     */
    public function validateTelephoneNumber($p_telephoneNumber)
    {
        if(!$this->settings->getDisplayTelephone())
        {
            return true;
        }

        if(strlen_wrapper(trim((string)$p_telephoneNumber)) > $this->settings->getCallNumberMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_tel', $this->settings->getInvalidInputErrorMessage());

            return false;
        }
        
        if(strlen_wrapper((string)$p_telephoneNumber) < $this->settings->getTelephoneNumberMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_tel', $this->settings->getTelephoneNumberErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered fax number is valid.
     *
     * @param string $p_faxNumber Customer's fax number.
     *
     * @return bool Is valid?
     */
    public function validateFaxNumber($p_faxNumber)
    {
        if(!$this->settings->getDisplayFax())
        {
            return true;
        }

        if(strlen_wrapper(trim((string)$p_faxNumber)) > $this->settings->getCallNumberMaxLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_fax', $this->settings->getInvalidInputErrorMessage());

            return false;
        }

        return true;
    }


    /**
     * Checks if the entered password is valid.
     *
     * @param string $p_password             Customer's password.
     * @param string $p_passwordConfirmation Customer's password confirmation.
     *
     * @return bool Is valid?
     */
    public function validatePassword($p_password, $p_passwordConfirmation)
    {
        if(strlen_wrapper($p_password) < $this->settings->getPasswordMinLength())
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_password', $this->settings->getPasswordErrorMessage());

            return false;
        }
        elseif($p_password !== $p_passwordConfirmation)
        {
            $this->errorStatus = true;
            $this->errorMessageCollection->setValue('error_password2',
                                                    $this->settings->getPasswordMismatchErrorMessage());

            return false;
        }

        return true;
    }
    
    
    /**
     * Checks if the entered additional values are valid.
     *
     * Overload this method to implement needed validation logic.
     *
     * @param KeyValueCollection $addonValues Customer's additional values.
     *
     * @return bool Is valid?
     */
    public function validateAddonValues(KeyValueCollection $addonValues)
    {
        return true;
    }
    

    /**
     * Returns error messages.
     * @deprecated Use getErrorMessageCollection() instead
     * @return array Error messages.
     */
    public function getErrorMessages()
    {
        return $this->errorMessageCollection->getArray();
    }


    /**
     * Returns a collection of error messages.
     *
     * @return EditableKeyValueCollection Collection of error messages.
     */
    public function getErrorMessageCollection()
    {
        return $this->errorMessageCollection;
    }
    
    
    /**
     * Returns the error status.
     *
     * @return bool Error status.
     */
    public function getErrorStatus()
    {
        return $this->errorStatus;
    }
}

Packages

Classes

Interfaces

Exceptions