<?php
/************************************************************************/
/* AChecker                                                             */
/************************************************************************/
/* Copyright (c) 2008 by Greg Gay, Cindy Li                             */
/* Adaptive Technology Resource Centre / University of Toronto          */
/*                                                                      */
/* This program is free software. You can redistribute it and/or        */
/* modify it under the terms of the GNU General Public License          */
/* as published by the Free Software Foundation.                        */
/************************************************************************/

/**
* DAO for "check_examples" table
* @access	public
* @author	Cindy Qi Li
* @package	DAO
*/

if (!defined('AC_INCLUDE_PATH')) exit;

require_once(AC_INCLUDE_PATH. 'classes/DAO/DAO.class.php');

class CheckExamplesDAO extends DAO {

	/**
	* return rows with given check id and type
	* @access  public
	* @param   $checkID
	*          $type
	* @return  table rows
	* @author  Cindy Qi Li
	*/
	public function Create($checkID, $type, $description, $content)
	{
		global $addslashes;

		$description = trim($description);
		$content = trim($content);
		
		// don't insert if no desc and content
		if ($description == '' && $content == '') return true;
		
		if (!$this->isFieldsValid($checkID, $type)) return false;
		
		$sql = "INSERT INTO ".TABLE_PREFIX."check_examples
				(`check_id`, `type`, `description`, `content`) 
				VALUES
				(".$checkID.",".$type.",'".$addslashes($description)."', ".
		         "'".$addslashes($content)."')";

		if (!$this->execute($sql))
		{
			$msg->addError('DB_NOT_UPDATED');
			return false;
		}
		else
		{
			return mysql_insert_id();
		}
	}
	
	/**
	* return rows with given check id and type
	* @access  public
	* @param   $checkID
	*          $type
	* @return  table rows
	* @author  Cindy Qi Li
	*/
	public function getByCheckIDAndType($checkID, $type)
	{
		$sql = "SELECT * FROM ".TABLE_PREFIX."check_examples
				WHERE check_id = ".$checkID."
				  AND type = ".$type;

		return $this->execute($sql);
	}
	
	/**
	* Delete all entries with given check id
	* @access  public
	* @param   $checkID
	* @return  true : if successful
	*          false : if not successful
	* @author  Cindy Qi Li
	*/
	public function DeleteByCheckID($checkID)
	{
		$sql = "DELETE FROM ".TABLE_PREFIX."check_examples
				WHERE check_id = ".$checkID;

		return $this->execute($sql);
	}
	
	/**
	 * Validate fields preparing for insert and update
	 * @access  private
	 * @param   $checkID  
	 *          $type
	 * @return  true    if all fields are valid
	 *          false   if any field is not valid
	 * @author  Cindy Qi Li
	 */
	private function isFieldsValid($checkID, $type)
	{
		global $msg;
		
		$missing_fields = array();

		if ($checkID == '')
		{
			$missing_fields[] = _AC('check_id');
		}
		if ($type <> AC_CHECK_EXAMPLE_FAIL && $type <> AC_CHECK_EXAMPLE_PASS)
		{
			$missing_fields[] = _AC('example_type');
		}
		
		if ($missing_fields)
		{
			$missing_fields = implode(', ', $missing_fields);
			$msg->addError(array('EMPTY_FIELDS', $missing_fields));
		}
		
		if (!$msg->containsErrors())
			return true;
		else
			return false;
	}
}
?>