[docs] Add class properties deprecation guidelines #1504
+102
−0
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
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for deprecating class properties in Moodle, addressing the unique challenges that arise from PHP's lack of property access interception before version 8.4.
Changes:
- Added guidelines for determining when properties can be deprecated based on visibility (private, protected, public) and class extensibility
- Documented the deprecation process for properties that cannot be immediately removed, including PHPDoc tags, attributes, and migration strategies
- Provided examples for PHP 8.4 property hooks to enable proper deprecation warnings in future Moodle versions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
meirzamoodle
force-pushed
the
class-properties-deprecation
branch
from
8e31c6c to
f4a6ff1
Compare
Documents the process for deprecating class properties, which cannot emit runtime warnings in PHP < 8.4. Key points: - Private properties: remove immediately - Protected properties in non-extensible classes: can be removed - Public/protected properties in extensible classes: use @deprecated tags, attributes, and provide getter/setter methods with warnings - From Moodle 6.0 (PHP 8.4+): use property hooks for proper deprecation
meirzamoodle
force-pushed
the
class-properties-deprecation
branch
from
f4a6ff1 to
453c7db
Compare
Contributor
Author
|
Hi, @andrewnicols The document covers everything you mentioned a couple of days ago. I added an example for setter and getter. Please review this PR. Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Documents the process for deprecating class properties, which cannot emit runtime warnings in PHP < 8.4.
Key points: