Skip to content

Commit 6eb42e0

Browse files
committed
update uri-interface readme
1 parent 0b6eca1 commit 6eb42e0

File tree

1 file changed

+4
-22
lines changed

1 file changed

+4
-22
lines changed

README.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ Uri Interfaces
33

44
This package contains an interface to represents URI objects according to [RFC 3986](http://tools.ietf.org/html/rfc3986).
55

6+
> ⚠️ this is a sub-split, for development, pull requests and issues, visit: https://github.com/thephpleague/uri-src
7+
68
System Requirements
79
-------
810

911
You need:
1012

11-
- **PHP >= 7.2** but the latest stable version of PHP is recommended
13+
- **PHP >= 8.1** but the latest stable version of PHP is recommended
1214

1315
Install
1416
--------
@@ -37,6 +39,7 @@ The `UriInterface` interface defines the following methods to access the URI str
3739
<?php
3840

3941
public UriInterface::__toString(void): string
42+
public UriInterface::toString(void): string
4043
public UriInterface::jsonSerialize(void): string
4144
public UriInterface::getScheme(void): ?string
4245
public UriInterface::getUserInfo(void): ?string
@@ -89,26 +92,10 @@ The `UriComponentInterface` interface defines the following methods to access th
8992
public UriComponentInterface::value(): ?string
9093
public UriComponentInterface::toString(): ?string
9194
public UriComponentInterface::__toString(): string
92-
public UriComponentInterface::getContent(): ?string
9395
public UriComponentInterface::getUriComponent(): ?string
9496
public UriComponentInterface::jsonSerialize(): ?string
9597
~~~
9698

97-
- `UriComponentInterface::value()` added since version 2.4.0;
98-
- `UriComponentInterface::toString()` added since version 2.4.0;
99-
- `UriComponentInterface::getContent()` is deprecated since version 2.4.0 and is replaced by `UriComponentInterface::value()`;
100-
- `UriComponentInterface::withContent()` is deprecated since version 2.4.0 with no replacement;
101-
102-
#### Modifying URI properties
103-
104-
The `UriComponentInterface` interface defines the following modifying method. this method **must** be implemented such that it retains the internal state of the current instance and return an instance that contains the changed state.
105-
106-
~~~php
107-
<?php
108-
109-
public UriComponentInterface::withContent(?string $content): static
110-
~~~
111-
11299
### UriComponentInterface extended interfaces
113100

114101
Because each URI component has specific needs most have specialized interface which all extends the `UriComponentInterface` interface. The following interfaces also exist:
@@ -125,11 +112,6 @@ Because each URI component has specific needs most have specialized interface wh
125112
- `League\Uri\Contract\QueryInterface`
126113
- `League\Uri\Contract\SegmentedPathInterface`
127114

128-
Contributing
129-
-------
130-
131-
> ⚠️ this is a sub-split, for development, pull requests and issues, visit: https://github.com/thephpleague/uri-src
132-
133115
License
134116
-------
135117

0 commit comments

Comments
 (0)