Detailed Changes Compared to blocks/blc_modules

This document summarizes the detailed changes in the blocks/blc_modules directory.

1. CHANGELOG.md

• New file: Added a changelog file summarizing all major changes and improvements in the codebase.

2. add_doc.php

• Namespace & Use: Added namespace block_blc_modules\helper; and relevant use statements for better code organization and autoloading.


• SQL Improvements: Changed SQL queries to use parameterized queries for better security and maintainability.


• Class Name Fix: Fixed typo from stdclass to stdClass.

3. amd/build/module.min.js

• Update: Minified JS updated to reflect changes in the source, including new dependencies and logic improvements.


• Dependency: Now includes core/ajax as a dependency.

4. scorm_report.php

• Refactor: Major refactor to use a renderer and a new output class scorm_report_page for rendering the report page, replacing direct HTML output and table generation.


• Template: Now uses a Mustache template for rendering the report.

5. settings.php

• Best Practice: Replaced new lang_string with get_string for all admin setting labels and descriptions, following Moodle best practices.

6. templates/scorm_report_page.mustache

• New file: Added a Mustache template for rendering the SCORM report page, improving separation of logic and presentation.

7. templates/update_scorm_page.mustache

• New file: Added a Mustache template for the SCORM update results page, providing a modern and user-friendly UI for update feedback.

8. templates/validate_settings_page.mustache

• New file: Added a Mustache template for the BLC settings validation page, improving clarity and maintainability.

9. update_scorm.php

• Refactor: Major refactor to use a renderer and a new output class update_scorm_page for rendering the update results, replacing procedural logic and direct file operations.


• Security: Added permission checks and parameter validation.


• UI: Now uses a Mustache template for output.

10. validate_settings.php

• Refactor: Major refactor to use a renderer and a new output class validate_settings_page for rendering the validation results, replacing procedural logic and direct HTML output.


• UI: Now uses a Mustache template for output.

11. version.php

• Update: Bumped plugin version from 2024071100 to 2024071119.

12. version_check.php

• Namespace & Use: Added namespace block_blc_modules\helper; and use stdClass; for better code organization and autoloading.

Summary of Key Improvements

• Modernization: Migration to Mustache templates and output classes for all major UI, improving maintainability and separation of concerns.


• Security: Improved SQL handling and added permission checks.


• Code Quality: Adoption of namespaces, autoloading, and best practices for Moodle plugin development.


• User Experience: Enhanced UI for reports, updates, and validation pages.

For further details on any specific file or change, please request a focused explanation.

Detailed Changes Compared to blocks/blc_modules

This document summarizes the detailed changes in the blocks/blc_modules directory.

1. CHANGELOG.md

• New file: Added a changelog file summarizing all major changes and improvements in the codebase.

2. add_doc.php

• Namespace & Use: Added namespace block_blc_modules\helper; and relevant use statements for better code organization and autoloading.


• SQL Improvements: Changed SQL queries to use parameterized queries for better security and maintainability.


• Class Name Fix: Fixed typo from stdclass to stdClass.

3. amd/build/module.min.js

• Update: Minified JS updated to reflect changes in the source, including new dependencies and logic improvements.


• Dependency: Now includes core/ajax as a dependency.

4. scorm_report.php

• Refactor: Major refactor to use a renderer and a new output class scorm_report_page for rendering the report page, replacing direct HTML output and table generation.


• Template: Now uses a Mustache template for rendering the report.

5. settings.php

• Best Practice: Replaced new lang_string with get_string for all admin setting labels and descriptions, following Moodle best practices.

6. templates/scorm_report_page.mustache

• New file: Added a Mustache template for rendering the SCORM report page, improving separation of logic and presentation.

7. templates/update_scorm_page.mustache

• New file: Added a Mustache template for the SCORM update results page, providing a modern and user-friendly UI for update feedback.

8. templates/validate_settings_page.mustache

• New file: Added a Mustache template for the BLC settings validation page, improving clarity and maintainability.

9. update_scorm.php

• Refactor: Major refactor to use a renderer and a new output class update_scorm_page for rendering the update results, replacing procedural logic and direct file operations.


• Security: Added permission checks and parameter validation.


• UI: Now uses a Mustache template for output.

10. validate_settings.php

• Refactor: Major refactor to use a renderer and a new output class validate_settings_page for rendering the validation results, replacing procedural logic and direct HTML output.


• UI: Now uses a Mustache template for output.

11. version.php

• Update: Bumped plugin version from 2024071100 to 2024071119.

12. version_check.php

• Namespace & Use: Added namespace block_blc_modules\helper; and use stdClass; for better code organization and autoloading.

Summary of Key Improvements

• Modernization: Migration to Mustache templates and output classes for all major UI, improving maintainability and separation of concerns.


• Security: Improved SQL handling and added permission checks.


• Code Quality: Adoption of namespaces, autoloading, and best practices for Moodle plugin development.


• User Experience: Enhanced UI for reports, updates, and validation pages.

For further details on any specific file or change, please request a focused explanation.

Detailed Changes Compared to blocks/blc_modules

This document summarizes the detailed changes in the blocks/blc_modules directory.

1. CHANGELOG.md

• New file: Added a changelog file summarizing all major changes and improvements in the codebase.

2. add_doc.php

• Namespace & Use: Added namespace block_blc_modules\helper; and relevant use statements for better code organization and autoloading.


• SQL Improvements: Changed SQL queries to use parameterized queries for better security and maintainability.


• Class Name Fix: Fixed typo from stdclass to stdClass.

3. amd/build/module.min.js

• Update: Minified JS updated to reflect changes in the source, including new dependencies and logic improvements.


• Dependency: Now includes core/ajax as a dependency.

4. scorm_report.php

• Refactor: Major refactor to use a renderer and a new output class scorm_report_page for rendering the report page, replacing direct HTML output and table generation.


• Template: Now uses a Mustache template for rendering the report.

5. settings.php

• Best Practice: Replaced new lang_string with get_string for all admin setting labels and descriptions, following Moodle best practices.

6. templates/scorm_report_page.mustache

• New file: Added a Mustache template for rendering the SCORM report page, improving separation of logic and presentation.

7. templates/update_scorm_page.mustache

• New file: Added a Mustache template for the SCORM update results page, providing a modern and user-friendly UI for update feedback.

8. templates/validate_settings_page.mustache

• New file: Added a Mustache template for the BLC settings validation page, improving clarity and maintainability.

9. update_scorm.php

• Refactor: Major refactor to use a renderer and a new output class update_scorm_page for rendering the update results, replacing procedural logic and direct file operations.


• Security: Added permission checks and parameter validation.


• UI: Now uses a Mustache template for output.

10. validate_settings.php

• Refactor: Major refactor to use a renderer and a new output class validate_settings_page for rendering the validation results, replacing procedural logic and direct HTML output.


• UI: Now uses a Mustache template for output.

11. version.php

• Update: Bumped plugin version from 2024071100 to 2024071119.

12. version_check.php

• Namespace & Use: Added namespace block_blc_modules\helper; and use stdClass; for better code organization and autoloading.

Summary of Key Improvements

• Modernization: Migration to Mustache templates and output classes for all major UI, improving maintainability and separation of concerns.


• Security: Improved SQL handling and added permission checks.


• Code Quality: Adoption of namespaces, autoloading, and best practices for Moodle plugin development.


• User Experience: Enhanced UI for reports, updates, and validation pages.

For further details on any specific file or change, please request a focused explanation.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

New with version 3.9.4

This version differs from 3.9 in that it delivers various bug fixes related to BLC modules not downloading, and includes a report of BLC modules added through the plugin. This report is available via the plugin settings page.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at Site Administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.

Updating this plugin

The guidance for updating is similar to the guidance for installation.

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by overwriting the existing plugin in the 'blocks' directory of your Moodle.

Blended Learning Consortium Modules

This plugin serves as a tool to easily browse and add SCORM packages from the Blended Learning Consortium repository.

Please note this plugin requires a subscription to the blended learning consortium.

Samples of BLC Modules can be found, and enquiries made through the BLC website:
http://blc-fe.org

Before you get started

In order for this plugin to function, you will need to register to use the plugin with the BLC and go through an administration step. This involves registering your Moodle URL and receiving an API key for use when configuring the plugin.

There are video demonstrations and a instructions on administering the plugin available to registered users.

A PDF/Video guide on using the plugin for teachers is also available via the BLC.

Prerequisites

In order for the plugin to function properly, the SCORM setting 'Enable downloaded package type' (scorm | allowtypelocalsync)must be enabled. This setting can be found by searching site administration for 'downloadable' or navigating to the following settings page:

Site administration / Plugins / Activity modules / SCORM package

Installation

This is a standard Moodle block, there are two options for installing:

Option 1: In more modern versions of Moodle, a site administrator can install this plugin using the tool at site administration / Plugins / Install Plugins.

Option 2: The plugin can also be installed manually by placing the (unzipped version) in the 'blocks' directory of your Moodle.

You will be prompted to enter your API key upon Installation. There is also a tool on the plugin settings page which allows you to check both your API key and URL.