RestValidatorHelper::validate_url() - Code Metrics - notthatbad/silverstripe-rest-api - Measure and Improve Code Quality continuously with Scrutinizer

RestValidatorHelper::validate_url() A
last analyzed 2018-12-19 12:19 UTC

↳ Parent: RestValidatorHelper

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	15
Ratio	100 %

Importance

Changes

Metric	Value
dl	15
loc	15
rs	9.4555
c	0
b	0
f	0
cc	5
nc	4
nop	3

<?php

namespace Ntb\RestAPI;

/**
 * Some generic validators for incoming data.
 * @author Christian Blank <[email protected]>
 */
class RestValidatorHelper {
    const DefaultMaxLength = 1600;
    const PHP_INT_MIN = -2147483648;

    /**
     * @param array $data the data from the request
     * @param string $field the field, that should be checked
     * @param array $options
     * @return string

     * @throws \ValidationException
     */
    public static function validate_string($data, $field, $options=[]) {
        $options = array_merge([
            'required' => true,
            'min' => 0,
            'max' => self::DefaultMaxLength
        ], $options);
        $required = $options['required'];
        $minLength = $options['min'];
        $maxLength = $options['max'];
        if(isset($data[$field]) && is_string($data[$field])) {
            $string = $data[$field];
            // TODO: maybe the converting should not be made in validator
            $string = \Convert::raw2sql(trim($string));
            $length = strlen($string);
            if($length > $maxLength) {
                throw new \ValidationException("Given $field is to long");
            } else if($length < $minLength) {
                throw new \ValidationException("Given $field is to short");
            }
            return $string;
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }

    /**
     * @param mixed $data
     * @param string $field
     * @param array $options
     * @return int

     * @throws \ValidationException
     */
    public static function validate_int($data, $field, $options=[]) {
        $options = array_merge([
            'required' => true,
            'min' => self::PHP_INT_MIN,
            'max' => PHP_INT_MAX
        ], $options);
        $required = $options['required'];
        $min = $options['min'];
        $max = $options['max'];
        if(isset($data[$field]) && is_numeric($data[$field])) {
            $int = (int) $data[$field];
            if($int >= $min && $int <= $max) {
                return $int;
            } else {
                throw new \ValidationException("Given integer '$int' are not in range");
            }
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }

    /**
     * @param mixed $data
     * @param string $field
     * @param array $options
     * @return string

     * @throws \ValidationException
     */
    public static function validate_datetime($data, $field, $options=[]) {
        $options = array_merge([
            'required' => true
        ], $options);
        $required = $options['required'];
        if(isset($data[$field]) && is_string($data[$field])) {
            $date = $data[$field];
            $dateTime = new \SS_Datetime();
            $dateTime->setValue($date);
            if(!$dateTime->getValue()) {
                throw new \ValidationException("No valid datetime given.");
            }
            return $dateTime->Format('Y-m-d H:i:s');
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }

    /**
     * @param mixed $data
     * @param string $field
     * @param array $options
     * @return string
     * @throws \ValidationException
     */
    public static function validate_url($data, $field, $options=[]) {

        $options = array_merge([
            'required' => true
        ], $options);
        $required = $options['required'];
        if(isset($data[$field]) && is_string($data[$field])) {
            $url = $data[$field];
            if(!self::is_url($url)) {
                throw new \ValidationException("No valid url given");
            }
            return $url;
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }

    /**
     * Validates an URL (defined in RFC 3986).
     *
     * @param string $url the url, that should be validated
     * @return boolean
     */
    public static function is_url($url) {
        /**
         * @author https://gist.github.com/dperini/729294
         */
        $regex = '_^(?:(?:https?|ftp)://)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\x{00a1}-\x{ffff}0-9]-*)*[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.(?:[a-z\x{00a1}-\x{ffff}0-9]-*)*[a-z\x{00a1}-\x{ffff}0-9]+)*(?:\.(?:[a-z\x{00a1}-\x{ffff}]{2,}))\.?)(?::\d{2,5})?(?:[/?#]\S*)?$_iuS';
        return preg_match($regex, $url) === 1;
    }

    /**
     * @param mixed $data
     * @param string $field
     * @param array $options
     * @return string
     * @throws \ValidationException
     */
    public static function validate_country_code($data, $field, $options=[]) {
        $options = array_merge([
            'required' => true
        ], $options);
        $required = $options['required'];
        if(isset($data[$field]) && is_string($data[$field])) {
            $code = $data[$field];
            $countries = \Zend_Locale::getTranslationList('territory', \i18n::get_locale(), 2);
            if(!array_key_exists(strtoupper($code), $countries)) {
                throw new \ValidationException("No valid country code given");
            }
            return $code;
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }

    /**
     * @param mixed $data
     * @param string $field
     * @param array $options
     * @return string
     * @throws \ValidationException
     */
    public static function validate_email($data, $field, $options=[]) {

        $options = array_merge([
            'required' => true
        ], $options);
        $required = $options['required'];
        if(isset($data[$field]) && is_string($data[$field])) {
            $email = $data[$field];
            if(\Email::is_valid_address($email) === 0) {
                throw new \ValidationException("No valid email given");
            }
            return $email;
        } else if($required) {
            throw new \ValidationException("No $field given, but $field is required");
        }
    }
}


1		<?php
2
3		namespace Ntb\RestAPI;
4
5		/**
6		* Some generic validators for incoming data.
7		* @author Christian Blank <[email protected]>
8		*/
9		class RestValidatorHelper {
10		const DefaultMaxLength = 1600;
11		const PHP_INT_MIN = -2147483648;
12
13		/**
14		* @param array $data the data from the request
15		* @param string $field the field, that should be checked
16		* @param array $options
17		* @return string
		0 ignored issues – show Documentation introduced 2016-05-18 07:01 UTC by Report Bug Copy Issue Report Should the return type not be `array\|string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
18		* @throws \ValidationException
19		*/
20		public static function validate_string($data, $field, $options=[]) {
21		$options = array_merge([
22		'required' => true,
23		'min' => 0,
24		'max' => self::DefaultMaxLength
25		], $options);
26		$required = $options['required'];
27		$minLength = $options['min'];
28		$maxLength = $options['max'];
29		if(isset($data[$field]) && is_string($data[$field])) {
30		$string = $data[$field];
31		// TODO: maybe the converting should not be made in validator
32		$string = \Convert::raw2sql(trim($string));
33		$length = strlen($string);
34		if($length > $maxLength) {
35		throw new \ValidationException("Given $field is to long");
36		} else if($length < $minLength) {
37		throw new \ValidationException("Given $field is to short");
38		}
39		return $string;
40		} else if($required) {
41		throw new \ValidationException("No $field given, but $field is required");
42		}
43		}
44
45		/**
46		* @param mixed $data
47		* @param string $field
48		* @param array $options
49		* @return int
		0 ignored issues – show Documentation introduced 2016-05-18 07:01 UTC by Report Bug Copy Issue Report Should the return type not be `integer\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
50		* @throws \ValidationException
51		*/
52		public static function validate_int($data, $field, $options=[]) {
53		$options = array_merge([
54		'required' => true,
55		'min' => self::PHP_INT_MIN,
56		'max' => PHP_INT_MAX
57		], $options);
58		$required = $options['required'];
59		$min = $options['min'];
60		$max = $options['max'];
61		if(isset($data[$field]) && is_numeric($data[$field])) {
62		$int = (int) $data[$field];
63		if($int >= $min && $int <= $max) {
64		return $int;
65		} else {
66		throw new \ValidationException("Given integer '$int' are not in range");
67		}
68		} else if($required) {
69		throw new \ValidationException("No $field given, but $field is required");
70		}
71		}
72
73		/**
74		* @param mixed $data
75		* @param string $field
76		* @param array $options
77		* @return string
		0 ignored issues – show Documentation introduced 2016-05-18 07:01 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
78		* @throws \ValidationException
79		*/
80		public static function validate_datetime($data, $field, $options=[]) {
81		$options = array_merge([
82		'required' => true
83		], $options);
84		$required = $options['required'];
85		if(isset($data[$field]) && is_string($data[$field])) {
86		$date = $data[$field];
87		$dateTime = new \SS_Datetime();
88		$dateTime->setValue($date);
89		if(!$dateTime->getValue()) {
90		throw new \ValidationException("No valid datetime given.");
91		}
92		return $dateTime->Format('Y-m-d H:i:s');
93		} else if($required) {
94		throw new \ValidationException("No $field given, but $field is required");
95		}
96		}
97
98		/**
99		* @param mixed $data
100		* @param string $field
101		* @param array $options
102		* @return string
103		* @throws \ValidationException
104		*/
105	View Code Duplication	public static function validate_url($data, $field, $options=[]) {
		0 ignored issues – show Duplication introduced 2016-05-18 07:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106		$options = array_merge([
107		'required' => true
108		], $options);
109		$required = $options['required'];
110		if(isset($data[$field]) && is_string($data[$field])) {
111		$url = $data[$field];
112		if(!self::is_url($url)) {
113		throw new \ValidationException("No valid url given");
114		}
115		return $url;
116		} else if($required) {
117		throw new \ValidationException("No $field given, but $field is required");
118		}
119		}
120
121		/**
122		* Validates an URL (defined in RFC 3986).
123		*
124		* @param string $url the url, that should be validated
125		* @return boolean
126		*/
127		public static function is_url($url) {
128		/**
129		* @author https://gist.github.com/dperini/729294
130		*/
131		$regex = '_^(?:(?:https?\|ftp)://)(?:\S+(?::\S)?@)?(?:(?!(?:10\|127)(?:\.\d{1,3}){3})(?!(?:169\.254\|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]\|2\d\|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?\|1\d\d\|2[01]\d\|22[0-3])(?:\.(?:1?\d{1,2}\|2[0-4]\d\|25[0-5])){2}(?:\.(?:[1-9]\d?\|1\d\d\|2[0-4]\d\|25[0-4]))\|(?:(?:[a-z\x{00a1}-\x{ffff}0-9]-)[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.(?:[a-z\x{00a1}-\x{ffff}0-9]-)[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.(?:[a-z\x{00a1}-\x{ffff}]{2,}))\.?)(?::\d{2,5})?(?:[/?#]\S*)?$_iuS';
132		return preg_match($regex, $url) === 1;
133		}
134
135		/**
136		* @param mixed $data
137		* @param string $field
138		* @param array $options
139		* @return string
140		* @throws \ValidationException
141		*/
142		public static function validate_country_code($data, $field, $options=[]) {
143		$options = array_merge([
144		'required' => true
145		], $options);
146		$required = $options['required'];
147		if(isset($data[$field]) && is_string($data[$field])) {
148		$code = $data[$field];
149		$countries = \Zend_Locale::getTranslationList('territory', \i18n::get_locale(), 2);
150		if(!array_key_exists(strtoupper($code), $countries)) {
151		throw new \ValidationException("No valid country code given");
152		}
153		return $code;
154		} else if($required) {
155		throw new \ValidationException("No $field given, but $field is required");
156		}
157		}
158
159		/**
160		* @param mixed $data
161		* @param string $field
162		* @param array $options
163		* @return string
164		* @throws \ValidationException
165		*/
166	View Code Duplication	public static function validate_email($data, $field, $options=[]) {
		0 ignored issues – show Duplication introduced 2016-05-18 07:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
167		$options = array_merge([
168		'required' => true
169		], $options);
170		$required = $options['required'];
171		if(isset($data[$field]) && is_string($data[$field])) {
172		$email = $data[$field];
173		if(\Email::is_valid_address($email) === 0) {
174		throw new \ValidationException("No valid email given");
175		}
176		return $email;
177		} else if($required) {
178		throw new \ValidationException("No $field given, but $field is required");
179		}
180		}
181		}
182

notthatbad / silverstripe-rest-api

RestValidatorHelper::validate_url() A last analyzed 2018-12-19 12:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RestValidatorHelper::validate_url() A
last analyzed 2018-12-19 12:19 UTC