defender-security / vendor / league / uri-interfaces / src / Contracts / PathInterface.php

PathInterface.php in Defender Security – Malware Scanner, Login Security & Firewall 3.0.1, at vendor/league/uri-interfaces/src/Contracts/PathInterface.php

91 lines 2.8 KB

Raw Download Zip

1	<?php
2
3	/**
4	* League.Uri (https://uri.thephpleague.com)
5	*
6	* (c) Ignace Nyamagana Butera <[email protected]>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace League\Uri\Contracts;
15
16	use League\Uri\Exceptions\SyntaxError;
17
18	interface PathInterface extends UriComponentInterface
19	{
20	/**
21	* Returns the decoded path.
22	*/
23	public function decoded(): string;
24
25	/**
26	* Returns whether or not the path is absolute or relative.
27	*/
28	public function isAbsolute(): bool;
29
30	/**
31	* Returns whether or not the path has a trailing delimiter.
32	*/
33	public function hasTrailingSlash(): bool;
34
35	/**
36	* Returns an instance without dot segments.
37	*
38	* This method MUST retain the state of the current instance, and return
39	* an instance that contains the path component normalized by removing
40	* the dot segment.
41	*
42	* @throws SyntaxError for invalid component or transformations
43	* that would result in a object in invalid state.
44	*/
45	public function withoutDotSegments(): self;
46
47	/**
48	* Returns an instance with a leading slash.
49	*
50	* This method MUST retain the state of the current instance, and return
51	* an instance that contains the path component with a leading slash
52	*
53	* @throws SyntaxError for invalid component or transformations
54	* that would result in a object in invalid state.
55	*/
56	public function withLeadingSlash(): self;
57
58	/**
59	* Returns an instance without a leading slash.
60	*
61	* This method MUST retain the state of the current instance, and return
62	* an instance that contains the path component without a leading slash
63	*
64	* @throws SyntaxError for invalid component or transformations
65	* that would result in a object in invalid state.
66	*/
67	public function withoutLeadingSlash(): self;
68
69	/**
70	* Returns an instance with a trailing slash.
71	*
72	* This method MUST retain the state of the current instance, and return
73	* an instance that contains the path component with a trailing slash
74	*
75	* @throws SyntaxError for invalid component or transformations
76	* that would result in a object in invalid state.
77	*/
78	public function withTrailingSlash(): self;
79
80	/**
81	* Returns an instance without a trailing slash.
82	*
83	* This method MUST retain the state of the current instance, and return
84	* an instance that contains the path component without a trailing slash
85	*
86	* @throws SyntaxError for invalid component or transformations
87	* that would result in a object in invalid state.
88	*/
89	public function withoutTrailingSlash(): self;
90	}
91