Moodle Plugins directory: Sandbox: Versions: 2.3 RC1 (Build: 2013010801) | Moodle.org

Sandbox
Local plugins ::: local_sandbox
Maintained by
Moodle an Hochschulen e.V.,
Alexander Bias
Moodle plugin which programatically restores courses to predefined course states. It can be used to provide playground moodle courses which will be cleaned periodically.
Sandbox 2.3 RC1 (Build: 2013010801)
Moodle 2.3
Released: Lunes, 21 Enero 2013, 3:15 PM
moodle-local_sandbox
====================
Moodle plugin which programatically restores courses to predefined course states. It can be used to provide playground moodle courses which will be cleaned periodically.
Requirements
============
This plugin requires Moodle 2.3+
Changes
=======
2013-01-21 - Bugfix: Fix flaw in german language pack
2013-01-08 - Initial version
Installation
============
Install the plugin like any other plugin to folder
/local/sandbox
See http://docs.moodle.org/23/en/Installing_plugins for details on installing Moodle plugins
Usage & Settings
================
After installing local_sandbox, the plugin doesn't do anything until it is configured.
To configure the plugin, please visit Plugins -> Local plugins -> Sandbox.
There, you find three sections:
1. Execution time
-----------------
In this section, you define on which days and when on each day local_sandbox should restore the courses.
2. Course backups
-----------------
In this section, you define the directory where the course backup files to use for course restoring are. local_sandbox takes every file in this directory with a .mbz filename extension, takes the file's name, searches for a existing course with a shortname equal to the file's name and finally, uses the course backup file to restore / reset this course.
Example:
The sandbox directory /var/www/files/moodledata/sandbox contains the files foo.bar and mylittlecourse.mbz. local_sandbox looks at the directory and finds two files. File foo.bar is ignored by local_sandbox because it doesn't have the right filename extension. File mylittlecourse.mbz will be considered for restoring a sandbox course. local_sandbox now looks for a existing course with shortname "mylittlecourse". If this course exists, it resets / restores it to the state saved in the mylittlecourse.mbz backup file. If this course doesn't exist, local_sandbox doesn't change anything.
Additionally, in this section, there is an option to set the course start date to today instead of setting it to the date saved in the course backup file. Use this option if you need to provide playground courses in Moodle which pretend to be up-to-date.
3. Notifications
----------------
As local_sandbox acts automatically, it can inform you when failures or problems occur. In this section, you can define who should be notified and which failures or problems should be reported.
Themes
======
The local_sandbox plugin acts behind the scenes, therefore it works with all Moodle Themes.
Further information
===================
local_sandbox is found in the Moodle Plugins repository: http://moodle.org/plugins/view.php?plugin=local_sandbox
Report a bug or suggest an improvement: https://github.com/abias/moodle-local_sandbox/issues
Copyright
=========
Alexander Bias, University of Ulm
====================
Moodle plugin which programatically restores courses to predefined course states. It can be used to provide playground moodle courses which will be cleaned periodically.
Requirements
============
This plugin requires Moodle 2.3+
Changes
=======
2013-01-21 - Bugfix: Fix flaw in german language pack
2013-01-08 - Initial version
Installation
============
Install the plugin like any other plugin to folder
/local/sandbox
See http://docs.moodle.org/23/en/Installing_plugins for details on installing Moodle plugins
Usage & Settings
================
After installing local_sandbox, the plugin doesn't do anything until it is configured.
To configure the plugin, please visit Plugins -> Local plugins -> Sandbox.
There, you find three sections:
1. Execution time
-----------------
In this section, you define on which days and when on each day local_sandbox should restore the courses.
2. Course backups
-----------------
In this section, you define the directory where the course backup files to use for course restoring are. local_sandbox takes every file in this directory with a .mbz filename extension, takes the file's name, searches for a existing course with a shortname equal to the file's name and finally, uses the course backup file to restore / reset this course.
Example:
The sandbox directory /var/www/files/moodledata/sandbox contains the files foo.bar and mylittlecourse.mbz. local_sandbox looks at the directory and finds two files. File foo.bar is ignored by local_sandbox because it doesn't have the right filename extension. File mylittlecourse.mbz will be considered for restoring a sandbox course. local_sandbox now looks for a existing course with shortname "mylittlecourse". If this course exists, it resets / restores it to the state saved in the mylittlecourse.mbz backup file. If this course doesn't exist, local_sandbox doesn't change anything.
Additionally, in this section, there is an option to set the course start date to today instead of setting it to the date saved in the course backup file. Use this option if you need to provide playground courses in Moodle which pretend to be up-to-date.
3. Notifications
----------------
As local_sandbox acts automatically, it can inform you when failures or problems occur. In this section, you can define who should be notified and which failures or problems should be reported.
Themes
======
The local_sandbox plugin acts behind the scenes, therefore it works with all Moodle Themes.
Further information
===================
local_sandbox is found in the Moodle Plugins repository: http://moodle.org/plugins/view.php?plugin=local_sandbox
Report a bug or suggest an improvement: https://github.com/abias/moodle-local_sandbox/issues
Copyright
=========
Alexander Bias, University of Ulm
Version information
- Version build number
- 2013010801
- Version release name
- 2.3 RC1 (Build: 2013010801)
- Can be updated to
- 2.4 (Build: 2013021800), 2.4 (Build: 2013021801)
- Maturity
- Release candidate
- MD5 Sum
- 11582d1d334663fef49ba349d9ba0f65
- Supported software
- Moodle 2.3
- Latest release for Moodle 2.3
Version control information
- Version control system (VCS)
- GIT
- VCS repository URL
Default installation instructions for plugins of the type Local plugins
- Make sure you have all the required versions.
- Download and unpack the module.
- Place the folder in the "local" subdirectory.
- Visit http://yoursite.com/admin to finish the installation.