Validate::templateComponentName() - Code Metrics - Inspection of "Add constants for debug/demo mode" - cadmium-org/cadmium-cms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 0.4.0 ( cba0fe...bc0e2e )

by Anton

created 2016-11-17 16:58 UTC

Validate::templateComponentName() A

↳ Parent: Validate

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	2
eloc	2
nc	2
nop	1

<?php

namespace Utils {

	use Str;

	class Validate extends \Validate {

		# Validate auth code

		public static function authCode(string $value) {

			return (preg_match(REGEX_USER_AUTH_CODE, $value) ? $value : false);
		}

		# Validate user name

		public static function userName(string $value) {

			$min = CONFIG_USER_NAME_MIN_LENGTH; $max = CONFIG_USER_NAME_MAX_LENGTH;

			return ((preg_match(REGEX_USER_NAME, $value) && Str::between($value, $min, $max)) ? $value : false);
		}

		# Validate user password

		public static function userPassword(string $value) {

			$min = CONFIG_USER_PASSWORD_MIN_LENGTH; $max = CONFIG_USER_PASSWORD_MAX_LENGTH;

			return ((preg_match(REGEX_USER_PASSWORD, $value) && Str::between($value, $min, $max)) ? $value : false);
		}

		# Validate user email

		public static function userEmail(string $value) {

			return self::email($value);
		}

		# Validate template component name

		public static function templateComponentName(string $value) {

			return (preg_match(REGEX_TEMPLATE_COMPONENT_NAME, $value) ? $value : false);
		}

		# Validate file or directory name

		public static function fileName(string $value) {

			return (preg_match(REGEX_FILE_NAME, $value) ? $value : false);
		}

		# Validate url

		public static function url(string $value) {

			if (false === ($value = parent::url($value))) return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			if (!preg_match('/^https?:\/\//', $value)) return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

			# ------------------------

			return rtrim($value, '/');
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}
	}
}


1			<?php
2
3			namespace Utils {
4
5			use Str;
6
7			class Validate extends \Validate {
8
9			# Validate auth code
10
11			public static function authCode(string $value) {
12
13			return (preg_match(REGEX_USER_AUTH_CODE, $value) ? $value : false);
14			}
15
16			# Validate user name
17
18			public static function userName(string $value) {
19
20			$min = CONFIG_USER_NAME_MIN_LENGTH; $max = CONFIG_USER_NAME_MAX_LENGTH;
21
22			return ((preg_match(REGEX_USER_NAME, $value) && Str::between($value, $min, $max)) ? $value : false);
23			}
24
25			# Validate user password
26
27			public static function userPassword(string $value) {
28
29			$min = CONFIG_USER_PASSWORD_MIN_LENGTH; $max = CONFIG_USER_PASSWORD_MAX_LENGTH;
30
31			return ((preg_match(REGEX_USER_PASSWORD, $value) && Str::between($value, $min, $max)) ? $value : false);
32			}
33
34			# Validate user email
35
36			public static function userEmail(string $value) {
37
38			return self::email($value);
39			}
40
41			# Validate template component name
42
43			public static function templateComponentName(string $value) {
44
45			return (preg_match(REGEX_TEMPLATE_COMPONENT_NAME, $value) ? $value : false);
46			}
47
48			# Validate file or directory name
49
50			public static function fileName(string $value) {
51
52			return (preg_match(REGEX_FILE_NAME, $value) ? $value : false);
53			}
54
55			# Validate url
56
57			public static function url(string $value) {
58
59			if (false === ($value = parent::url($value))) return false;
			0 ignored issues – show Bug Best Practice introduced 2016-11-14 22:52 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `Validate::url` of type `the`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
60
61			if (!preg_match('/^https?:\/\//', $value)) return false;
			0 ignored issues – show Bug Best Practice introduced 2016-11-14 22:52 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `Validate::url` of type `the`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
62
63			# ------------------------
64
65			return rtrim($value, '/');
			0 ignored issues – show Bug Best Practice introduced 2016-11-14 22:52 UTC by Report Bug Copy Issue Report The return type of `return rtrim($value, '/');` (`string`) is incompatible with the return type of the parent method `Validate::url` of type `the`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
66			}
67			}
68			}
69

cadmium-org / cadmium-cms

Push — 0.4.0 ( cba0fe...bc0e2e )

Validate::templateComponentName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like