Asymptix\core\Validator

Complexity

Total Complexity

54

Size/Duplication

Total Lines	451
Duplicated Lines	16.85 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	8
Bugs	3	Features	5

22 Methods

Rating	Name	Duplication	Size	Complexity
A	validateRegexp()	0	3	1
A	validateLogin()	0	7	2
A	validateCaptcha()	0	15	4
A	isEmail()	0	7	2
A	normalizeUrl()	0	13	3
A	validateNotEmpty()	0	13	3
A	validateChecked()	8	10	2
A	validateEmpty()	0	8	2
A	validateNoSpaces()	8	10	2
A	validatePassword()	0	17	3
A	validateEmail()	11	14	3
A	validateUrl()	0	15	3
B	isUrl()	0	26	1
A	validateTextMaxLength()	11	13	2
A	validateTextMinLength()	11	13	2
A	validateInteger()	11	14	3
A	validateDouble()	0	16	3
A	validateFloat()	0	3	1
A	validatePositive()	8	10	2
B	validateSignIn()	0	16	5
A	validateFileUpload()	0	10	3
A	validateRange()	8	10	2

<?php

namespace Asymptix\core;

use Asymptix\web\Session;
use Asymptix\web\Request;

/**
 * Form fields validation functionality.
 *
 * @category Asymptix PHP Framework
 * @author Dmytro Zarezenko <dmytro.zarezenko@gmail.com>
 * @copyright (c) 2009 - 2017, Dmytro Zarezenko
 *
 * @git https://github.com/Asymptix/Framework
 * @license http://opensource.org/licenses/MIT
 */
class Validator {

    /**
     * Validate field value by regular expression.
     *
     * @param string $fieldValue Value of the field.
     * @param string $regexp Regular expression.
     *
     * @return bool
     */
    public static function validateRegexp($fieldValue, $regexp) {
        return (bool)preg_match($regexp, $fieldValue);
    }

    /**
     * Validate if field value is not empty.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateNotEmpty($fieldName) {
        $fieldValue = Request::getFieldValue($fieldName);
        if (is_string($fieldValue)) {
            $fieldValue = trim($fieldValue);
        }
        if (empty($fieldValue)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::FIELD_CANT_BE_EMPTY);

            return false;
        }

        return true;
    }

    /**
     * Validate if checkbox is checked.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateChecked($fieldName) {

This method seems to be duplicated in your project.

        $fieldValue = trim(Request::getFieldValue($fieldName));
        if (empty($fieldValue)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::CHECK_THIS_FIELD);

            return false;
        }

        return true;
    }

    /**
     * Validate if field value is empty.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateEmpty($fieldName) {
        $fieldValue = trim(Request::getFieldValue($fieldName));
        if (empty($fieldValue)) {
            return true;
        }

        return false;
    }

    /**
     * Validate if field value haven't spaces.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateNoSpaces($fieldName) {

This method seems to be duplicated in your project.

        $fieldValue = Request::getFieldValue($fieldName);
        if (strpos($fieldValue, " ") !== false) {
            Errors::saveErrorFor($fieldName, \__ERRORS::SPACES_INACCEPTABLE);

            return false;
        }

        return true;
    }

    /**
     * Validate login value.
     *
     * @param string $fieldName Login field name.
     *
     * @return bool
     */
    public static function validateLogin($fieldName) {
        if (!validateNotEmpty($fieldName)) {
            return false;
        }

        return validateNoSpaces($fieldName);
    }

    /**
     * Validate if field value is real password.
     *
     * @param string $passwordFieldName Name of password field.
     * @param string $rePasswordFieldName Name of password repeting field.
     *
     * @return bool
     */
    public static function validatePassword($passwordFieldName, $rePasswordFieldName) {
        $password = trim(Request::getFieldValue($passwordFieldName));
        $rePassword = trim(Request::getFieldValue($rePasswordFieldName));
        if (empty($password)) {
            Errors::saveErrorFor($passwordFieldName, \__ERRORS::EMPTY_PASSWORD);

            return false;
        }

        if ($password != $rePassword) {
            Errors::saveErrorFor($rePasswordFieldName, \__ERRORS::PASSWORDS_ARE_DIFFERENT);

            return false;
        }

        return true;
    }

    /**
     * Validate if captcha code is correct.
     *
     * @param string $fieldName Name of the captcha field.
     *
     * @return bool
     */
    public static function validateCaptcha($fieldName) {
        if (!validateNotEmpty($fieldName)) {
            return false;
        }
        if (!validateNoSpaces($fieldName)) {
            return false;
        }
        if (Request::getFieldValue($fieldName) != Session::get($fieldName)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_CAPTCHA_CODE);

            return false;
        }

        return true;
    }

    /**
     * Validate if field value is real e-mail address.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateEmail($fieldName) {

This method seems to be duplicated in your project.

        $fieldValue = trim(Request::getFieldValue($fieldName));
        if (!self::validateNotEmpty($fieldName)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_EMAIL);

            return false;
        } elseif (!self::validateRegexp($fieldValue, "#^[A-Za-z0-9\._-]+@([A-Za-z0-9-]+\.)+[A-Za-z0-9-]+$#")) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_EMAIL);

            return false;
        }

        return true;
    }

    /**
     * Validate if variable value is correct e-mail address.
     *
     * @param string $value Value of the variable.
     *
     * @return bool
     */
    public static function isEmail($value) {
        if (empty($value)) {
            return false;
        }

        return self::validateRegexp($value, "#^[A-Za-z0-9\._-]+@([A-Za-z0-9-]+\.)+[A-Za-z0-9-]+$#");
    }

    /**
     * Normalize URL with protocol prefix.
     *
     * @param string $url Unnormalized URL.
     * @param string $protocol Protocol type (default: http).
     *
     * @return string Normalized URL.
     */
    public static function normalizeUrl($url, $protocol = "http") {
        $url = trim($url);
        if (empty($url)) {
            return "";
        }

        if (!self::validateRegexp($url, "#^" . $protocol . "://.+#")) {
            $url = $protocol . "://" . $url;
        }
        $url = preg_replace("#/{3,}#", "//", $url);

        return $url;
    }

    /**
     * Validate if field value is correct URL.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateUrl($fieldName) {
        $fieldValue = Request::getFieldValue($fieldName);

        if (!self::validateNotEmpty($fieldName)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::URL_EMPTY);

            return false;
        } elseif (!self::isUrl($fieldValue)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::URL_INVALID);

            return false;
        }

        return true;
    }

    /**
     * Validate if variable value is correct URL.
     *
     * @param string $value Value of the variable.
     *
     * @return bool
     */
    public static function isUrl($value) {
        $topLevelDomainsList = [
            // 3 letters
            'com', 'org', 'net', 'gov', 'mil', 'biz', 'xyz', 'int', 'edu', 'win',
            'top', 'ltd',

            // 4 letters
            'info', 'mobi', 'name', 'aero', 'jobs', 'news', 'blog', 'rest',
            'arpa', 'guru', 'club', 'asia', 'site', 'tech', 'link', 'life',
            'fund',

            // 5 letters
            'photo', 'click', 'cloud',

            // 6 letters
            'museum', 'travel', 'review',

            // 7 letters
            'network',
        ];

        return self::validateRegexp(
            $value,
            "<^(?#Protocol)(?:(?:ht|f)tp(?:s?)\:\/\/|~/|/)?(?#Username:Password)(?:\w+:\w+@)?(?#Subdomains)(?:(?:[-\w]+\.)+(?#TopLevel Domains)(?:" . implode("|", $topLevelDomainsList) . "|[a-z]{2}))(?#Port)(?::[\d]{1,5})?(?#Directories)(?:(?:(?:/(?:[-\w~!$+|.,=]|%[a-f\d]{2})+)+|/)+|\?|#)?(?#Query)(?:(?:\?(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)(?:&(?:[-\w~!$+|.,*:]|%[a-f\d{2}])+=(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)*)*(?#Anchor)(?:#(?:[-\w~!$+|.,*:=]|%[a-f\d]{2})*)?$>"
        );
    }

    /**
     * Validate maximum length of the text without HTML tags.
     *
     * @global array<string> $_ERRORS Global list of form fields validation errors.
     * @param string $fieldName Name of the field.
     * @param string $maxTextLength Text length limit.
     *
     * @return bool
     */
    public static function validateTextMaxLength($fieldName, $maxTextLength) {

This method seems to be duplicated in your project.

        $text = trim(strip_tags(Request::getFieldValue($fieldName)));
        if (strlen($text) > $maxTextLength) {
            Errors::saveErrorFor(
                $fieldName,
                str_replace("[[1]]", $maxTextLength, \__ERRORS::MAX_TEXT_LENGTH)
            );

            return false;
        }

        return true;
    }

    /**
     * Validate minimum length of the text without HTML tags.
     *
     * @global array<string> $_ERRORS Global list of form fields validation errors.
     * @param string $fieldName Name of the field.
     * @param string $minTextLength Text length limit.
     *
     * @return bool
     */
    public static function validateTextMinLength($fieldName, $minTextLength) {

This method seems to be duplicated in your project.

        $text = trim(strip_tags(Request::getFieldValue($fieldName)));
        if (strlen($text) < $minTextLength) {
            Errors::saveErrorFor(
                $fieldName,
                str_replace("[[1]]", $minTextLength, \__ERRORS::MIN_TEXT_LENGTH)
            );

            return false;
        }

        return true;
    }

    /**
     * Validate if field value is integer.
     *
     * @param string $fieldName Name of the field.
     * @return bool
     */
    public static function validateInteger($fieldName) {

This method seems to be duplicated in your project.

        $fieldValue = trim(Request::getFieldValue($fieldName));
        if (!self::validateNotEmpty($fieldName)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::FIELD_CANT_BE_EMPTY);

            return false;
        } elseif (!Tools::isInteger($fieldValue)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_INTEGER);

            return false;
        }

        return true;
    }

    /**
     * Validate if field value is double(float).
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateDouble($fieldName) {
        $fieldValue = trim(Request::getFieldValue($fieldName));
        $doubleValue = (float)$fieldValue;
        if (!validateNotEmpty($fieldName)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::FIELD_CANT_BE_EMPTY);

            return false;
        } elseif (sprintf("%.2f", $doubleValue) != $fieldValue) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_NUMBER);

            return false;
        }
        changeFieldValue($fieldName, $doubleValue);

        return true;
    }

    /**
     * Validate if field value is double(float).
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validateFloat($fieldName) {
        return self::validateDouble($fieldName);
    }

    /**
     * Validate if field value is positive numeric value.
     *
     * @param string $fieldName Name of the field.
     *
     * @return bool
     */
    public static function validatePositive($fieldName) {

This method seems to be duplicated in your project.

        $fieldValue = trim(Request::getFieldValue($fieldName));
        if ($fieldValue <= 0) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INVALID_POSITIVE);

            return false;
        }

        return true;
    }

    /**
     * Validate if login data is correct.
     *
     * @param string $loginFieldName Name of the login field.
     * @param string $passwordFieldName Name of the password field.
     *
     * @return bool
     */
    public static function validateSignIn($loginFieldName, $passwordFieldName) {
        $login = Request::getFieldValue($loginFieldName);
        $password = Request::getFieldValue($passwordFieldName);

        $validationResult = true;
        if ($login == null || trim($login) == "") {
            Errors::saveErrorFor($loginFieldName, \__ERRORS::EMPTY_LOGIN);
            $validationResult = false;
        }
        if ($password == null || trim($password) == "") {
            Errors::saveErrorFor($passwordFieldName, \__ERRORS::EMPTY_PASSWORD);
            $validationResult = false;
        }

        return $validationResult;
    }

    /**
     * Validate if file was uploaded.
     *
     * @global array $_FILES Global array of uploaded files.
     * @param string $fileFieldName Name of the file field.
     *
     * @return bool
     */
    public static function validateFileUpload($fileFieldName) {

validateFileUpload uses the super-global variable $_FILES which is generally not recommended.

        global $_FILES;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        if (isset($_FILES[$fileFieldName]) && $_FILES[$fileFieldName]['error'] == UPLOAD_ERR_OK) {
            return true;
        }
        Errors::saveErrorFor($fileFieldName, \__ERRORS::FILE_UPLOAD_ERROR);

        return false;
    }

    /**
     * Validates if some value is in array.
     *
     * @param string $fieldName Field name.
     * @param array $range Array with values.
     *
     * @return bool
     */
    public static function validateRange($fieldName, $range) {

This method seems to be duplicated in your project.

        $fieldValue = Request::getFieldValue($fieldName);
        if (!in_array($fieldValue, $range)) {
            Errors::saveErrorFor($fieldName, \__ERRORS::INCORRECT_VALUE);

            return false;
        }

        return true;
    }

}