SegmentedPathInterface.php — Independent Analytics – WordPress Analytics Plugin 1.18

independent-analytics / vendor / league / uri-interfaces / src / Contracts / SegmentedPathInterface.php

independent-analytics / vendor / league / uri-interfaces / src / Contracts Last commit date

AuthorityInterface.php 3 years ago DataPathInterface.php 3 years ago DomainHostInterface.php 3 years ago FragmentInterface.php 3 years ago HostInterface.php 3 years ago IpHostInterface.php 3 years ago PathInterface.php 3 years ago PortInterface.php 3 years ago QueryInterface.php 3 years ago SegmentedPathInterface.php 3 years ago UriComponentInterface.php 3 years ago UriException.php 3 years ago UriInterface.php 3 years ago UserInfoInterface.php 3 years ago

SegmentedPathInterface.php

131 lines

1	<?php
2
3	/**
4	* League.Uri (https://uri.thephpleague.com)
5	*
6	* (c) Ignace Nyamagana Butera <nyamsprod@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11	declare (strict_types=1);
12	namespace IAWP\League\Uri\Contracts;
13
14	use IAWP\League\Uri\Exceptions\SyntaxError;
15	/**
16	* @extends \IteratorAggregate<string>
17	*/
18	interface SegmentedPathInterface extends \Countable, \IteratorAggregate, PathInterface
19	{
20	/**
21	* Returns the total number of segments in the path.
22	*/
23	public function count() : int;
24	/**
25	* Iterate over the path segment.
26	*
27	* @return \Iterator<string>
28	*/
29	public function getIterator() : \Iterator;
30	/**
31	* Returns parent directory's path.
32	*/
33	public function getDirname() : string;
34	/**
35	* Returns the path basename.
36	*/
37	public function getBasename() : string;
38	/**
39	* Returns the basename extension.
40	*/
41	public function getExtension() : string;
42	/**
43	* Retrieves a single path segment.
44	*
45	* If the segment offset has not been set, returns null.
46	*/
47	public function get(int $offset) : ?string;
48	/**
49	* Returns the associated key for a specific segment.
50	*
51	* If a value is specified only the keys associated with
52	* the given value will be returned
53	*
54	* @param ?string $segment
55	*
56	* @return int[]
57	*/
58	public function keys(?string $segment = null) : array;
59	/**
60	* Appends a segment to the path.
61	*/
62	public function append(string $segment) : self;
63	/**
64	* Prepends a segment to the path.
65	*/
66	public function prepend(string $segment) : self;
67	/**
68	* Returns an instance with the modified segment.
69	*
70	* This method MUST retain the state of the current instance, and return
71	* an instance that contains the new segment
72	*
73	* If $key is non-negative, the added segment will be the segment at $key position from the start.
74	* If $key is negative, the added segment will be the segment at $key position from the end.
75	*
76	* @param ?string $segment
77	*
78	* @throws SyntaxError If the key is invalid
79	*/
80	public function withSegment(int $key, ?string $segment) : self;
81	/**
82	* Returns an instance without the specified segment.
83	*
84	* This method MUST retain the state of the current instance, and return
85	* an instance that contains the modified component
86	*
87	* If $key is non-negative, the removed segment will be the segment at $key position from the start.
88	* If $key is negative, the removed segment will be the segment at $key position from the end.
89	*
90	* @param int ...$keys remaining keys to remove
91	*
92	* @throws SyntaxError If the key is invalid
93	*/
94	public function withoutSegment(int ...$keys) : self;
95	/**
96	* Returns an instance without duplicate delimiters.
97	*
98	* This method MUST retain the state of the current instance, and return
99	* an instance that contains the path component normalized by removing
100	* multiple consecutive empty segment
101	*/
102	public function withoutEmptySegments() : self;
103	/**
104	* Returns an instance with the specified parent directory's path.
105	*
106	* This method MUST retain the state of the current instance, and return
107	* an instance that contains the extension basename modified.
108	*
109	* @param ?string $path
110	*/
111	public function withDirname(?string $path) : self;
112	/**
113	* Returns an instance with the specified basename.
114	*
115	* This method MUST retain the state of the current instance, and return
116	* an instance that contains the extension basename modified.
117	*
118	* @param ?string $basename
119	*/
120	public function withBasename(?string $basename) : self;
121	/**
122	* Returns an instance with the specified basename extension.
123	*
124	* This method MUST retain the state of the current instance, and return
125	* an instance that contains the extension basename modified.
126	*
127	* @param ?string $extension
128	*/
129	public function withExtension(?string $extension) : self;
130	}
131