Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

reportbuilder/Work outline: Difference between revisions

From MoodleDocs
mNo edit summary
(Reformat to create issue headings and put into order of processing)
Line 1: Line 1:
* <strike>Move report builder into report directory. 20</strike>
'''Create and update reportbuilder unit and behat tests'''
* Update Unit tests 20 (Then keep them updated and passing throughout development)
*Update Unit tests (Then keep them updated and passing throughout development)
* Disable javascript calls (currently jquery). 13
*Add behat tests
* Create YUI/Moodle Table (Talk to Frontend) 20
 
* Use automatic class loading. 20
'''Structural changes to reportbuilder'''
* Clean up formatting.
*Use automatic class loading.
** Doc blocks. 20
*Fix existing classes
** Comments. 13
*Work out what is commented out and why (git diff ~/git/totara/mod/scorm/rb_sources/rb_source_scorm.php mod/scorm/rb_sources/rb_source_scorm.php)
** multiple parameters on one line. 20
*Fix warnings
* Fix existing classes
*Remove irrelevant totara data from:
** Work out what is commented out and why (git diff ~/git/totara/mod/scorm/rb_sources/rb_source_scorm.php mod/scorm/rb_sources/rb_source_scorm.php)
**main plugin
** Fix warnings
**child classes
* Replace calls to custom totara functions. 100
*Totara_report_manager block needs to be included (or some other way for students and teachers needs to be found to access the reports).
** totara_set_notification()
*Move language strings to plugin files
** file_postupdate_standard_editor() needs to be replaced (reportbuilder/general.php)
*Fix navigation tree for viewing reports.
** totara_feature_visable()
 
** totara_get_manager()
'''Replace calls to custom totara functions.'''
** Other yet undiscovered functions…
*totara_set_notification()
* Remove irrelevant totara data from:
*file_postupdate_standard_editor() needs to be replaced (reportbuilder/general.php)
** main plugin 20
*totara_feature_visable()
** child classes 20
*totara_get_manager()
* Possibly split up report forms - Not sure that they will get through all in one file. 40
*Other yet undiscovered functions…
* Investigate in detail the file totara/reportbuilder/db/install.php. This changes the database structure which I am sure that integrators would have some hard questions about. 20
 
* reportbuilder/embedded/ all files need to be reviewed to determine if they are useful / relevant. 20
'''Update and create "sources" for the report builder.'''
* reportbuilder/filters/ remove jquery from hierarchy.php if not the whole file. 13
*Port over sources from Totara
* Totara_report_manager block needs to be included (or some other way for students and teachers needs to be found to access the reports). 40
*Remove totara specific fields (diff between the database schemas in Totara and Moodle to see what fields to remove)
* Fix capitilisations. 13
*Remove totara specific functions
* Move language strings to plugin files 40
*Add more classes to useful areas of Moodle (More than just SCORM).
* Fix navigation tree for viewing reports. 20
**Assign (submissions, summary, final grades)
* Cron functions probably need updating to use new cron system. 40
**Site log (exists in Totara, but need to upgrade to new log system)
* Replace add_to_log calls to event classes. 40
**Quiz
** update report
**Forum
** view report
*Make sure theses sources are indexed for performance
** dailyreport
 
** delete
'''Formatting issues in the reportbuilder'''
** $type . ‘ report’ - reportbuilder/index.php line 56 (deletion of report)
*Clean up formatting.
** new report
**Fix capitalisations.
** export report
**Doc blocks.
* accessibility check. 20
**Comments.
* reportbuilder/showhide.php remove jquery and replace with yui. 100
**multiple parameters on one line.
* Review all code 50+ files, thousands of lines of code. 100
*Possibly split up report forms - Not sure that they will get through all in one file.
* Add behat tests 20
*Move add button to the next row so that it’s clear that you already are adding a field
* Port over sources from Totara 40
 
** Remove totara specific fields (diff between the database schemas in Totara and Moodle to see what fields to remove)
'''Update javascript for the reportbuilder'''
** Remove totara specific functions
*Disable javascript calls (currently jquery).
* Add more classes to useful areas of Moodle (More than just SCORM). 100
*Create YUI/Moodle Table (Talk to Frontend)
** Assign 20 (submissions, summary, final grades)
*reportbuilder/filters/ remove jquery from hierarchy.php if not the whole file.
** Site log (exists in Totara, but need to upgrade to new log system)
*reportbuilder/showhide.php remove jquery and replace with yui.
** Quiz
 
** Forum
'''Create / update embedded reports'''
** Make sure theses sources are indexed for performance
*reportbuilder/embedded/ all files need to be reviewed to determine if they are useful / relevant.
* Finish Report Builder documentation 40
 
* Move add button to the next row so that it’s clear that you already are adding a field 5
'''Replace add_to_log calls to event classes.'''
*update report
*view report
*dailyreport
*delete
*$type . ‘ report’ - reportbuilder/index.php line 56 (deletion of report)
*new report
*export report
 
'''Update cron functions to use the new cron system.'''
   
'''Other miscellaneous jobs.'''
*accessibility check.
*Review all code 50+ files, thousands of lines of code.
*Finish Report Builder documentation
*Investigate in detail the file totara/reportbuilder/db/install.php. This changes the database structure which I am sure that integrators would have some hard questions about.

Revision as of 07:30, 26 May 2014

Create and update reportbuilder unit and behat tests

  • Update Unit tests (Then keep them updated and passing throughout development)
  • Add behat tests

Structural changes to reportbuilder

  • Use automatic class loading.
  • Fix existing classes
  • Work out what is commented out and why (git diff ~/git/totara/mod/scorm/rb_sources/rb_source_scorm.php mod/scorm/rb_sources/rb_source_scorm.php)
  • Fix warnings
  • Remove irrelevant totara data from:
    • main plugin
    • child classes
  • Totara_report_manager block needs to be included (or some other way for students and teachers needs to be found to access the reports).
  • Move language strings to plugin files
  • Fix navigation tree for viewing reports.

Replace calls to custom totara functions.

  • totara_set_notification()
  • file_postupdate_standard_editor() needs to be replaced (reportbuilder/general.php)
  • totara_feature_visable()
  • totara_get_manager()
  • Other yet undiscovered functions…

Update and create "sources" for the report builder.

  • Port over sources from Totara
  • Remove totara specific fields (diff between the database schemas in Totara and Moodle to see what fields to remove)
  • Remove totara specific functions
  • Add more classes to useful areas of Moodle (More than just SCORM).
    • Assign (submissions, summary, final grades)
    • Site log (exists in Totara, but need to upgrade to new log system)
    • Quiz
    • Forum
  • Make sure theses sources are indexed for performance

Formatting issues in the reportbuilder

  • Clean up formatting.
    • Fix capitalisations.
    • Doc blocks.
    • Comments.
    • multiple parameters on one line.
  • Possibly split up report forms - Not sure that they will get through all in one file.
  • Move add button to the next row so that it’s clear that you already are adding a field

Update javascript for the reportbuilder

  • Disable javascript calls (currently jquery).
  • Create YUI/Moodle Table (Talk to Frontend)
  • reportbuilder/filters/ remove jquery from hierarchy.php if not the whole file.
  • reportbuilder/showhide.php remove jquery and replace with yui.

Create / update embedded reports

  • reportbuilder/embedded/ all files need to be reviewed to determine if they are useful / relevant.

Replace add_to_log calls to event classes.

  • update report
  • view report
  • dailyreport
  • delete
  • $type . ‘ report’ - reportbuilder/index.php line 56 (deletion of report)
  • new report
  • export report

Update cron functions to use the new cron system.

Other miscellaneous jobs.

  • accessibility check.
  • Review all code 50+ files, thousands of lines of code.
  • Finish Report Builder documentation
  • Investigate in detail the file totara/reportbuilder/db/install.php. This changes the database structure which I am sure that integrators would have some hard questions about.