Use strict parameter and return types; requires PHP >= 7.1

Author: cmanley

README.md

@@ -6,7 +6,7 @@ Inspired by [Params::Validate](http://search.cpan.org/perldoc/Params::Validate)
 You can use it to validate almost anything, but typically it can be used for (strictly) validating input from HTML forms, fields while reading CSV files, function parameters, etc.
 
 ### Requirements
-*  PHP 5.4 or later
+*  PHP 7.1 or later
 
 ### Installation
 Download or checkout from git, or install the packagist package cmanley/validate.

composer.json

@@ -12,7 +12,7 @@
 		}
 	],
 	"require": {
-		"php": ">=5.4.0"
+		"php": ">=7.1"
 	},
 	"autoload": {
 		"psr-4": {

src/Exception/NamedValueException.php

@@ -1,9 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
 * Contains the Validate\Exception\NamedValueException class.
 *
 * @author    Craig Manley
-* @copyright Copyright © 2018, Craig Manley (www.craigmanley.com)
+* @copyright Copyright © 2018-2024, Craig Manley (www.craigmanley.com)
 * @license   http://www.opensource.org/licenses/mit-license.php Licensed under MIT
 */
 namespace Validate\Exception;
@@ -31,9 +31,8 @@ class NamedValueException extends ValueException {
 	* @param string $check name of check that failed
 	* @param mixed $value the value that isn't valid
 	* @param string $message optional custom message
-	* @param array $options
 	*/
-	public function __construct($name, $check, $value, $message = null) {
+	public function __construct(string $name, string $check, $value, string $message = null) {
 		$this->name  = $name;
 		$this->check = $check;
 		$this->value = $value;
@@ -52,7 +51,7 @@ public function __construct($name, $check, $value, $message = null) {
 	*
 	* @return string|null
 	*/
-	public function getName() {
+	public function getName(): ?string {
 		return $this->name;
 	}
 }

src/Exception/ValidationException.php

@@ -1,9 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
 * Contains the Validate\Exception\ValidationException class.
 *
 * @author    Craig Manley
-* @copyright Copyright © 2018, Craig Manley (www.craigmanley.com)
+* @copyright Copyright © 2018-2024, Craig Manley (www.craigmanley.com)
 * @license   http://www.opensource.org/licenses/mit-license.php Licensed under MIT
 */
 namespace Validate\Exception;

src/Exception/ValueException.php

@@ -1,9 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
 * Contains the Validate\Exception\ValueException class.
 *
 * @author    Craig Manley
-* @copyright Copyright © 2018, Craig Manley (www.craigmanley.com)
+* @copyright Copyright © 2018-2024, Craig Manley (www.craigmanley.com)
 * @license   http://www.opensource.org/licenses/mit-license.php Licensed under MIT
 */
 namespace Validate\Exception;
@@ -29,9 +29,8 @@ class ValueException extends ValidationException {
 	* @param string $check name of check that failed
 	* @param mixed $value the value that isn't valid
 	* @param string $message optional custom message
-	* @param array $options
 	*/
-	public function __construct($check, $value, $message = null) {
+	public function __construct(string $check, $value, string $message = null) {
 		$this->check = $check;
 		$this->value = $value;
 		if (is_null($message)) {
@@ -49,7 +48,7 @@ public function __construct($check, $value, $message = null) {
 	*
 	* @return string
 	*/
-	public function getCheck() {
+	public function getCheck(): string {
 		return $this->check;
 	}
 
@@ -60,7 +59,7 @@ public function getCheck() {
 	*
 	* @return string|null
 	*/
-	public function getStringPlaceholderValue() {
+	public function getStringPlaceholderValue(): ?string {
 		if (is_scalar($this->value)) {
 			if (is_bool($this->value)) {
 				return $this->value ? 'true' : 'false';
@@ -91,7 +90,7 @@ public function getValue() {
 	*
 	* @return string
 	*/
-	public function getValueSimple() {
+	public function getValueSimple(): string {
 		if (is_bool($this->value)) {
 			return $this->value ? 'true' : 'false';
 		}

src/Spec.php

@@ -1,9 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
 * Contains the Spec class.
 *
 * @author    Craig Manley
-* @copyright Copyright © 2016, Craig Manley (www.craigmanley.com)
+* @copyright Copyright © 2016-2024, Craig Manley (www.craigmanley.com)
 * @license   http://www.opensource.org/licenses/mit-license.php Licensed under MIT
 */
 namespace Validate;
@@ -85,12 +85,12 @@ class Spec {
 	*
 	* The following options are supported:
 	* <pre>
-	*	allow_empty	: boolean, allow empty strings to be validated and pass 'optional' check.
+	*	allow_empty	: bool, allow empty strings to be validated and pass 'optional' check.
 	*	before		: Callback that takes a reference to the value as argument so that it can mutate it before validation. It may trigger validation failure by returning boolean false.
 	*	after		: Callback that takes a reference to the value as argument so that it can mutate it after validation.  It may trigger validation failure by returning boolean false.
 	*	default		: Any non-null value; null arguments to validate() are replaced with this
-	*	optional	: boolean, if true, then null values are allowed
-	*	trim		: boolean, if true, then whitespace is trimmed off both ends of string values before validation.
+	*	optional	: bool, if true, then null values are allowed
+	*	trim		: bool, if true, then whitespace is trimmed off both ends of string values before validation.
 	*	description	: Optional description that can be used by user code.
 	*	validation	: Validation (constraints) object used to validate non-null values.
 	* </pre>
@@ -103,7 +103,7 @@ class Spec {
 	public function __construct(array $args = null) {
 		if ($args) {
 			$boolean_options = array('allow_empty', 'optional', 'trim');
-			$unknown_args = array();
+			$unknown_args = [];
 			foreach ($args as $key => $value) {
 				if ($key == 'validation') {
 					if (!is_null($value)) {
@@ -137,7 +137,7 @@ public function __construct(array $args = null) {
 				}
 				# Process boolean options
 				elseif (in_array($key, $boolean_options)) {
-					$this->$key = (boolean) $value;
+					$this->$key = (bool) $value;
 				}
 
 				elseif (substr($key,0,1) === '_') {
@@ -167,12 +167,13 @@ public function __construct(array $args = null) {
 	*
 	* @throws \BadMethodCallException
 	*/
-	public function __get($key) {
+	#public __get(string $name): mixed {	# PHP8
+	public function __get(string $name) {
 		# TODO: perhaps replace this reflection code with some simple hash access code. See the comments below why.
 		$r = new \ReflectionObject($this);
 		$p = null;
 		try {
-			$p = $r->getProperty($key);
+			$p = $r->getProperty($name);
 		}
 		catch (\ReflectionException $e) {
 			# snuff unknown properties with exception message 'Property x does not exist'
@@ -181,7 +182,7 @@ public function __get($key) {
 			$p->setAccessible(true); # Allow access to non-public members.
 			return $p->getValue($this);
 		}
-		throw new \BadMethodCallException('Attempt to read undefined property ' . get_class($this) . '->' . $key);
+		throw new \BadMethodCallException('Attempt to read undefined property ' . get_class($this) . '->' . $name);
 	}
 
 
@@ -190,7 +191,7 @@ public function __get($key) {
 	*
 	* @return bool
 	*/
-	public function allow_empty() {
+	public function allow_empty(): bool {
 		trigger_error('Method ' . __METHOD__ . ' is deprecated; read the ' . __FUNCTION__ . ' property instead', E_USER_DEPRECATED);
 		return $this->allow_empty;
 	}
@@ -199,7 +200,7 @@ public function allow_empty() {
 	/**
 	* Returns the value of the 'default' option as passed into the constructor.
 	*
-	* @return string|null
+	* @return mixed
 	*/
 	public function getDefault() {
 		trigger_error('Method ' . __METHOD__ . ' is deprecated; read the ' . __FUNCTION__ . ' property instead', E_USER_DEPRECATED);
@@ -212,7 +213,7 @@ public function getDefault() {
 	*
 	* @return string|null
 	*/
-	public function description() {
+	public function description(): ?string {
 		trigger_error('Method ' . __METHOD__ . ' is deprecated; read the ' . __FUNCTION__ . ' property instead', E_USER_DEPRECATED);
 		return $this->description;
 	}
@@ -221,7 +222,7 @@ public function description() {
 	/**
 	* Return the before option as passed in the constructor.
 	*
-	* @return bool
+	* @return Callable
 	*/
 	public function before() {
 		trigger_error('Method ' . __METHOD__ . ' is deprecated; read the ' . __FUNCTION__ . ' property instead', E_USER_DEPRECATED);
@@ -232,7 +233,7 @@ public function before() {
 	/**
 	* Return the after option as passed in the constructor.
 	*
-	* @return bool
+	* @return Callable
 	*/
 	public function after() {
 		trigger_error('Method ' . __METHOD__ . ' is deprecated; read the ' . __FUNCTION__ . ' property instead', E_USER_DEPRECATED);
@@ -278,7 +279,7 @@ public function validation() {
 	*
 	* @return string|null
 	*/
-	public function getLastFailure() {
+	public function getLastFailure(): ?string {
 		return $this->last_failure;
 	}
 
@@ -291,7 +292,7 @@ public function getLastFailure() {
 	* @param mixed &$arg
 	* @return bool
 	*/
-	public function validate(&$arg) {
+	public function validate(&$arg): bool {
 		if (is_string($arg)) {
 			if ($this->trim) {
 				$arg = trim($arg);	# trim is multibyte safe
@@ -364,7 +365,7 @@ public function validate(&$arg) {
 	* @param mixed &$arg
 	* @throws Validate\Exception\ValueException
 	*/
-	public function validate_ex(&$arg) {
+	public function validate_ex(&$arg): void {
 		if (!$this->validate($arg)) {
 			throw new ValueException($this->getLastFailure(), $arg);
 		}

src/SpecCollection.php

@@ -1,9 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
 * Contains the Validate\SpecCollection class.
 *
 * @author    Craig Manley
-* @copyright Copyright © 2016, Craig Manley (www.craigmanley.com)
+* @copyright Copyright © 2016-2024, Craig Manley (www.craigmanley.com)
 * @license   http://www.opensource.org/licenses/mit-license.php Licensed under MIT
 */
 namespace Validate;
@@ -32,10 +32,10 @@ class SpecCollection implements \Countable, \IteratorAggregate, \ArrayAccess {
 	* If boolean values are given, then these are converted into a Spec object with optional => !boolean.
 	* If array values are given, then these are passed as arguments into the constructor of a new Spec object.
 	*
-	* @param array associative array of field name => Spec|boolean|array pairs
+	* @param array associative array of field name => Spec|bool|array pairs
 	* @throws InvalidArgumentException
 	*/
-	public function __construct(array $pairs = array()) {
+	public function __construct(array $pairs = []) {
 		foreach ($pairs as $key => &$value) {
 			static::_checkKeyValuePair($key, $value);
 			unset($value);
@@ -51,12 +51,12 @@ public function __construct(array $pairs = array()) {
 	* @param bool $value
 	* @throws InvalidArgumentException
 	*/
-	private static function _booleanToSpec($value) {
-		$property = 'boolean_spec_' . var_export((boolean)$value, true);
+	private static function _boolToSpec(bool $value): Spec {
+		$property = 'boolean_spec_' . var_export((bool)$value, true);
 		if (!static::$$property) {
-			static::$$property = (new Spec(array(
+			static::$$property = (new Spec([
 				'optional' => !$value,
-			)));
+			]));
 		}
 		return static::$$property;
 	}
@@ -69,7 +69,7 @@ private static function _booleanToSpec($value) {
 	* @param mixed &$value
 	* @throws InvalidArgumentException
 	*/
-	private static function _checkKeyValuePair($key, &$value) {
+	private static function _checkKeyValuePair($key, &$value): void {
 		if (!((is_string($key) && strlen($key)) || is_int($key))) {
 			throw new \InvalidArgumentException('Only string or int keys are allowed');
 		}
@@ -78,7 +78,7 @@ private static function _checkKeyValuePair($key, &$value) {
 				$value = new Spec($value);
 			}
 			elseif (is_bool($value) || is_int($value)) {
-				$value = static::_booleanToSpec($value);
+				$value = static::_boolToSpec((bool)$value);
 			}
 			else {
 				throw new \InvalidArgumentException('Array values must be NULL or boolean or array or an instance of Spec. Got ' . gettype($value) . " for $key");
@@ -91,9 +91,9 @@ private static function _checkKeyValuePair($key, &$value) {
 	* Return count of items in collection.
 	* Implements countable
 	*
-	* @return integer
+	* @return int
 	*/
-	public function count() {
+	public function count(): int {
 		return count($this->pairs);
 	}
 
@@ -103,15 +103,16 @@ public function count() {
 	*
 	* @return ArrayIterator
 	*/
-	public function getIterator() {
+	public function getIterator(): \ArrayIterator {
 		return new \ArrayIterator($this->pairs);	# Uses a copy of pairs; the caller can't mutate this.
 	}
 
 
 	/**
 	* Implements ArrayAccess
 	*/
-	public function offsetSet($offset, $value) {
+	#public function offsetSet(mixed $offset, mixed $value): void {	# PHP8
+	public function offsetSet($offset, $value): void {
 		throw new \BadMethodCallException("Attempt to set value of key \"$offset\" on immutable instance of " . get_class($this));
 		#static::_checkKeyValuePair($offset, $value);
 		#$this->pairs[$offset] = $value;
@@ -123,15 +124,17 @@ public function offsetSet($offset, $value) {
 	*
 	* @return bool
 	*/
-	public function offsetExists($offset) {
+	#public function offsetExists(mixed $offset): bool {	# PHP8
+	public function offsetExists($offset): bool {
 		return array_key_exists($offset, $this->pairs);
 	}
 
 
 	/**
 	* Implements ArrayAccess
 	*/
-	public function offsetUnset($offset) {
+	#public offsetUnset(mixed $offset): void {	# PHP8
+	public function offsetUnset($offset): void {
 		throw new \BadMethodCallException("Attempt to unset key \"$offset\" on immutable instance of " . get_class($this));
 		#unset($this->pairs[$offset]);
 	}
@@ -140,8 +143,10 @@ public function offsetUnset($offset) {
 	/**
 	* Implements ArrayAccess
 	*
-	* @return bool
+	* @return mixed
 	*/
+	#[\ReturnTypeWillChange]
+	#public function offsetGet(mixed $offset): mixed {	# PHP8
 	public function offsetGet($offset) {
 		return array_key_exists($offset, $this->pairs) ? $this->pairs[$offset] : null;
 	}
@@ -152,7 +157,7 @@ public function offsetGet($offset) {
 	*
 	* @return array
 	*/
-	public function toArray() {
+	public function toArray(): array {
 		return $this->pairs;
 	}
 
@@ -162,7 +167,7 @@ public function toArray() {
 	*
 	* @return array
 	*/
-	public function keys() {
+	public function keys(): array {
 		return array_keys($this->pairs);
 	}