Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

Commit 81de4d0

Browse files
committed
Improve composer manifest
1 parent 7c1aafa commit 81de4d0

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,8 @@ echo $url->toAsciiString(); // returns "https://xn--go8h.com/bar/baz?#fragment
1010
echo $url->toUnicodeString(); // returns "https://🐘.com/bar/baz?#fragment"
1111
````
1212

13-
This package provides a PHP polyfill for PHP version greater or equal to **PHP8.1** to the new
14-
native PHP URI parsing features that are in discussion to be included in **PHP8.5**.
15-
16-
The RFC introduces:
17-
18-
- an [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) compliant URI parser via the new `Uri\Rfc3986\Uri` class
19-
- an [WHATWG URL](https://url.spec.whatwg.org/) compliant parser via the new `Uri\WhatWg\Url` class
13+
This package provides a polyfill for PHP version greater or equal to **PHP8.1** to the new
14+
native PHP URI parsing features in [voting phase](https://wiki.php.net/rfc/url_parsing_api#vote) to be included in **PHP8.5**.
2015

2116
## System Requirements
2217

@@ -26,16 +21,24 @@ To use the package you are required to use:
2621
- [League URI Interfaces](https://github.com/thephpleague/uri-interfaces) and its dependencies
2722
- [URL-Parser](https://github.com/TRowbotham/URL-Parser) and its dependencies
2823

24+
> [!TIP]
25+
> You should install `symfony/polyfill-php82` to use its `SensitiveParameter` polyfill if you are using **PHP 8.1**
26+
2927
## Install
3028

31-
Install `aidre-uri` using Composer.
29+
Install `aide-uri` using Composer.
3230

3331
```bash
3432
composer require bakame/aide-uri:dev-main
3533
```
3634

3735
## Documentation
3836

37+
The RFC introduces:
38+
39+
- an [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986) compliant URI parser via the new `Uri\Rfc3986\Uri` class
40+
- an [WHATWG URL](https://url.spec.whatwg.org/) compliant parser via the new `Uri\WhatWg\Url` class
41+
3942
Full documentation can be found on the [Add RFC 3986 and WHATWG compliant URI parsing support RFC](https://wiki.php.net/rfc/url_parsing_api).
4043

4144
## Testing

composer.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bakame/aide-uri",
3-
"description": "URI polyfill for PHP native RFC3986/WHATWG URI classes",
3+
"description": "Polyfill backporting PHP 8.5+ native RFC3986/WHATWG URI features to lower PHP versions",
44
"keywords": ["uri", "url", "rfc3986", "whatwg", "polyfill", "parser", "resolver", "equivalence", "compatibiliy", "portable"],
55
"license": "MIT",
66
"authors": [
@@ -35,6 +35,9 @@
3535
"phpbench/phpbench": "^1.4.1",
3636
"symfony/var-dumper": "^v6.4.21 || ^7.2.6"
3737
},
38+
"suggest": {
39+
"symfony/polyfill-php82": "To use the SensitiveParameter polyfill in PHP8.1"
40+
},
3841
"scripts": {
3942
"benchmark": "phpbench run --report=default",
4043
"phpcs": "php-cs-fixer fix --dry-run --diff -vvv --allow-risky=yes --ansi",
@@ -49,11 +52,11 @@
4952
]
5053
},
5154
"scripts-descriptions": {
52-
"benchmark": "Runs parser benchmark",
55+
"benchmark": "Runs URI and URL classes benchmark",
5356
"phpstan": "Runs complete codebase static analysis",
5457
"phpunit": "Runs unit and functional testing",
5558
"phpcs": "Runs coding style testing",
5659
"phpcs:fix": "Fix coding style issues",
57-
"test": "Runs all tests"
60+
"test": "Runs all tests (excluding the benchmark)"
5861
}
5962
}

0 commit comments

Comments
 (0)