questlab/questtypes/textinput/TextinputQuesttypeController.inc

<?php
	
	/**
	 * The Legend of Z
	 *
	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
	 * @copyright	2014 Heinrich-Heine-Universität Düsseldorf
	 * @license	http://www.gnu.org/licenses/gpl.html
	 * @link	https://bitbucket.org/coderkun/the-legend-of-z
	 */
	
	namespace hhu\z\questtypes;
	
	
	/**
	 * Controller of the TextinputQuesttypeAgent for for inserting text.
	 * 
	 * @author	Oliver Hanraths <oliver.hanraths@uni-duesseldorf.de>
	 */
	class TextinputQuesttypeController extends \hhu\z\QuesttypeController
	{
		
		
		
		
		/**
		 * Save the answers of a Character for a Quest.
		 * 
		 * @param	array	$seminary	Current Seminary data
		 * @param	array	$questgroup	Current Questgroup data
		 * @param	array	$quest		Current Quest data
		 * @param	array	$character	Current Character data
		 * @param	array	$answers	Character answers for the Quest
		 */
		public function saveAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers)
		{
			// Get regexs
			$regexs = $this->Textinput->getTextinputRegexs($quest['id']);
			
			// Save answers
			foreach($regexs as &$regex)
			{
				$pos = intval($regex['number']) - 1;
				$answer = (array_key_exists($pos, $answers)) ? $answers[$pos] : '';
				$this->Textinput->setCharacterSubmission($regex['id'], $character['id'], $answer);
			}
		}
		
		
		/**
		 * Check if answers of a Character for a Quest match the correct ones.
		 * 
		 * @param	array	$seminary	Current Seminary data
		 * @param	array	$questgroup	Current Questgroup data
		 * @param	array	$quest		Current Quest data
		 * @param	array	$character	Current Character data
		 * @return	boolean			True/false for a right/wrong answer or null for moderator evaluation
		 */
		public function matchAnswersOfCharacter($seminary, $questgroup, $quest, $character, $answers)
		{
			// Get right answers
			$regexs = $this->Textinput->getTextinputRegexs($quest['id']);
			
			// Match regexs with user answers
			$allSolved = true;
			foreach($regexs as $i => &$regex)
			{
				if(!array_key_exists($i, $answers))
				{
					$allSolved = false;
					break;
				}
				
				if(!$this->isMatching($regex['regex'], $answers[$i]))
				{
					$allSolved = false;
					break;
				}
			}
			
			
			// Set status
			return $allSolved;
		}
		
		
		/**
		 * Action: quest.
		 * 
		 * Display a text with input fields and evaluate if user input
		 * matches with stored regular expressions.
		 * 
		 * @param	array	$seminary	Current Seminary data
		 * @param	array	$questgroup	Current Questgroup data
		 * @param	array	$quest		Current Quest data
		 * @param	array	$character	Current Character data
		 */
		public function quest($seminary, $questgroup, $quest, $character)
		{
			// Get Task
			$task = $this->Textinput->getTextinputQuest($quest['id']);
			
			// Process text
			$textParts = preg_split('/(\$\$)/', $task['text'], -1, PREG_SPLIT_NO_EMPTY);
			
			// Get Character answers
			$regexs = null;
			if($this->request->getGetParam('show-answer') == 'true')
			{
				$regexs = $this->Textinput->getTextinputRegexs($quest['id']);
				foreach($regexs as &$regex) {
					$regex['answer'] = $this->Textinput->getCharacterSubmission($regex['id'], $character['id']);
				}
			}
			
			// Has Character already solved Quest?
			$solved = $this->Quests->hasCharacterSolvedQuest($quest['id'], $character['id']);
			
			
			// Pass data to view
			$this->set('texts', $textParts);
			$this->set('regexs', $regexs);
		}
		
		
		/**
		 * Action: submission.
		 * 
		 * Show the submission of a Character for a Quest.
		 * 
		 * @param	array	$seminary	Current Seminary data
		 * @param	array	$questgroup	Current Questgroup data
		 * @param	array	$quest		Current Quest data
		 * @param	array	$character	Current Character data
		 */
		public function submission($seminary, $questgroup, $quest, $character)
		{
			// Get Task
			$task = $this->Textinput->getTextinputQuest($quest['id']);
			
			// Process text
			$textParts = preg_split('/(\$\$)/', $task['text'], -1, PREG_SPLIT_NO_EMPTY);
			
			// Get Character answers
			$regexs = $this->Textinput->getTextinputRegexs($quest['id']);
			foreach($regexs as &$regex) {
				$regex['answer'] = $this->Textinput->getCharacterSubmission($regex['id'], $character['id']);
				$regex['right'] = $this->isMatching($regex['regex'], $regex['answer']);
			}
			
			
			// Pass data to view
			$this->set('texts', $textParts);
			$this->set('regexs', $regexs);
		}
		
		
		
		
		private function isMatching($regex, $answer)
		{
			$score = preg_match($regex, $answer);
			
			
			return ($score !== false && $score > 0);
		}
		
	}

?>