Add missing ext/operator documentation#4669
Open
jb-lopez wants to merge 3 commits intophp:masterfrom
Open
Conversation
Author
|
I would like to note that since this is a new documentation the workflow run https://github.com/php/doc-en/actions/runs/14958493251/job/42050000015 is going to fail until the related pull request php/doc-base#246 is merged. |
|
Great👍 |
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
lacatoire
reviewed
Apr 21, 2026
Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
jordikroon
reviewed
May 1, 2026
Comment on lines
+315
to
+317
| <para> | ||
| Using the above class, you can overload the operators as follows: | ||
| </para> |
Member
There was a problem hiding this comment.
Suggested change
| <para> | |
| Using the above class, you can overload the operators as follows: | |
| </para> | |
| <simpara> | |
| Using the above class, you can overload the operators as follows: | |
| </simpara> |
Comment on lines
+328
to
+330
| <para> | ||
| The above code will output: | ||
| </para> |
Member
There was a problem hiding this comment.
Suggested change
| <para> | |
| The above code will output: | |
| </para> | |
| <simpara> | |
| The above code will output: | |
| </simpara> |
Comment on lines
+8
to
+11
| <para> | ||
| &pecl.info; | ||
| <link xlink:href="&url.pecl.package;operator">&url.pecl.package;operator</link>. | ||
| </para> |
Member
There was a problem hiding this comment.
Suggested change
| <para> | |
| &pecl.info; | |
| <link xlink:href="&url.pecl.package;operator">&url.pecl.package;operator</link>. | |
| </para> | |
| <simpara> | |
| &pecl.info; | |
| <link xlink:href="&url.pecl.package;operator">&url.pecl.package;operator</link>. | |
| </simpara> |
Comment on lines
+16
to
+17
| operator releases are hosted by PECL and the source code by | ||
| <link xlink:href="&url.git.hub;jb-lopez/pecl-php-operator">github</link>. |
Member
There was a problem hiding this comment.
Suggested change
| operator releases are hosted by PECL and the source code by | |
| <link xlink:href="&url.git.hub;jb-lopez/pecl-php-operator">github</link>. | |
| Operator releases are hosted by PECL and the source code by | |
| <link xlink:href="&url.git.hub;jb-lopez/pecl-php-operator">Github</link>. |
Member
There was a problem hiding this comment.
Could you register this as a global entity in doc-base? global.ent file.
Also PECL is deprecated. It is preferred to use PIE. So I would even suggest to strongly encourage users to install this extension through PIE.
Comment on lines
+80
to
+83
| <para> | ||
| The following is the class that is used in the testing of the operator overloading extension. | ||
| It overloads all of the possible operators that can be overloaded for testing. | ||
| </para> |
Member
There was a problem hiding this comment.
Suggested change
| <para> | |
| The following is the class that is used in the testing of the operator overloading extension. | |
| It overloads all of the possible operators that can be overloaded for testing. | |
| </para> | |
| <simpara> | |
| This class provides implementations for all operators that can be overloaded | |
| by the operator overloading extension. It is intended as a reference class for | |
| users who want to see which overloadable operators are available and how they | |
| are represented. | |
| </simpara> |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request is to add the missing documentation for the PECL operator extension. I have taken over as the lead maintainer for that extension, but this is my first contribution to the PHP documentation so any feedback is welcome. There is a companion pull request to
doc-basethat goes with one and is required by this one. php/doc-base#246There appears to never have been any documentation for the PECL operator extension. For this pull request I've added the test class that ext/operator uses all of its overloading capabilities as a complete code sample.