Details
Bug
Closed
Major
Description
Activity modules are an exception to the rule when it comes to function/activity names.
http://docs.moodle.org/dev/Activity_modules
Currently however I see that a lot of functions and classes prefixed with mod_ have crept into lib.php:
# grep "function mod_" */lib.php assign/lib.php:function mod_assign_get_file_areas($course, $cm, $context) { assign/lib.php:function mod_assign_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) { assignment/lib.php:function mod_assignment_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) { data/lib.php:function mod_data_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) { folder/lib.php:function mod_folder_dndupload_register() { folder/lib.php:function mod_folder_dndupload_handle($uploadinfo) { glossary/lib.php:function mod_glossary_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) { page/lib.php:function mod_page_dndupload_register() { page/lib.php:function mod_page_dndupload_handle($uploadinfo) { quiz/lib.php:function mod_quiz_question_pluginfile($course, $context, $component, resource/lib.php:function mod_resource_dndupload_register() { resource/lib.php:function mod_resource_dndupload_handle($uploadinfo) { url/lib.php:function mod_url_dndupload_register() { url/lib.php:function mod_url_dndupload_handle($uploadinfo) { # grep "class mod_" */lib.php assignment/lib.php:class mod_assignment_grading_form extends moodleform {
This makes the situation slightly insane for developers. I'd love to change everything to mod_ but that is just not an option right now. I think we need to change it back.
This means:
1) Renaming the functions for one callback type at a time.
2) Fixing the calling code looking for these prefixes.
Here is a detailed list of what I think we need to fix:
1) Fix all _get_file_areas (assign)
2) Fix all _get_file_info (assign, assignment, data, glossary)
3) Fix all _dndupload_register (folder, page, resource, url) and calling code!
4) Fix all _dndupload_handle (folder, page, resource, url) and calling code!
Issue Links
- has a non-specific relationship to
-
MDL-33783
Move CORE to use frankenstyle everywhere
-
Activity
I think I'm with Martin here.
+1 to ban any "mod_" from all modules and keep the "exceptional handling" working for them.
The only drawback I can imagine is that we cannot have plugin types in collision with activity names (so we cannot have one "feedback" plugintype, for example), but I don't think that's a big problem really.
Ciao 
Yes, that's exactly what I was saying, take out all those recent "mod_" until we are ready to do the move seriously (2.5?).
And yes, Dan, that happens since day 0, in fact I think it has happened already in th past.
Because of this "mod exceptional usage" (not using frankenstyle), we cannot have other plugins/subsystems using any of the names of one module, because somehow the whole module "name-space" ("feedback_.") is reserved, and it will collide with one "feedback" plugin/subplugin/subsystem, which correct frankenstyle is also "feedback_.").
Note I introduced that side-comment about collisions because I'm convinced that, in the long term, we should begin deprecating "the exceptional uses" (surely debugging some info, say for 2.4. And then, take rid of them for 2.5, for example).
Ciao
Big thanks for the effort. This is now part of Moodle upstream. Let's wait for regressions, yay! LOL
Ciao
Hmm, does this really worth it given how close we are to the release now? Could we instead announce big mod API changes in 2.5 and gradually upgrade everything in the next 12 months?