Warn about assigning to properties of internal classes documented as readonly
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- PHP
- Stars
- 5.6k
- Forks
- 365
- Avg merge
- 1h 25m
- Merged PRs (30d)
- 6
Description
Some classes, such as https://www.php.net/manual/en/class.domexception.php#domexception.synopsis , have instance properties that are <modifier>readonly</modifier> in the SVN phpdoc-en repo.
Have some way to track this in src/Phan/Language/Internal/PropertyMap.php, e.g. prefix the property name with r_
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/Phan/Language/Internal/PropertyMap.php and compare its property representation with the readonly properties documented for DOMException in the linked PHP manual page. Trace how entries in PropertyMap are used when checking assignments; done means assignments to documented readonly internal properties produce the intended warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100