rfc:class-naming-acronyms
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
rfc:class-naming-acronyms [2024/04/05 15:43] – Slight rewording, add accessibility argument, mention FIG. crell | rfc:class-naming-acronyms [2024/05/08 18:55] (current) – Link implementation PRs timwolla | ||
---|---|---|---|
Line 3: | Line 3: | ||
* Date: 2024-04-05 | * Date: 2024-04-05 | ||
* Author: Tim Düsterhus, timwolla@php.net | * Author: Tim Düsterhus, timwolla@php.net | ||
- | * Status: | + | * Status: |
+ | * Implementation: | ||
* First Published at: http:// | * First Published at: http:// | ||
Line 25: | Line 26: | ||
It is well-established in accessibility circles that ALL CAPS text is harder to read than Mixed Case, as mixed case provides greater vertical variation between letters, making it easier to read, especially for people with various reading disorders. | It is well-established in accessibility circles that ALL CAPS text is harder to read than Mixed Case, as mixed case provides greater vertical variation between letters, making it easier to read, especially for people with various reading disorders. | ||
+ | |||
+ | Most accessibility organizations recommend against ALL CAPS. For example: | ||
+ | |||
+ | * [[https:// | ||
+ | * [[https:// | ||
+ | * [[https:// | ||
That issue is amplified if multiple acronyms follow each other. One example is the < | That issue is amplified if multiple acronyms follow each other. One example is the < | ||
Line 32: | Line 39: | ||
Another example might be JavaScript’s < | Another example might be JavaScript’s < | ||
- | === The user-space | + | === The userland |
- | Although there is no formal standard in user-space | + | Although there is no formal standard in userland |
* Symfony' | * Symfony' | ||
Line 44: | Line 51: | ||
* Flysystem is a little inconsistent, | * Flysystem is a little inconsistent, | ||
* PHPUnit is a little inconsistent, | * PHPUnit is a little inconsistent, | ||
- | * Doctrine is also a little inconsistent, | + | * Doctrine is also a little inconsistent, |
- | Although this RFC has no direct impact on user-space | + | Although this RFC has no direct impact on userland |
===== Proposal ===== | ===== Proposal ===== | ||
Line 90: | Line 97: | ||
Url | Url | ||
BtreeMap // B-tree Map | BtreeMap // B-tree Map | ||
- | Id // Identifier | + | UserId |
- | ID // Identity Document | + | |
Char // Character | Char // Character | ||
Intl // Internationalization | Intl // Internationalization | ||
+ | Ssl\Certificate | ||
+ | Ssl\Crl // Certificate Revocation List | ||
+ | Ssl\CrlUrl | ||
</ | </ | ||
Line 104: | Line 113: | ||
URL | URL | ||
BTreeMap | BTreeMap | ||
- | ID // Identifier | + | UserID |
CHAR | CHAR | ||
INTL | INTL | ||
+ | SSL\Certificate | ||
+ | SSL\CRL | ||
+ | SSL\CRLURL | ||
</ | </ | ||
- | ==== Adjusting class names added in PHP 8.4 ==== | + | ==== Adjusting class & method |
The [[domdocument_html5_parser|DOM HTML5 parsing and serialization RFC]] introduced new class names and method names that violate the updated naming policy, should this RFC be accepted. As part of this RFC, the following changes will be made: | The [[domdocument_html5_parser|DOM HTML5 parsing and serialization RFC]] introduced new class names and method names that violate the updated naming policy, should this RFC be accepted. As part of this RFC, the following changes will be made: | ||
Line 117: | Line 129: | ||
* DOM\HTMLCollection -> Dom\HTMLCollection (Justification: | * DOM\HTMLCollection -> Dom\HTMLCollection (Justification: | ||
* DOM\CDATASection -> Dom\CDATASection (Justification: | * DOM\CDATASection -> Dom\CDATASection (Justification: | ||
- | * DOM\HTMLDocument -> Dom\HtmlDocument | + | * DOM\HTMLDocument -> Dom\HTMLDocument (Justification: |
- | * DOM\XMLDocument -> Dom\XmlDocument | + | * DOM\XMLDocument -> Dom\XMLDocument (Justification: |
* DOM\XPath -> Dom\XPath (Justification: | * DOM\XPath -> Dom\XPath (Justification: | ||
* DOM\Implementation:: | * DOM\Implementation:: | ||
Line 127: | Line 139: | ||
* DOM\Document:: | * DOM\Document:: | ||
* DOM\Document:: | * DOM\Document:: | ||
- | * DOM\HTMLDocument:: | + | * DOM\HTMLDocument:: |
- | * DOM\HTMLDocument:: | + | * DOM\HTMLDocument:: |
- | * DOM\HTMLDocument:: | + | * DOM\HTMLDocument:: |
- | * DOM\HTMLDocument:: | + | * DOM\HTMLDocument:: |
- | * DOM\XMLDocument:: | + | * DOM\XMLDocument:: |
- | * DOM\XMLDocument:: | + | * DOM\XMLDocument:: |
For the [[improve_callbacks_dom_and_xsl|Improve callbacks in ext/dom and ext/xsl RFC]] the following changes will be made: | For the [[improve_callbacks_dom_and_xsl|Improve callbacks in ext/dom and ext/xsl RFC]] the following changes will be made: | ||
Line 142: | Line 154: | ||
===== Backward Incompatible Changes ===== | ===== Backward Incompatible Changes ===== | ||
- | Existing | + | Existing |
===== Proposed PHP Version(s) ===== | ===== Proposed PHP Version(s) ===== | ||
Line 183: | Line 195: | ||
===== Proposed Voting Choices ===== | ===== Proposed Voting Choices ===== | ||
- | Include these so readers know where you are heading | + | |
+ | <doodle title=" | ||
+ | * yes | ||
+ | * no | ||
+ | </ | ||
===== Patches and Tests ===== | ===== Patches and Tests ===== | ||
Line 194: | Line 210: | ||
===== Implementation ===== | ===== Implementation ===== | ||
- | n/a | + | * https:// |
+ | * https:// | ||
===== References ===== | ===== References ===== | ||
Line 200: | Line 217: | ||
* [[class-naming|Class Naming RFC]] | * [[class-naming|Class Naming RFC]] | ||
* Prior mailing list discussion: https:// | * Prior mailing list discussion: https:// | ||
+ | * Discussion in PHP-FIG for PER-CS: https:// | ||
===== Rejected Features ===== | ===== Rejected Features ===== | ||
n/a | n/a |
rfc/class-naming-acronyms.1712331834.txt.gz · Last modified: 2024/04/05 15:43 by crell