<?php
/*=====================================================================*\
|| ###################################################################
|| # Bugdar
|| # Copyright (c)2004-2009 Blue Static
|| #
|| # 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; version 2 of the License.
|| #
|| # This program is distributed in the hope that it will be useful, but
|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|| # more details.
|| #
|| # You should have received a copy of the GNU General Public License along
|| # with this program; if not, write to the Free Software Foundation, Inc.,
|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|| ###################################################################
\*=====================================================================*/

require_once ISSO . '/Api.php';

require_once('./includes/functions_datastore.php');

/**
 * API: User help
 *
 * @author		Blue Static
 * @copyright	Copyright (c)2004 - 2009, Blue Static
 * @package		Bugdar
 * 
 */
class UserHelpAPI extends BSApi
{
	/**
	 * Fields
	 * @var	array
	 */
	protected $fields = array(
		'keystring'	=> array(TYPE_STR,		REQ_AUTO),
		'title'		=> array(TYPE_STR,		REQ_YES),
		'body'		=> array(TYPE_STR,		REQ_YES)
	);
	
	/**
	 * Database table
	 * @var	string
	 */
	protected $table = 'fieldhelp';
	
	/**
	 * Table prefix
	 * @var	string
	 */
	protected $prefix = TABLE_PREFIX;
	
	/**
	 * A static function that returns an array of all the keystrings that
	 * are not allowed to be deleted
	 *
	 * @return	array	Array of keystrings
	 */
	public static function not_able_to_delete()
	{
		return array(
			'assignedto',
			'bugid',
			'dateline',
			'dependency',
			'duplicateof',
			'priority',
			'product',
			'reporter',
			'resolution',
			'severity',
			'status',
			'summary',
			'newreply',
			'columnorder'
		);
	}
	
	/**
	 * Post-insert
	 */
	protected function post_insert()
	{
		build_user_help();
	}
	
	/**
	 * Post-update
	 */
	protected function post_update()
	{
		build_user_help();
	}
	
	/**
	 * Pre-delete
	 */
	protected function pre_delete()
	{	
		if (in_array($this->values['keystring'], self::not_able_to_delete()))
		{
			throw new FieldException(T('You cannot delete this user help text because the system needs it.'), 'keystring');
		}
	}
	
	/**
	 * Post-delete
	 */
	protected function post_delete()
	{
		build_user_help();
	}
	
	/**
	 * Validate: title
	 */
	protected function validate_title($field)
	{
		return $this->_verifyIsNotEmpty($field);
	}
	
	/**
	 * Verify: keystring
	 */
	protected function validate_keystring($field)
	{
		if ($this->_verifyIsNotEmpty('keystring'))
		{
			return false;
		}
		
		if (preg_match('#[^a-z0-9_]#', $this->values['keystring']))
		{
			$this->_error(new FieldException(T('The unique key can only contain lowercase letters, underscores, and numbers.'), $field));
			return false;
		}
		
		if (BSApp::$db->queryFirst("SELECT * FROM " . TABLE_PREFIX . "fieldhelp WHERE keystring = '" . BSApp::$input->escape($this->values['keystring']) . "'"))
		{
			$this->_error(new FieldException(T('The unique key must be unique.'), $field));
			return false;
		}
		
		return true;
	}
}

?>