summaryrefslogtreecommitdiff
path: root/www/wiki/vendor/param-processor/param-processor/src/ParameterTypes.php
blob: 4f984e51454611c47931844a26877dc7ebe93804 (plain)
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
<?php

declare( strict_types = 1 );

namespace ParamProcessor;

use ParamProcessor\Definition\StringParam;
use ParamProcessor\PackagePrivate\DimensionParser;
use ParamProcessor\PackagePrivate\ParamType;
use ValueParsers\BoolParser;
use ValueParsers\FloatParser;
use ValueParsers\IntParser;
use ValueValidators\DimensionValidator;
use ValueValidators\RangeValidator;
use ValueValidators\StringValidator;

/**
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class ParameterTypes {

	/**
	 * @since 1.7
	 */
	public const BOOLEAN = 'boolean';
	public const FLOAT = 'float';
	public const INTEGER = 'integer';
	public const STRING = 'string';
	public const DIMENSION = 'dimension';

	/**
	 * @var ParamType[]
	 */
	private $types = [];

	/**
	 * @param array[] $typeSpecs
	 */
	public function __construct( array $typeSpecs = [] ) {
		foreach ( $typeSpecs as $typeName => $typeSpec ) {
			$this->addType( $typeName, $typeSpec );
		}
	}

	/**
	 * @since 1.8
	 */
	public function addType( string $typeName, array $typeSpec ) {
		$this->types[$typeName] = ParamType::newFromArray( $typeName, $typeSpec );
	}

	/**
	 * Package private
	 */
	public function hasType( string $typeName ): bool {
		return array_key_exists( $typeName, $this->types );
	}

	/**
	 * Package private
	 */
	public function getType( string $typeName ): ParamType {
		return $this->types[$typeName];
	}

	/**
	 * @since 1.8
	 */
	public static function newCoreTypes(): self {
		return new self( self::getCoreTypes() );
	}

	/**
	 * @since 1.4
	 */
	public static function getCoreTypes(): array {
		return [
			self::BOOLEAN => [
				'string-parser' => BoolParser::class,
				'validation-callback' => 'is_bool',
			],
			self::FLOAT => [
				'string-parser' => FloatParser::class,
				'validation-callback' => function( $value ) {
					return is_float( $value ) || is_int( $value );
				},
				'validator' => RangeValidator::class,
			],
			self::INTEGER => [
				'string-parser' => IntParser::class,
				'validation-callback' => 'is_int',
				'validator' => RangeValidator::class,
			],
			self::STRING => [
				'validator' => StringValidator::class,
				'definition' => StringParam::class,
			],
			self::DIMENSION => [
				'string-parser' => DimensionParser::class,
				'validator' => DimensionValidator::class,
			],
		];
	}

}