give / vendor / vendor-prefixed / stellarwp / validation / src / Config.php

Config.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at vendor/vendor-prefixed/stellarwp/validation/src/Config.php

176 lines 4.4 KB

Raw Download Zip

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Give\Vendors\StellarWP\Validation;
6
7	use InvalidArgumentException;
8	use RuntimeException;
9	use Give\Vendors\StellarWP\ContainerContract\ContainerInterface;
10	use Give\Vendors\StellarWP\Validation\Exceptions\Contracts\ValidationExceptionInterface;
11	use Give\Vendors\StellarWP\Validation\Exceptions\ValidationException;
12
13	/**
14	* Sets up the validation library for use within the application. It provides a way of overriding various parts of the
15	* library to better integrate into the adopting application.
16	*
17	* @since 1.0.0
18	*/
19	class Config
20	{
21	/**
22	* @var ContainerInterface The service container to use for resolving dependencies.
23	*/
24	private static $container;
25
26	/**
27	* @var string The prefix to add to action and hook filters in the library
28	*/
29	private static $hookPrefix = '';
30
31	/**
32	* @var class-string<ValidationExceptionInterface>
33	*/
34	private static $validationExceptionClass = ValidationException::class;
35
36	/**
37	* @var class-string<InvalidArgumentException>
38	*/
39	private static $invalidArgumentExceptionClass = InvalidArgumentException::class;
40
41	/**
42	* @var bool Whether the library has already been initialized
43	*/
44	private static $initialized = false;
45
46	/**
47	* @since 1.0.0
48	*
49	* @param ContainerInterface $container
50	*/
51	public static function setServiceContainer($container): void
52	{
53	self::$container = $container;
54	}
55
56	/**
57	* @since 1.0.0
58	*
59	* @return ContainerInterface
60	*/
61	public static function getServiceContainer()
62	{
63	return self::$container;
64	}
65
66	/**
67	* @since 1.0.0
68	*/
69	public static function getHookPrefix(): string
70	{
71	return self::$hookPrefix;
72	}
73
74	/**
75	* @since 1.0.0
76	*/
77	public static function setHookPrefix(string $prefix): void
78	{
79	self::$hookPrefix = $prefix;
80	}
81
82	/**
83	* @since 1.0.0
84	*
85	* @return never
86	* @throws ValidationExceptionInterface
87	*/
88	public static function throwValidationException()
89	{
90	throw new self::$validationExceptionClass(...func_get_args());
91	}
92
93	/**
94	* @since 1.0.0
95	*
96	* @return class-string<ValidationExceptionInterface>
97	*/
98	public static function getValidationExceptionClass(): string
99	{
100	return self::$validationExceptionClass;
101	}
102
103	/**
104	* @since 1.0.0
105	*
106	* @param class-string<ValidationException> $validationExceptionClass
107	*/
108	public static function setValidationExceptionClass(string $validationExceptionClass): void
109	{
110	if (!is_a($validationExceptionClass, ValidationExceptionInterface::class, true)) {
111	throw new RuntimeException(
112	'The validation exception class must implement the ValidationExceptionInterface'
113	);
114	}
115
116	self::$validationExceptionClass = $validationExceptionClass;
117	}
118
119	/**
120	* @since 1.0.0
121	*
122	* @return never
123	* @throws InvalidArgumentException
124	*/
125	public static function throwInvalidArgumentException()
126	{
127	throw new self::$invalidArgumentExceptionClass(...func_get_args());
128	}
129
130	/**
131	* @since 1.0.0
132	*
133	* @return class-string<InvalidArgumentException>
134	*/
135	public static function getInvalidArgumentExceptionClass(): string
136	{
137	return self::$invalidArgumentExceptionClass;
138	}
139
140	/**
141	* @since 1.0.0
142	*
143	* @param class-string<InvalidArgumentException> $invalidArgumentExceptionClass
144	*/
145	public static function setInvalidArgumentExceptionClass(string $invalidArgumentExceptionClass): void
146	{
147	if (!is_a($invalidArgumentExceptionClass, InvalidArgumentException::class, true)) {
148	throw new RuntimeException(
149	'The invalid argument exception class must extend the InvalidArgumentException'
150	);
151	}
152
153	self::$invalidArgumentExceptionClass = $invalidArgumentExceptionClass;
154	}
155
156	/**
157	* @since 1.0.0
158	*
159	* @return void
160	*/
161	public static function initialize()
162	{
163	if (self::$initialized) {
164	return;
165	}
166
167	if (self::$container === null) {
168	throw new RuntimeException('A service container must be set before initializing the library');
169	}
170
171	$serviceProvider = new ServiceProvider();
172	$serviceProvider->register();
173	self::$initialized = true;
174	}
175	}
176