page_online_quiz_management.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset_management.inc';

class Page_Online_Quiz_Management extends Asset_Management
{


    function __construct(&$pm)
    {
        $this->Asset_Management($pm);

        $this->vars = Array(
                        // overrides for default options
                        // set up "types" to have questions already selected on create
                        'types'                 => Array(
                                                    'added'     => '0.1',
                                                    'type'      => 'serialise',
                                                    'default'   => Array(
                                                                    'online_quiz_question'  => 1,
                                                                   ),
                                                   ),
                        // remove 'a-z' and 'random' from the group-by dropdown
                        'group_by'              => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'selection',
                                                    'default'       => 'number',
                                                    'parameters'    => Array(
                                                                        'multiple'      => FALSE,
                                                                        'allow_empty'   => FALSE,
                                                                        'options'       => Array(
                                                                                            'number'    => 'Standard',
                                                                                            'grouped'   => 'Custom Grouping',
                                                                                           ),
                                                                       ),
                                                   ),
                        'num_questions'         => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'int',
                                                    'default'       => 0,
                                                    'description'   => 'The number of questions to draw from the question pool (all, if zero)',
                                                   ),
                        'user_details_source'   => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'selection',
                                                    'default'       => 'current_user',
                                                    'description'   => 'Where to source the user details from: either the currently logged in user, or a form',
                                                    'parameters'    => Array(
                                                                        'options'       => Array(
                                                                                            'current_user'  => 'Current User',
                                                                                            'form'          => 'Form',
                                                                                           ),
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'can_retake'            => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'boolean',
                                                    'default'       => TRUE,
                                                    'description'   => 'Whether or not the user can take the quiz again',
                                                    'parameters'    => Array(
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'after_submit_action'   => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'selection',
                                                    'default'       => 'thank_you',
                                                    'description'   => 'What to do after a quiz has been finished (eg. display a "thank you" page)',
                                                    'parameters'    => Array(
                                                                        'options'       => Array(
                                                                                            'thank_you'         => 'Show "Thank You" page',
                                                                                            'return_to_quiz'    => 'Return to quiz immediately',
                                                                                           ),
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'results_email_format'  => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'email_format',
                                                    'default'       => Array(),
                                                    'description'   => 'The format of the email that will be sent out at the completion of the quiz',
                                                   ),
                        'clientside_validation' => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'boolean',
                                                    'default'       => TRUE,
                                                    'description'   => 'Whether or not to warn with user with a JS popup when submitting if some answers are empty or invalid',
                                                    'parameters'    => Array(
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'log_submissions'       => Array(
                                                    'added'         => '0.3',
                                                    'type'          => 'boolean',
                                                    'default'       => FALSE,
                                                    'description'   => 'When enabled, User Details and submitted Quiz results will be logged. These will then be available to export from the &quot;Submission Logs&quot; screen',
                                                    'parameters'    => Array(
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'score_format'          => Array(
                                                    'added'          => '0.1',
                                                    'type'           => 'text',
                                                    'default'        => '',
                                                    'is_contextable' => TRUE,
                                                    'description'    => 'Used for %quiz_score% keyword and submission logs.',
                                                    ),                                                 
                        'interactive_mode'      => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'boolean',
                                                    'default'       => FALSE,
                                                    'description'   => 'If enabled, bypasses the listing engine, displaying one question per page, providing feedback and allowing retries.',
                                                    'parameters'    => Array(
                                                                        'allow_empty'   => FALSE,
                                                                       ),
                                                   ),
                        'question_pool_setup'   => Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'serialise',
                                                    'default'       => Array(),
                                                   ),
                        'question_option_format'=> Array(
                                                    'added'         => '0.1',
                                                    'type'          => 'text',
                                                    'default'       => '',
                                                    'is_contextable'=> TRUE,
                                                    'description'   => 'Online Quiz Question Multichoice radio/checkbox option print format.'
                                                    ),                                                                             
                        'retry_button_text'     => Array(
                                                    'added'          => '0.1',
                                                    'type'           => 'text',
                                                    'default'        => 'Retry',
                                                    'is_contextable' => TRUE,
                                                    ),
                        'next_button_text'      => Array(
                                                    'added'          => '0.1',
                                                    'type'           => 'text',
                                                    'default'        => 'Next',
                                                    'is_contextable' => TRUE,
                                                    ),
                        'submit_question_button_text'   => Array(
                                                            'added'         => '0.1',
                                                            'type'          => 'text',
                                                            'default'       => 'Submit Answer',
                                                            'is_contextable' => TRUE,
                                                           ),                                                  
                      );

    }//end constructor


    function getEventList()
    {
        return Array(
                Array(
                    'event_name'                    => 'requestKeywords',
                    'broadcast_type_code'           => 'content_type',
                    'broadcast_strict_type_code'    => FALSE,
                    'options'                       => Array(
                                                        'side_of_link'  => 'major',
                                                        'indirect'      => TRUE,
                                                        'is_exclusive'  => NULL,
                                                        'is_dependant'  => 1,
                                                        'value'         => '',
                                                        'link_type'     => SQ_LINK_TYPE_2 | SQ_LINK_TYPE_1,
                                                       ),
                ),
               );

    }//end getEventList()


    function _upgrade($current_version)
    {
        $res = parent::_upgrade($current_version);

        if (version_compare($current_version, '0.3', '<')) {
            pre_echo('UPGRADING ONLINE QUIZ TO v0.3');
            $quizids = $GLOBALS['SQ_SYSTEM']->am->getTypeAssetids('page_online_quiz', FALSE);
            foreach ($quizids as $quizid) {
                $quiz = $GLOBALS['SQ_SYSTEM']->am->getAsset($quizid);
                if (!$quiz->_createSubmissionsFolder()) {
                    trigger_error('Error creating submissions folder for Online Quiz #'.$quizid, E_USER_WARNING);
                }
                $GLOBALS['SQ_SYSTEM']->am->forgetAsset($quiz);
            }
            pre_echo(count($quizids).' ONLINE QUIZ ASSETS UPDATED');
        }

        return $res;

    }//end _upgrade()


}//end class

?>