aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Security/Ip/IAddress.php
blob: bff7744ddcec791c18efa990d69a7ff084af7ac2 (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
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\Security\Ip;

/**
 * @since 30.0.0
 */
interface IAddress {
	/**
	 * Check if a given IP address is valid
	 *
	 * @since 30.0.0
	 */
	public static function isValid(string $ip): bool;

	/**
	 * Check if current address is contained by given ranges
	 *
	 * @since 30.0.0
	 */
	public function matches(IRange ... $ranges): bool;

	/**
	 * Normalized IP address
	 *
	 * @since 30.0.0
	 */
	public function __toString(): string;
}