Course Checks Block
Maintained by
Jez H, Mike Grant, Kevin Moore, Manoj Solanki
This block carries out a number of automated checks on a course, to encourage a minimum standard of course quality, avoid common mistakes and highlight possible areas for improvement. The block also allows for a course to be cleared of empty sections.
Comments
Comments are no longer open for new posts. Existing comments remain available to read.
Plugin service info: For the record, I just made Jeremy (one of the two current maintainers) the lead maintainer of this plugin. Mike no longer seems to be active with Moodle and does not reply to our messages (even though he seems to visit the site from time to time). Same situation happened with mod_bootstrapelements a while ago - see the comment there. I believe that changing the lead maintainer is in a public interest. In case Mike re-appears and does not agree, we will communicate further with how to deal with the ownership of the plugin. Thanks.
I will update the wiki page to make that clearer.
I have just tried your new plugin and I think it can be a good aid when trying to promote a nice content structure on any Moodle site. I especially like the checks for course images
I have looked at the code as well. It looks nice and follows Moodle plugin structures. I do have some tips if your wish to improve your plugin.
* You use a renderer file which is great. There are some hardcoded language strings in there that could be moved to you lang file.
* I am not sure what the block_bcu_course_checks_course_cleanup() should do. If you want to clear the course cache the core function rebuild_course_cache() might proof useful
* On clicking the clean course button I got the Notice "Trying to get property of non-object in /www/moodle_27/blocks/bcu_course_checks/locallib.php on line 144"
* The function in locallib.php do not have a function description. A short description could help other understand what the function is for.
Hope that helps
Please consider adding a screenshot of your plugin to help folks get an idea of what it looks like when installed. Actually I took a quick one while testing and will upload that for you; however, feel free to replace it if you prefer something else that may be more representative.
Please provide a documentation URL. You are welcome to create your documentaiton in Moodle Docs, See http://docs.moodle.org/dev/Plugin_documentation for more information. Actually looking more losely, you mention your intention to create one at http://docs.moodle.org/en/Course_checks_block so I would so you can move forward with that plan.
When adding the block to a course I received the following PHP notices:
Notice: Undefined property: stdClass::$bcu_course_checks_coursecleanup in /var/www/m27/blocks/bcu_course_checks/renderer.php on line 102
Notice: Undefined variable: cleanup in /var/www/m27/blocks/bcu_course_checks/renderer.php on line 108
Usually those types of notices are easily eliminated by making sure to initiate them.
In addition, you should add the release name to the version.php file. See https://docs.moodle.org/dev/version.php for more information.
Another trivial issue is the language files, typically Moodle does initial cap on strings so normally I would expect to see 'Course check block' instead of 'Course Check Block' or 'Course checks' instead of 'Course Checks'.
I noticed that you are using BitBucket.com to host your code. In order to provide a consistent experience for Moodle developers and site administrators, it is recommended to follow the repository naming convention for Moodle plugins, namely, moodle-{plugintype}_{pluginname}. The recommended repository name for this plugin would be:
moodle-block_bcu_course_checks
Would it be worth considering to rename your repository so that it conforms with the naming convention? This is NOT a requirement especially if you have reasons for not wishing to rename it (including I just don't feel like it). I simply like to encourage following the naming convention for consistency. This is mostly a throw back to when folks were using Git to install plugins on their sites so it is less important now. In any case, looking down the road, if you have other plugins that you would like to share with the community, perhaps others you have developed for the BCU, we can group them together in a set if you wish.
I am going to go ahead and approve this plugin. Please do not hesitate to let me know if there is anything I can do to be supportive of your efforts.
Peace - Anthony