Debian Codegraph @

vendor/ramsey/uuid/src/Validator/ValidatorInterface.php

raw
1 <?php
2
3 /**
4 * This file is part of the ramsey/uuid library
5 *
6 * For the full copyright and license information, please view the LICENSE
7 * file that was distributed with this source code.
8 *
9 * @copyright Copyright (c) Ben Ramsey <[email protected]>
10 * @license http://opensource.org/licenses/MIT MIT
11 */
12
13 declare(strict_types=1);
14
15 namespace Ramsey\Uuid\Validator;
16
17 /**
18 * A validator validates a string as a proper UUID
19 *
20 * @immutable
21 */
22 interface ValidatorInterface
23 {
24 /**
25 * Returns the regular expression pattern used by this validator
26 *
27 * @return non-empty-string The regular expression pattern this validator uses
28 */
29 public function getPattern(): string;
30
31 /**
32 * Returns true if the provided string represents a UUID
33 *
34 * @param string $uuid The string to validate as a UUID
35 *
36 * @return bool True if the string is a valid UUID, false otherwise
37 *
38 * @pure
39 */
40 public function validate(string $uuid): bool;
41 }