WIP: Add Uri extension documentation #5060
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive documentation for the new Uri extension, which implements RFC 3986 and WHATWG URL Standard specifications. Includes: - Uri\Rfc3986\Uri class with RFC 3986 compliant URI parsing and manipulation - Uri\UriComparisonMode enum for flexible URI comparison options - Complete method reference for all Uri\Rfc3986\Uri getters, setters, and utility methods - Version information indicating availability in PHP 8.5.0+
Add documentation for three new Uri exception/error classes: - Uri\UriError: Base error class for URI operations - Uri\UriException: Base exception class for URI operations - Uri\InvalidUriException: Exception for invalid URI instances These classes provide structured error handling for the Uri extension.
Add comprehensive documentation for the Uri\WhatWg\Url class which implements the WHATWG URL Standard. This includes documentation for: - Constructor and static parse/resolve methods - Getter methods for URL components (scheme, host, port, path, query, fragment, username, password) - Host accessors supporting both ASCII and Unicode representations - Mutator methods (with*) for creating modified URL instances - Serialization methods (toAsciiString, toUnicodeString) - URL comparison via equals() method - Debug and serialization support (__debugInfo, __serialize, __unserialize) Also remove final and readonly modifiers from Uri\Rfc3986\Uri constructor to allow proper inheritance by the WHATWG implementation.
Add documentation for the Uri\WhatWg\UrlValidationErrorType enum with all validation error types. Add class synopsis sections to Uri\Rfc3986\Uri and Uri\WhatWg\Url documentation. Update method descriptions for with* methods across both RFC3986 and WHATWG implementations to use more precise language: "Return this instance with the [component] updated to the given value" instead of "Return a new [instance/URI] instance with a different [component]".
kocsismate
reviewed
Jan 4, 2026
| <methodparam choice="opt"> | ||
| <type>string</type> | ||
| <parameter>baseUrl</parameter> | ||
| <initializer>NULL</initializer> |
Member
There was a problem hiding this comment.
Could you please run ./build/gen_stub.php --replace-classsynopses --replace-methodsynopses . ../doc-en/reference/uri from php-src, standing on the PHP-8.5 branch, and in the same directory level as doc-en? This will make sure that the class and method signatures are correct. For example, uppercase NULL is never used, and null is generated instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add comprehensive documentation for the new Uri extension, which implements RFC 3986 and WHATWG URL Standard specifications.
Includes:
This is a Work In Progress.