SegmentedPathInterface.php — Independent Analytics – WordPress Analytics Plugin 2.15.5

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

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

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

SegmentedPathInterface.php

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