<?php
/**
 * Render a button that will submit the form its contained in through ajax.
 * If you want to add custom behaviour, please set {@link inlcudeDefaultJS()} to FALSE and work with behaviour.js.
 * 
 * @see framework/javascript/InlineFormAction.js
 * 
 * @package forms
 * @subpackage actions
 */
class InlineFormAction extends FormField {
	
	protected $includeDefaultJS = true;

	/**
	 * Create a new action button.
	 * @param action The method to call when the button is clicked
	 * @param title The label on the button
	 * @param extraClass A CSS class to apply to the button in addition to 'action'
	 */
	public function __construct($action, $title = "", $extraClass = '') {
		$this->extraClass = ' '.$extraClass;
		parent::__construct($action, $title, null, null);
	}
	
	public function performReadonlyTransformation() {
		return new InlineFormAction_ReadOnly( $this->name, $this->title );
	}
	
	public function Field($properties = array()) {
		if($this->includeDefaultJS) {
			Requirements::javascriptTemplate(FRAMEWORK_DIR . '/javascript/InlineFormAction.js',
				array('ID'=>$this->id()));
		}
		
		return "<input type=\"submit\" name=\"action_{$this->name}\" value=\"{$this->title}\" id=\"{$this->id()}\""
			. " class=\"action{$this->extraClass}\" />";
	}	
	
	public function Title() {
		return false; 
	}
	
	/**
	 * Optionally disable the default javascript include (framework/javascript/InlineFormAction.js),
	 * which routes to an "admin-custom"-URL.
	 * 
	 * @param $bool boolean
	 */
	public function includeDefaultJS($bool) {
		$this->includeDefaultJS = (bool)$bool;
	}
}

/**
 * Readonly version of {@link InlineFormAction}.
 * @package forms
 * @subpackage actions
 */
class InlineFormAction_ReadOnly extends FormField {
	
	protected $readonly = true;
	
	public function Field($properties = array()) {
		return "<input type=\"submit\" name=\"action_{$this->name}\" value=\"{$this->title}\" id=\"{$this->id()}\""
			. " disabled=\"disabled\" class=\"action disabled$this->extraClass\" />";
	}	
	
	public function Title() {
		return false; 
	}
}
