online_quiz_question.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';
require_once SQ_LIB_PATH.'/html_form/html_form.inc';


define('SQ_ONLINE_QUIZ_QUESTION_SESSION_VAR', 'SQ_ONLINE_QUIZ');


class Online_Quiz_Question extends Asset
{


    var $_value = NULL;


    var $_position = NULL;


    function Online_Quiz_Question($assetid=0)
    {
        $this->Asset($assetid);

        // on question load, load up the question values for the current user
        $this->loadQuestion();

    }//end constructor


    function _getName($short_name=FALSE)
    {
        return $this->attr('name');

    }//end _getName()


    function _getAllowedLinks()
    {
        $page_links = parent::_getAllowedLinks();
        $page_links[SQ_LINK_TYPE_2]['bodycopy'] = Array('card' => 1, 'exclusive' => FALSE);
        $page_links[SQ_LINK_TYPE_3]['bodycopy'] = Array('card' => 1, 'exclusive' => FALSE);
        return $page_links;

    }//end _getAllowedLinks()


    function loadQuestion()
    {
        $question = Array(
                        'type_code' => $this->type(),
                        'value'     => NULL,
                        'position'  => NULL,
                    );

        // load everything from the session
        if (!empty($_SESSION[SQ_ONLINE_QUIZ_QUESTION_SESSION_VAR]['question'][$this->id])) {
            $question = $_SESSION[SQ_ONLINE_QUIZ_QUESTION_SESSION_VAR]['question'][$this->id];
        }

        // use the question data to set instance vars
        $this->_value = array_get_index($question, 'value', NULL);
        $this->_position = array_get_index($question, 'position', NULL);

        return TRUE;

    }//end loadQuestion()


    function saveQuestion()
    {
        $question = $this->getQuestionData();

        // save everything from the session
        $_SESSION[SQ_ONLINE_QUIZ_QUESTION_SESSION_VAR]['question'][$this->id] = $question;

        return TRUE;

    }//end saveQuestion()


    function getValue()
    {
        return $this->_value;

    }//end getValue()


    function setValue($value)
    {
        $this->_value = $value;

    }//end setValue()


    function getSummary()
    {
        return $this->getValue();

    }//end getSummary()


    function getCorrectValue()
    {
        return $this->getValue();

    }//end getCorrectValue()


    function getCorrectSummary()
    {
        return $this->getSummary();

    }//end getCorrectSummary()


    function getPosition()
    {
        return $this->_position;

    }//end getPosition()


    function setPosition($position)
    {
        $this->_position = $position;

    }//end setPosition()


    function getQuestionText()
    {
        ob_start();
            $printed = $this->printQuestionTextBodycopy();
        $question_text = ob_get_clean();

        if ($printed) {
            return $question_text;
        } else {
            return $this->attr('question_text');
        }

    }//end getQuestionText()


    function getQuestionNote()
    {
        $question_note = $this->attr('question_note');

        // replace internal links to pages and images with their full URLs
        $matches = Array();
        preg_match_all('|\./\?a=([0-9]+)|', $question_note, $matches);
        $urls = $GLOBALS['SQ_SYSTEM']->am->getAssetURL(array_unique($matches[1]));
        foreach ($urls as $assetid => $url) {
            $question_note = preg_replace('|\./\?a='.$assetid.'([^0-9])|', $url.'\\1', $question_note);
        }

        return $question_note;

    }//end getQuestionNote()


    function getQuestionData()
    {
        return Array(
                'type_code' => $this->type(),
                'value'     => $this->getValue(),
                'position'  => $this->getPosition(),
               );

    }//end getQuestionData()


    function processResponseForm()
    {
        // children should look at $_REQUEST, validate the result, and set $this->_value
        $value = array_get_index($_REQUEST, $this->getPrefix().'_test', NULL);

        $valid = $this->validateValue($value);
        $errors = array_get_index($valid, 'errors', Array());
        if (empty($errors)) {
            $this->_value = $value;
            $this->saveQuestion();
        }

        // return the error stack
        return $valid;

    }//end processResponseForm()


    function validateValue($value=NULL)
    {
        if (is_null($value)) $value = $this->_value;

        $errors = Array(
                    'errors'    => Array(),
                    'warnings'  => Array(),
                  );

        if (empty($value)) {
            $errors['warnings'][] = translate('online_quiz_question_warning_empty_question', $this->getPosition());
        }

        return $errors;

    }//end validateValue()


    function getValidationJS()
    {
        return '';

    }//end getValidationJS()


    function getPoints($value=NULL)
    {
        if (is_null($value)) $value = $this->getValue();

        return 0;

    }//end getPoints()


    function getAvailablePoints()
    {
        return 0;

    }//end getAvailablePoints()


    function getResults()
    {
        $value           = $question->getValue();
        $summary         = $question->getSummary();
        $correct_value   = $question->getCorrectValue();
        $correct_summary = $question->getCorrectSummary();
        $position        = $question->getPosition();
        $points          = $question->getPoints();
        $available       = $question->getAvailablePoints();

        $results   = Array(
                        'assetid'           => $id,
                        'value'             => $value,
                        'summary'           => $summary,
                        'correct_value'     => $correct_value,
                        'correct_summary'   => $correct_summary,
                        'points'            => $points,
                        'available_points'  => $available,
                     );

        return $results;

    }//end getResults()


//--        Bodycopy Manipulation        --//


    function createQuestionTextBodycopy($enable_on_create=TRUE)
    {
        $bodycopy_link = $this->getQuestionTextBodycopyLink(SQ_LINK_TYPE_2 | SQ_LINK_TYPE_3);

        // we already have a bodycopy link: bail out
        if ($bodycopy_link) {
            return FALSE;
        } else {
            $GLOBALS['SQ_SYSTEM']->am->includeAsset('bodycopy');

            $link_type =  ($enable_on_create ? SQ_LINK_TYPE_2 : SQ_LINK_TYPE_3);

            $asset = new Bodycopy();
            $copy_link =  Array(
                            'asset'         => &$this,
                            'value'         => 'question_text',
                            'link_type'     => $link_type,
                            'is_dependant'  => 1,
                            'is_exclusive'  => 1,
                          );

            $asset->setAttrValue('name', translate('online_quiz_question_bodycopy_question_text'));
            $args = Array(
                        'content'   => $this->attr('question_text'),
                    );
            if (!$asset->create($copy_link, $args)) return FALSE;

            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
            unset($asset);
        }

        return TRUE;

    }//end createQuestionTextBodycopy()


    function &getQuestionTextBodycopy($only_if_enabled=TRUE)
    {
        $asset = NULL;

        if ($only_if_enabled) {
            $link_types = SQ_LINK_TYPE_2;
        } else {
            $link_types = SQ_LINK_TYPE_2 | SQ_LINK_TYPE_3;
        }

        $bodycopy_link = $this->getQuestionTextBodycopyLink($link_types);
        if ($bodycopy_link) {
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($bodycopy_link['minorid'], 'bodycopy');
        }

        return $asset;

    }//end getQuestionTextBodycopy()


    function getQuestionTextBodycopyLink($link_type)
    {
        $tmp_bodycopy = $GLOBALS['SQ_SYSTEM']->am->getLinks($this->id, $link_type, 'bodycopy', FALSE, 'major', 'question_text');
        return reset($tmp_bodycopy);

    }//end getQuestionTextBodycopyLink()


    function setQuestionTextBodycopy($enabled)
    {
        $bodycopy_link = $this->getQuestionTextBodycopyLink(SQ_LINK_TYPE_2 | SQ_LINK_TYPE_3);

        if (!$bodycopy_link) {
            // no bodycopy yet? If we're trying to set to disabled, then we don't
            // need to do anything - if not then we need to create it
            if ($enabled) {
                if (!$this->createQuestionTextBodycopy()) return FALSE;
            }
        } else {
            // set link type to either TYPE_2 if enabled or TYPE_3 if disabled
            $new_link_type = ($enabled) ? SQ_LINK_TYPE_2 : SQ_LINK_TYPE_3;
            if ($bodycopy_link['link_type'] != $new_link_type) {
                $GLOBALS['SQ_SYSTEM']->am->updateLink($bodycopy_link['linkid'], $new_link_type);
            }
        }

        return TRUE;

    }//end setQuestionTextBodycopy()


    function printQuestionTextBodycopy()
    {
        $bodycopy_printed =  FALSE;
        $bodycopy         = $this->getQuestionTextBodycopy();

        if (!is_null($bodycopy)) {
            $bodycopy->printBody();
            $bodycopy_printed = TRUE;
        }

        return $bodycopy_printed;

    }//end printQuestionTextBodycopy()


//--        Keyword Replacements        --//


    function getAvailableKeywords()
    {
        $keywords = parent::getAvailableKeywords();

        $keywords['question_text']      = translate('online_quiz_question_keyword_question_text');
        $keywords['response_form']      = translate('online_quiz_question_keyword_response_form');
        $keywords['available_points']   = translate('online_quiz_question_keyword_available_points');
        $keywords['question_number']    = translate('online_quiz_question_keyword_question_number');
        $keywords['question_note']      = translate('online_quiz_question_keyword_question_note');

        return $keywords;

    }//end getAvailableKeywords()


    function getQuestionTextKeywordReplacement()
    {
        return $this->getQuestionText();

    }//end getQuestionTextKeywordReplacement()


    function getResponseFormKeywordReplacement()
    {
        // print form element(s), eg. a text box, or list of checkboxes
        // $this->getPrefix should be used for any form elements

        $prefix = $this->getPrefix();

        // example element
        // <input id="PREFIX_test" name="PREFIX_test" type="text" value="online_quiz_question::getValue()">

        return '';

    }//end getResponseFormKeywordReplacement()


    function getAvailablePointsKeywordReplacement()
    {
        return $this->getAvailablePoints();

    }//end getAvailablePointsKeywordReplacement()


    function getQuestionNumberKeywordReplacement()
    {
        return $this->getPosition();

    }//end getQuestionNumberKeywordReplacement()


    function getQuestionNoteKeywordReplacement()
    {
        return $this->getQuestionNote();

    }//end getQuestionNoteKeywordReplacement()


}//end class
?>