Moodle PHPdoc check

Local plugins ::: local_moodlecheck
Maintained by One poor developer...Eloy Lafuente (stronk7), Coolie and AndrewAndrew Lyons
Part of set Moodle development.
Tool for Moodle developers: allows to check phpdocs in the code for compliance with Moodle Coding Style.

Moodle PHPdoc check 1.3.2 - Yet, more deprecations

Moodle 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 4.0, 4.1, 4.2, 4.3, 4.4
Released: xueves, 28 de de marzu de 2024, 01:01

Moodle PHPdoc Checker

Moodlecheck CI

Important note:

This plugin is becoming deprecated and, soon, moodle-cs will get the baton about all the PHPDoc checks. The switch is planned to be implemented progressively. For more details, see the announcement and the tracking issue.

Installation:

Install the source into the local/moodlecheck directory in your moodle

Log in as admin and select:

Settings Site administration Development Moodle PHPdoc check

Enter paths to check and select rules to use.

Customization:

You can add new rules by adding new php files in rules/ directory, they will be included automatically.

Look at other files in this directory for examples.

Please note that if you register the rule with code 'mynewrule', the rule registry will look in language file for strings 'rule_mynewrule' and 'error_mynewrule'. If they are not present, the rule code will be used instead of the rule name and default error message appears.

Version information

Version build number
2024032700
Version release name
1.3.2 - Yet, more deprecations
Can be updated from
1.0.7 - Welcome to tagland! (2021051200), 1.1.1 - Matthew Festivals (2022060200), 1.1.6 - Before summer holidays (2023071400), 1.1.7 (2023071900), 1.1.8 (2023090800), 1.2.0 (2023113000), 1.3.0 - Deprecation begins (2024030700), 1.3.1 - Deprecation continues (2024032200)
Maturity
Stable version
MD5 Sum
0065c637328f52d232e52fc26e97e39d
Supported software
PHP 7.2, Moodle 3.5, Moodle 3.6, Moodle 3.7, PHP 7.3, PHP 7.4, Moodle 3.8, Moodle 3.9, Moodle 3.10, Moodle 3.11, PHP 8.0, Moodle 4.0, PHP 8.1, Moodle 4.1, Moodle 4.2, PHP 8.2, Moodle 4.3, PHP 8.3, Moodle 4.4
  • Latest release for Moodle 3.5
  • Latest release for Moodle 3.6
  • Latest release for Moodle 3.7
  • Latest release for Moodle 3.8
  • Latest release for Moodle 3.9
  • Latest release for Moodle 3.10
  • Latest release for Moodle 3.11
  • Latest release for Moodle 4.0
  • Latest release for Moodle 4.1
  • Latest release for Moodle 4.2
  • Latest release for Moodle 4.3
  • Latest release for Moodle 4.4

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS branch
main
VCS tag
v1.3.2

Default installation instructions for plugins of the type Local plugins

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder in the "local" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation.