silverstripe-framework/forms/FormAction.php
Sean Harvey b8ef87d24a MINOR phpDoc comment error fix
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@64411 467b73ca-7a2a-4603-9d3b-597d59a354a9
2008-10-16 11:50:55 +00:00

112 lines
2.8 KiB
PHP
Executable File

<?php
/**
* Single action button.
* The action buttons are <input type="submit"> tags.
* @package forms
* @subpackage actions
*/
class FormAction extends FormField {
protected $extraData;
protected $action;
/**
* Enables the use of <button> instead of <input>
* in {@link Field()} - for more customizeable styling.
*
* @var boolean $useButtonTag
*/
public $useButtonTag = false;
/**
* Create a new action button.
* @param action The method to call when the button is clicked
* @param title The label on the button
* @param form The parent form, auto-set when the field is placed inside a form
* @param extraData A piece of extra data that can be extracted with $this->extraData. Useful for
* calling $form->buttonClicked()->extraData()
* @param extraClass A CSS class to apply to the button in addition to 'action'
*/
function __construct($action, $title = "", $form = null, $extraData = null, $extraClass = '') {
$this->extraData = $extraData;
$this->extraClass = ' '.$extraClass;
$this->action = "action_$action";
parent::__construct($this->action, $title, null, $form);
}
static function create($action, $title = "", $extraData = null, $extraClass = null) {
return new FormAction($action, $title, null, $extraData, $extraClass);
}
function actionName() {
return substr($this->name,7);
}
/**
* Set the full action name, including action_
* This provides an opportunity to replace it with something else
*/
function setFullAction($fullAction) {
$this->action = $fullAction;
}
function extraData() {
return $this->extraData;
}
/**
* Create a submit input, or button tag
* using {@link FormField->createTag()} functionality.
*
* @return HTML code for the input OR button element
*/
function Field() {
if($this->useButtonTag) {
$attributes = array(
'class' => 'action' . ($this->extraClass() ? (' ' . $this->extraClass()) : ''),
'id' => $this->id(),
'type' => 'submit',
'name' => $this->action
);
return $this->createTag('button', $attributes, $this->attrTitle());
} else {
$attributes = array(
'class' => 'action' . ($this->extraClass() ? (' ' . $this->extraClass()) : ''),
'id' => $this->id(),
'type' => 'submit',
'name' => $this->action,
'value' => $this->attrTitle()
);
if($this->description) $attributes['title'] = Convert::raw2att($this->description);
return $this->createTag('input', $attributes);
}
}
/**
* Does not transform to readonly by purpose.
* Globally disabled buttons would break the CMS.
*/
function performReadonlyTransformation() {
$this->setDisabled(true);
return $this;
}
function readonlyField() {
return $this;
}
}
/**
* @package forms
* @subpackage actions
*/
class FormAction_WithoutLabel extends FormAction {
function Title(){
return null;
}
}
?>