Loading...

XML

Word

Printable

Type: Bug
Resolution: Fixed
Priority: Minor
Fix Version/s: 4.4.9, 4.5.5, 5.0.1
Affects Version/s: 4.3, 4.4, 4.5
Component/s: PHPDoc
Labels:
- ci
- triaged

Affected Branches:
MOODLE_403_STABLE, MOODLE_404_STABLE, MOODLE_405_STABLE
Fixed Branches:
MOODLE_404_STABLE, MOODLE_405_STABLE, MOODLE_500_STABLE
Pull from Repository:
https://github.com/daniil-berg/moodle.git
Pull 4.4 Branch:
~~MDL-81454~~-404
Pull 4.4 Diff URL:
https://github.com/moodle/moodle/compare/MOODLE_404_STABLE...daniil-berg:moodle:MDL-81454-404
Pull 4.5 Branch:
~~MDL-81454~~-405
Pull 4.5 Diff URL:
https://github.com/moodle/moodle/compare/MOODLE_405_STABLE...daniil-berg:moodle:MDL-81454-405
Pull Main Branch:
~~MDL-81454~~-main
Pull Main Diff URL:
https://github.com/moodle/moodle/compare/main...daniil-berg:moodle:MDL-81454-main
Difficulty:
Easy
Testing Instructions:

Hide

Simply open the version.php of any plugin, e.g. mod/forum/version.php in PHPStorm (or another IDE that honors @property-read annotations) and see that the $plugin->component = '...' assignment is marked as an error.

With the offending annotation in lib/classes/plugininfo/base.php removed, the error marker disappears.

Show
Simply open the version.php of any plugin, e.g. mod/forum/version.php in PHPStorm (or another IDE that honors @property-read annotations) and see that the $plugin->component = '...' assignment is marked as an error. With the offending annotation in lib/classes/plugininfo/base.php removed, the error marker disappears.
Pre-check results:
Hide

Code verified against automated checks.

Checked ~~MDL-81454~~ using repository: https://github.com/daniil-berg/moodle.git

MOODLE_404_STABLE (0 errors / 0 warnings) [branch: MDL-81454-404 | CI Job]

MOODLE_405_STABLE (0 errors / 0 warnings) [branch: MDL-81454-405 | CI Job]

main (0 errors / 0 warnings) [branch: MDL-81454-main | CI Job]

_{More information about this report}

Built on: Wed Apr 9 07:08:28 UTC 2025
Show
Code verified against automated checks. Checked MDL-81454 using repository: https://github.com/daniil-berg/moodle.git MOODLE_404_STABLE (0 errors / 0 warnings) [branch: MDL-81454-404 | CI Job ] MOODLE_405_STABLE (0 errors / 0 warnings) [branch: MDL-81454-405 | CI Job ] main (0 errors / 0 warnings) [branch: MDL-81454-main | CI Job ] More information about this report Built on: Wed Apr 9 07:08:28 UTC 2025
Automated test results:
Hide

Launching automatic jobs for branch ~~MDL-81454~~-404

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/18879/ PHPUnit (sqlsrv) --> unrelated

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64623/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64624/ Behat (Firefox - boost)

Launching automatic jobs for branch ~~MDL-81454~~-main

https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/18880/ PHPUnit (sqlsrv) --> unrelated

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64625/ Behat (NonJS - boost and classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64626/ Behat (Firefox - boost)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64627/ Behat (Firefox - classic)

https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/65052/ App tests (stable app version)

Built on: Tue Apr 1 02:25:17 UTC 2025
Show
Launching automatic jobs for branch MDL-81454 -404 https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/18879/ PHPUnit (sqlsrv) --> unrelated https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64623/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64624/ Behat (Firefox - boost) Launching automatic jobs for branch MDL-81454 -main https://ci.moodle.org/view/Testing/job/DEV.02%20-%20Developer-requested%20PHPUnit/18880/ PHPUnit (sqlsrv) --> unrelated https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64625/ Behat (NonJS - boost and classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64626/ Behat (Firefox - boost) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/64627/ Behat (Firefox - classic) https://ci.moodle.org/view/Testing/job/DEV.01%20-%20Developer-requested%20Behat/65052/ App tests (stable app version) Built on: Tue Apr 1 02:25:17 UTC 2025

This is a very minor issue and I apologize in advance for taking up precious dev time, but I cannot figure out, why this was declared this way.

In the \core\plugininfo\base there is a PHPDoc annotating @property-read string component and I don't understand the reason for this. Especially since further down the property is declared again normally as public $component = ''; and literally every plugin is required to set this property in the version.php.

The reason this even came up as an issue for me is that PHPStorm rightfully complains in every single version.php file whenever it sees $plugin->component = "something"; that it is read-only. If there is a reason for this declaration in the base class, I would appreciate an explanation. If not, could we just remove this annotation? I could of course provide a tiny merge request for this.

Assignee:: Daniil Fajnberg

Reporter:: Daniil Fajnberg

Peer reviewer:: Andrew Lyons

Integrator:: Sara Arjona (@sarjona)

Tester:: CiBoT

Participants:: Andrew Lyons, CiBoT, Daniil Fajnberg, Jun Pataleta, Matt Porritt, Sara Arjona (@sarjona), Simey Lameze

Votes:: 0 Vote for this issue

Watchers:: 6 Start watching this issue

Created:: 06/Apr/24 3:09 AM

Updated:: 09/May/25 10:20 AM

Resolved:: 17/Apr/25 8:57 PM

Estimated:

Not Specified

Remaining:

Logged:

Details

Description

Attachments

Activity

People

Dates

Time Tracking

Clockify