You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

493 lines
23 KiB

<?php // $Id: mod_form.php,v 1.28 2012/07/26 05:38:58 bdaloukas Exp $
/**
* Form for creating and modifying a game
*
* @package game
* @author Alastair Munro <alastair@catalyst.net.nz>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once ($CFG->dirroot.'/course/moodleform_mod.php');
require( 'locallib.php');
class mod_game_mod_form extends moodleform_mod {
function definition() {
global $CFG, $DB, $COURSE;
$mform =& $this->_form;
$id = $this->_instance;
if(!empty($this->_instance)){
if($g = $DB->get_record('game', array('id' => $id))){
$gamekind = $g->gamekind;
}
else{
print_error('incorrect game');
}
}
else {
$gamekind = required_param('type', PARAM_ALPHA);
}
//Hidden elements
$mform->addElement('hidden', 'gamekind', $gamekind);
$mform->setDefault('gamekind', $gamekind);
$mform->setType('gamekind', PARAM_ALPHA);
$mform->addElement('hidden', 'type', $gamekind);
$mform->setDefault('type', $gamekind);
$mform->setType('type', PARAM_ALPHA);
$mform->addElement( 'hidden', 'gameversion', game_get_version());
$mform->setType('gameversion', PARAM_INT);
$mform->addElement('header', 'general', get_string('general', 'form'));
$mform->addElement('text', 'name', 'Name', array('size'=>'64'));
if (!empty($CFG->formatstringstriptags)){
$mform->setType('name', PARAM_TEXT);
}
else{
$mform->setType('name', PARAM_CLEAN);
}
if( !isset( $g))
$mform->setDefault('name', get_string( 'game_'.$gamekind, 'game'));
$mform->addRule('name', null, 'required', null, 'client');
$hasglossary = ($gamekind == 'hangman' || $gamekind == 'cross' || $gamekind == 'cryptex' || $gamekind == 'sudoku' || $gamekind == 'hiddenpicture' || $gamekind == 'snakes');
$questionsourceoptions = array();
if($hasglossary)
$questionsourceoptions['glossary'] = get_string('modulename', 'glossary');
//if( $gamekind != 'snakes' && $gamekind != 'sudoku' &&
// $gamekind != 'hiddenpicture') {
$questionsourceoptions['question'] = get_string('sourcemodule_question', 'game');
//}
if( $gamekind != 'bookquiz')
$questionsourceoptions['quiz'] = get_string('modulename', 'quiz');
$mform->addElement('select', 'sourcemodule', get_string('sourcemodule','game'), $questionsourceoptions);
if($hasglossary){
$a = array();
if($recs = $DB->get_records('glossary', array( 'course' => $COURSE->id), 'id,name')){
foreach($recs as $rec){
$a[$rec->id] = $rec->name;
}
}
$mform->addElement('select', 'glossaryid', get_string('sourcemodule_glossary', 'game'), $a);
$mform->disabledIf('glossaryid', 'sourcemodule', 'neq', 'glossary');
if( count( $a) == 0)
$select = 'glossaryid=-1';
else if( count( $a) == 1)
$select = 'glossaryid='.$rec->id;
else
{
$select = '';
foreach($recs as $rec){
$select .= ','.$rec->id;
}
$select = 'g.id IN ('.substr( $select, 1).')';
}
$select .= ' AND g.id=gc.glossaryid';
$table = "{glossary} g, {glossary_categories} gc";
$a = array();
$a[ ] = '';
$sql = "SELECT gc.id,gc.name,g.name as name2 FROM $table WHERE $select ORDER BY g.name,gc.name";
if($recs = $DB->get_records_sql( $sql)){
foreach($recs as $rec){
$a[$rec->id] = $rec->name2.' -> '.$rec->name;
}
}
$mform->addElement('select', 'glossarycategoryid', get_string('sourcemodule_glossarycategory', 'game'), $a);
$mform->disabledIf('glossarycategoryid', 'sourcemodule', 'neq', 'glossary');
}
//*********************
// Question Category - Short Answer
if( $gamekind != 'bookquiz'){
$context = get_context_instance(50, $COURSE->id);
$select = " contextid in ($context->id)";
$a = array();
if($recs = $DB->get_records_select('question_categories', $select, null, 'id,name')){
foreach($recs as $rec){
$s = $rec->name;
if(($count = $DB->count_records('question', array( 'category' => $rec->id))) != 0){
$s .= " ($count)";
}
$a[$rec->id] = $s;
}
}
$mform->addElement('select', 'questioncategoryid', get_string('sourcemodule_questioncategory', 'game'), $a);
$mform->disabledIf('questioncategoryid', 'sourcemodule', 'neq', 'question');
//subcategories
$mform->addElement('selectyesno', 'subcategories', get_string('sourcemodule_include_subcategories', 'game'));
$mform->disabledIf('subcategories', 'sourcemodule', 'neq', 'question');
}
//***********************
// Quiz Category
if( $gamekind != 'bookquiz'){
$a = array();
if( $recs = $DB->get_records('quiz', array( 'course' => $COURSE->id), 'id,name')){
foreach( $recs as $rec){
$a[$rec->id] = $rec->name;
}
}
$mform->addElement('select', 'quizid', get_string('sourcemodule_quiz', 'game'), $a);
$mform->disabledIf('quizid', 'sourcemodule', 'neq', 'quiz');
}
//***********************
// Book
if($gamekind == 'bookquiz'){
$a = array();
if($recs = $DB->get_records('book', array( 'course' => $COURSE->id), 'id,name')){
foreach($recs as $rec){
$a[$rec->id] = $rec->name;
}
}
$mform->addElement('select', 'bookid', get_string('sourcemodule_book', 'game'), $a);
}
//Common settings to all games
$mform->addElement('text', 'maxattempts', get_string('cross_max_attempts','game'));
$mform->setType('maxattempts', PARAM_INT);
//---------------------------------------------------------------------------
// Grade options
$mform->addElement('header', 'gradeoptions', get_string('grades', 'grades'));
$mform->addElement('text', 'grade', get_string( 'grademax', 'grades'), array('size' => 4));
$mform->setType('grade', PARAM_INT);
$gradingtypeoptions = array();
$gradingtypeoptions[ GAME_GRADEHIGHEST] = get_string('gradehighest','game');
$gradingtypeoptions[ GAME_GRADEAVERAGE] = get_string('gradeaverage','game');
$gradingtypeoptions[ GAME_ATTEMPTFIRST] = get_string('attemptfirst','game');
$gradingtypeoptions[ GAME_ATTEMPTLAST] = get_string('attemptlast','game');
$mform->addElement('select', 'grademethod', get_string('grademethod','game'), $gradingtypeoptions);
// Open and close dates.
$mform->addElement('date_time_selector', 'timeopen', get_string('gameopen', 'game'),
array('optional' => true, 'step' => 1));
$mform->addHelpButton('timeopen', 'quizopenclose', 'quiz');
$mform->addElement('date_time_selector', 'timeclose', get_string('gameclose', 'game'),
array('optional' => true, 'step' => 1));
//---------------------------------------------------------------------------
// Bookquiz options
if($gamekind == 'bookquiz'){
$mform->addElement('header', 'bookquiz', get_string( 'bookquiz_options', 'game'));
$bookquizlayoutoptions = array();
$bookquizlayoutoptions[0] = get_string('bookquiz_layout0', 'game');
$bookquizlayoutoptions[1] = get_string('bookquiz_layout1', 'game');
$mform->addElement('select','param3', get_string('bookquiz_layout', 'game'), $bookquizlayoutoptions);
}
//---------------------------------------------------------------------------
// Hangman options
if($gamekind == 'hangman'){
$mform->addElement('header', 'hangman', get_string( 'hangman_options', 'game'));
$mform->addElement('text', 'param4', get_string('hangman_maxtries', 'game'), array('size' => 4));
$mform->setType('param4', PARAM_INT);
$mform->addElement('selectyesno', 'param1', get_string('hangman_showfirst', 'game'));
$mform->addElement('selectyesno', 'param2', get_string('hangman_showlast', 'game'));
$mform->addElement('selectyesno', 'param7', get_string('hangman_allowspaces','game'));
$mform->addElement('selectyesno', 'param8', get_string('hangman_allowsub', 'game'));
$mform->addElement('text', 'param10', get_string( 'hangman_maximum_number_of_errors', 'game'), array('size' => 4));
$mform->setType('param10', PARAM_INT);
$a = array( 1 => 1);
$mform->addElement('select', 'param3', get_string('hangman_imageset','game'), $a);
$mform->addElement('selectyesno', 'param5', get_string('hangman_showquestion', 'game'));
$mform->setDefault('param5', 1);
$mform->addElement('selectyesno', 'param6', get_string('hangman_showcorrectanswer', 'game'));
$a = array();
$a = get_string_manager()->get_list_of_translations();
$a[ ''] = '----------';
ksort( $a);
$mform->addElement('select', 'language', get_string('hangman_language','game'), $a);
}
//---------------------------------------------------------------------------
// Crossword options
if($gamekind == 'cross'){
$mform->addElement('header', 'cross', get_string( 'cross_options', 'game'));
$mform->addElement('text', 'param1', get_string('cross_maxcols', 'game'));
$mform->setType('param1', PARAM_INT);
$mform->addElement('text', 'param4', get_string('cross_minwords', 'game'));
$mform->setType('param4', PARAM_INT);
$mform->addElement('text', 'param2', get_string('cross_maxwords', 'game'));
$mform->setType('param2', PARAM_INT);
$mform->addElement('selectyesno', 'param7', get_string('hangman_allowspaces','game'));
$crosslayoutoptions = array();
$crosslayoutoptions[0] = get_string('cross_layout0', 'game');
$crosslayoutoptions[1] = get_string('cross_layout1', 'game');
$mform->addElement('select','param3', get_string('cross_layout', 'game'), $crosslayoutoptions);
}
//---------------------------------------------------------------------------
// Cryptex options
if($gamekind == 'cryptex'){
$mform->addElement('header', 'cryptex', get_string( 'cryptex_options', 'game'));
$mform->addElement('text', 'param1', get_string('cross_maxcols', 'game'));
$mform->setType('param1', PARAM_INT);
$mform->addElement('text', 'param4', get_string('cross_minwords', 'game'));
$mform->setType('param4', PARAM_INT);
$mform->addElement('text', 'param2', get_string('cross_maxwords', 'game'));
$mform->setType('param2', PARAM_INT);
$mform->addElement('selectyesno', 'param7', get_string('hangman_allowspaces','game'));
$mform->addElement('text', 'param8', get_string('cryptex_maxtries','game'));
$mform->setType('param8', PARAM_INT);
}
//---------------------------------------------------------------------------
// Millionaire options
if($gamekind == 'millionaire'){
global $OUTPUT, $PAGE;
$mform->addElement('header', 'millionaire', get_string( 'millionaire_options', 'game'));
$mform->addElement('text', 'param8', get_string('millionaire_background', 'game'));
$mform->setDefault('param8', '#408080');
$mform->setType('param8', PARAM_TEXT);
//$mform->addElement('colorpicker', 'param8', get_string('millionaire_background', 'game'));
//$mform->registerRule('color','regex','/^#([a-fA-F0-9]{6})$/');
//$mform->addRule('config_bgcolor','Enter a valid RGB color - # and then 6 characters','color');
$mform->addElement('selectyesno', 'shuffle', get_string('millionaire_shuffle','game'));
}
//---------------------------------------------------------------------------
// Sudoku options
if($gamekind == 'sudoku'){
$mform->addElement('header', 'sudoku', get_string( 'sudoku_options', 'game'));
$mform->addElement('text', 'param2', get_string('sudoku_maxquestions', 'game'));
$mform->setType('param2', PARAM_INT);
}
//---------------------------------------------------------------------------
// Snakes and Ladders options
if($gamekind == 'snakes'){
$mform->addElement('header', 'snakes', get_string( 'snakes_options', 'game'));
$snakesandladdersbackground = array();
if($recs = $DB->get_records( 'game_snakes_database', null, 'id,name')){
foreach( $recs as $rec){
$snakesandladdersbackground[$rec->id] = $rec->name;
}
}
$snakeslayoutoptions = array();
$snakeslayoutoptions[0] = get_string('snakes_layout0', 'game');
$snakeslayoutoptions[1] = get_string('snakes_layout1', 'game');
$mform->addElement('select','param8', get_string('bookquiz_layout', 'game'), $snakeslayoutoptions);
if(count($snakesandladdersbackground) == 0){
require("{$CFG->dirroot}/mod/game/db/importsnakes.php");
if($recs = $DB->get_records('game_snakes_database', null, 'id,name')){
foreach($recs as $rec){
$snakesandladdersbackground[$rec->id] = $rec->name;
}
}
}
$snakesandladdersbackground[ 0] = get_string( 'userdefined', 'game');
ksort( $snakesandladdersbackground);
$mform->addElement('select', 'param3', get_string('snakes_background', 'game'), $snakesandladdersbackground);
//param3 = background
//param4 = itemid for file_storage
//param5 (=1 means dirty file and and have to be computed again)
//param6 = width of autogenerated picture
//param7 = height of autogenerated picture
//param8 = layout
$attachmentoptions = array('subdirs'=>false, 'maxfiles'=>1);
$mform->addElement('filepicker', 'param4', get_string('snakes_file', 'game'), $attachmentoptions);
$mform->disabledIf('param4', 'param3', 'neq', '0');
$mform->addElement('textarea', 'snakes_data', get_string('snakes_data', 'game'), 'rows="2" cols="70"');
$mform->disabledIf('snakes_data', 'param3', 'neq', '0');
$mform->addElement('text', 'snakes_cols', get_string('snakes_cols', 'game'), array('size' => 4));
$mform->disabledIf('snakes_cols', 'param3', 'neq', '0');
$mform->setType('snakes_cols', PARAM_INT);
$mform->addElement('text', 'snakes_rows', get_string('snakes_rows', 'game'), array('size' => 4));
$mform->disabledIf('snakes_rows', 'param3', 'neq', '0');
$mform->setType('snakes_rows', PARAM_INT);
$mform->addElement('text', 'snakes_headerx', get_string('snakes_headerx', 'game'), array('size' => 4));
$mform->disabledIf('snakes_headerx', 'param3', 'neq', '0');
$mform->setType('snakes_headerx', PARAM_INT);
$mform->addElement('text', 'snakes_headery', get_string('snakes_headery', 'game'), array('size' => 4));
$mform->disabledIf('snakes_headery', 'param3', 'neq', '0');
$mform->setType('snakes_headery', PARAM_INT);
$mform->addElement('text', 'snakes_footerx', get_string('snakes_footerx', 'game'), array('size' => 4));
$mform->disabledIf('snakes_footerx', 'param3', 'neq', '0');
$mform->setType('snakes_footerx', PARAM_INT);
$mform->addElement('text', 'snakes_footery', get_string('snakes_footery', 'game'), array('size' => 4));
$mform->disabledIf('snakes_footery', 'param3', 'neq', '0');
$mform->setType('snakes_footery', PARAM_INT);
$mform->addElement('text', 'snakes_width', get_string('hiddenpicture_width', 'game'), array('size' => 6));
$mform->setType('snakes_width', PARAM_INT);
$mform->addELement('text', 'snakes_height', get_string('hiddenpicture_height', 'game'), array('size' => 6));
$mform->setType('snakes_height', PARAM_INT);
}
//---------------------------------------------------------------------------
// Hidden Picture options
if($gamekind == 'hiddenpicture'){
$mform->addElement('header', 'hiddenpicture', get_string( 'hiddenpicture_options', 'game'));
$mform->addElement('text', 'param1', get_string('hiddenpicture_across', 'game'));
$mform->setType('param1', PARAM_INT);
$mform->setDefault('param1', 3);
$mform->addElement('text', 'param2', get_string('hiddenpicture_down', 'game'));
$mform->setType('param2', PARAM_INT);
$mform->setDefault('param2', 3);
$a = array();
if($recs = $DB->get_records('glossary', array( 'course' => $COURSE->id), 'id,name')){
foreach($recs as $rec){
$cmg = get_coursemodule_from_instance('glossary', $rec->id, $COURSE->id);
$context = get_context_instance(CONTEXT_MODULE, $cmg->id);
if( $DB->record_exists( 'files', array( 'contextid' => $context->id))){
$a[$rec->id] = $rec->name;
}
}
}
$mform->addElement('select', 'glossaryid2', get_string('hiddenpicture_pictureglossary', 'game'), $a);
$mform->addElement('text', 'param4', get_string('hiddenpicture_width', 'game'));
$mform->setType('param4', PARAM_INT);
$mform->addELement('text', 'param5', get_string('hiddenpicture_height', 'game'));
$mform->setType('param5', PARAM_INT);
$mform->addElement('selectyesno', 'param7', get_string('hangman_allowspaces','game'));
}
//---------------------------------------------------------------------------
// Header/Footer options
$mform->addElement('header', 'headerfooteroptions', 'Header/Footer Options');
$mform->addElement('htmleditor', 'toptext', get_string('toptext','game'));
$mform->addElement('htmleditor', 'bottomtext', get_string('bottomtext','game'));
//---------------------------------------------------------------------------
$features = new stdClass;
$this->standard_coursemodule_elements($features);
//---------------------------------------------------------------------------
// buttons
$this->add_action_buttons();
}
function validation($data, $files){
$errors = parent::validation($data, $files);
// Check open and close times are consistent.
if ($data['timeopen'] != 0 && $data['timeclose'] != 0 &&
$data['timeclose'] < $data['timeopen']) {
$errors['timeclose'] = get_string('closebeforeopen', 'quiz');
}
return $errors;
}
function set_data($default_values) {
global $DB;
if( isset( $default_values->type))
{
//Default values for every game.
if( $default_values->type == 'hangman')
{
$default_values->param10 = 6; //maximum number of wrongs
}else if( $default_values->type == 'snakes')
{
$default_values->gamekind = $default_values->type;
$default_values->param3 = 1;
$default_values->questioncategoryid = 0;
}else if( $default_values->type == 'millionaire')
{
$default_values->shuffle = 1;
}
}
if( isset( $default_values->gamekind)){
if( $default_values->gamekind == 'hangman'){
if( $default_values->param10 == 0)
$default_values->param10 = 6;
}else if( $default_values->gamekind == 'millionaire'){
if( isset( $default_values->param8))
$default_values->param8 = '#'.substr( '000000'.strtoupper( dechex( $default_values->param8)),-6);
}
//repair questioncategoryid
$categoryid = $default_values->questioncategoryid;
$contextid = $DB->get_field( 'question_categories', 'contextid', array( 'id' => $categoryid));
$default_values->questioncategoryid = $categoryid.','.$contextid;
if( $default_values->gamekind == 'snakes'){
if( isset( $default_values->param9)){
$a = explode( '#',$default_values->param9);
foreach( $a as $s){
$pos = strpos( $s, ':');
if( $pos){
$name = substr( $s, 0, $pos);
$default_values->$name = substr( $s, $pos+1);
}
}
}
}
}
if( !isset( $default_values->gamekind))
$default_values->gamekind = $default_values->type;
if( $default_values->gamekind == 'snakes'){
if( isset( $default_values->param3)){
$board = $default_values->param3;
if( $board != 0){
$rec = $DB->get_record( 'game_snakes_database', array( 'id' => $board));
$default_values->snakes_data = $rec->data;
$default_values->snakes_cols = $rec->cols;
$default_values->snakes_rows = $rec->rows;
$default_values->snakes_headerx = $rec->headerx;
$default_values->snakes_headery = $rec->headery;
$default_values->snakes_footerx = $rec->footerx;
$default_values->snakes_footery = $rec->footery;
}
}
}
parent::set_data($default_values);
}
}