From a6148c33da3e69be3cf316468ddde3b4047d941d Mon Sep 17 00:00:00 2001
From: Ingo Schommer <ingo@silverstripe.com>
Date: Wed, 21 Dec 2011 17:35:42 +0100
Subject: [PATCH] MERGE Using FormField->template in most fields

---
 forms/CheckboxField.php    | 11 ++++-------
 forms/CheckboxSetField.php |  6 +++---
 forms/CreditCardField.php  |  1 +
 forms/CurrencyField.php    |  1 +
 forms/DropdownField.php    |  9 +++------
 forms/EmailField.php       |  6 +-----
 forms/FileField.php        |  4 +++-
 forms/FormAction.php       |  4 +++-
 forms/FormField.php        | 28 +++++++++++++++++++++-------
 forms/HeaderField.php      |  6 ++----
 forms/HiddenField.php      |  4 +---
 forms/ImageFormAction.php  |  5 ++---
 forms/LabelField.php       |  9 ++-------
 forms/OptionsetField.php   |  4 +++-
 forms/PasswordField.php    | 16 +++-------------
 forms/TextField.php        |  4 +++-
 forms/TextareaField.php    |  4 +++-
 17 files changed, 59 insertions(+), 63 deletions(-)

diff --git a/forms/CheckboxField.php b/forms/CheckboxField.php
index f99d6b941..b8e12e036 100644
--- a/forms/CheckboxField.php
+++ b/forms/CheckboxField.php
@@ -6,6 +6,10 @@
  */
 class CheckboxField extends FormField {
 
+	protected $template = 'CheckboxField';
+
+	protected $fieldHolderTemplate = 'CheckboxFieldHolder';
+
 	function setValue($value) {
 		$this->value = ($value) ? 1 : 0;
 	}
@@ -18,13 +22,6 @@ class CheckboxField extends FormField {
 		return ($this->value) ? 1 : 0;
 	}
 
-	function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('CheckboxField');
-	}
-
-	function FieldHolder() {
-		$this->setFieldHolderTemplate(($this->fieldHolderTemplate) ? $this->fieldHolderTemplate : 'CheckboxFieldHolder');
-		return parent::FieldHolder();
 	}
 
 	/**
diff --git a/forms/CheckboxSetField.php b/forms/CheckboxSetField.php
index b982cc746..378534377 100644
--- a/forms/CheckboxSetField.php
+++ b/forms/CheckboxSetField.php
@@ -33,8 +33,8 @@
  * @subpackage fields-basic
  */
 class CheckboxSetField extends OptionsetField {
-	
-	protected $disabled = false;
+
+	protected $template = 'CheckboxSetField';
 	
 	/**
 	 * @var Array
@@ -133,7 +133,7 @@ class CheckboxSetField extends OptionsetField {
 
 		$properties = array_merge($properties, array('Options' => new ArrayList($options)));
 
-		return $this->customise($properties)->renderWith('CheckboxSetField');
+		return $this->customise($properties)->renderWith($this->getTemplate());
 	}
 	
 	function setDisabled($val) {
diff --git a/forms/CreditCardField.php b/forms/CreditCardField.php
index 0b41f400b..b6c7156f9 100644
--- a/forms/CreditCardField.php
+++ b/forms/CreditCardField.php
@@ -16,6 +16,7 @@ class CreditCardField extends TextField {
 				"<input autocomplete=\"off\" name=\"{$this->name}[3]\" value=\"$parts[3]\" maxlength=\"4\"" . $this->getTabIndexHTML(3) . " /></span>";
 		return $field;
 	}
+	
 	function dataValue() {
 		if(is_array($this->value)) return implode("", $this->value);
 		else return $this->value;
diff --git a/forms/CurrencyField.php b/forms/CurrencyField.php
index afd893385..1edfe03ce 100644
--- a/forms/CurrencyField.php
+++ b/forms/CurrencyField.php
@@ -103,6 +103,7 @@ class CurrencyField_Readonly extends ReadonlyField{
 		$valforInput = $this->value ? Convert::raw2att($val) : "";
 		return "<span class=\"readonly ".$this->extraClass()."\" id=\"" . $this->id() . "\">$val</span><input type=\"hidden\" name=\"".$this->name."\" value=\"".$valforInput."\" />";
 	}
+	
 	/**
 	 * This already is a readonly field.
 	 */
diff --git a/forms/DropdownField.php b/forms/DropdownField.php
index 839bca967..fe06042d1 100644
--- a/forms/DropdownField.php
+++ b/forms/DropdownField.php
@@ -77,6 +77,8 @@
  */
 class DropdownField extends FormField {
 	
+	protected $template = 'DropdownField';
+
 	/**
 	 * @var boolean $source Associative or numeric array of all dropdown items,
 	 * with array key as the submitted field value, and the array value as a
@@ -91,11 +93,6 @@ class DropdownField extends FormField {
 	 */
 	protected $isSelected;
 	
-	/**
-	 * @var boolean $disabled
-	 */
-	protected $disabled;
-	
 	/**
 	 * @var boolean $hasEmptyDefault Show the first <option> element as
 	 * empty (not having a value), with an optional label defined through
@@ -162,7 +159,7 @@ class DropdownField extends FormField {
 
 		$properties = array_merge($properties, array('Options' => new ArrayList($options)));
 
-		return $this->customise($properties)->renderWith('DropdownField');
+		return $this->customise($properties)->renderWith($this->getTemplate());
 	}
 
 	/**
diff --git a/forms/EmailField.php b/forms/EmailField.php
index b9705ab92..593511693 100644
--- a/forms/EmailField.php
+++ b/forms/EmailField.php
@@ -5,7 +5,7 @@
  * @subpackage fields-formattedinput
  */
 class EmailField extends TextField {
-	
+
 	function jsValidation() {
 		$formID = $this->form->FormName();
 		$error = _t('EmailField.VALIDATIONJS', 'Please enter an email address.');
@@ -40,10 +40,6 @@ if(typeof fromAnOnBlur != 'undefined'){
 JS;
 	}
 
-	public function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('TextField');
-	}
-
 	/**
 	 * Returns the field type - used by templates.
 	 * @return string
diff --git a/forms/FileField.php b/forms/FileField.php
index 856f2303d..27c61d2d1 100644
--- a/forms/FileField.php
+++ b/forms/FileField.php
@@ -41,6 +41,8 @@
  * @subpackage fields-files
  */
 class FileField extends FormField {
+
+	protected $template = 'FileField';
 	
 	/**
 	 * Restrict filesize for either all filetypes
@@ -112,7 +114,7 @@ class FileField extends FormField {
 
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array('MaxFileSize' => $this->getValidator()->getAllowedMaxFileSize()));
-		return $this->customise($properties)->renderWith('FileField');
+		return $this->customise($properties)->renderWith($this->getTemplate());
 	}
 
 	public function saveInto(DataObject $record) {
diff --git a/forms/FormAction.php b/forms/FormAction.php
index 0cea89ba5..5fed7a351 100644
--- a/forms/FormAction.php
+++ b/forms/FormAction.php
@@ -20,6 +20,8 @@
  */
 class FormAction extends FormField {
 
+	protected $template = 'FormAction';
+
 	protected $extraData;
 
 	protected $action;
@@ -85,7 +87,7 @@ class FormAction extends FormField {
 				'UseButtonTag' => $this->useButtonTag
 			)
 		);
-		return $this->customise($properties)->renderWith('FormAction');
+		return $this->customise($properties)->renderWith($this->getTemplate());
 	}
 
 	public function Type() {
diff --git a/forms/FormField.php b/forms/FormField.php
index aad297311..78999441d 100644
--- a/forms/FormField.php
+++ b/forms/FormField.php
@@ -76,7 +76,7 @@ class FormField extends RequestHandler {
 	/**
 	 * @var String
 	 */
-	protected $template;
+	protected $template = 'FormField';
 	
 	/**
 	 * @var Custom Validation Message for the Field
@@ -87,7 +87,7 @@ class FormField extends RequestHandler {
 	 * Template name to render this FormField field holder into.
 	 * @var string
 	 */
-	protected $fieldHolderTemplate;
+	protected $fieldHolderTemplate = 'FieldHolder';
 
 	/**
 	 * Create a new field.
@@ -334,10 +334,22 @@ class FormField extends RequestHandler {
 		return $this->form; 
 	}
 
+	/**
+	 * @return String
+	 */
 	public function getFieldHolderTemplate() {
 		return $this->fieldHolderTemplate;
 	}
 
+	/**
+	 * Set name of template (without path or extension) for the holder,
+	 * which in turn is responsible for rendering {@link Field()}.
+	 * 
+	 * Caution: Not consistently implemented in all subclasses,
+	 * please check the {@link Field()} method on the subclass for support.
+	 * 
+	 * @param String
+	 */
 	public function setFieldHolderTemplate($template) {
 		$this->fieldHolderTemplate = $template;
 	}
@@ -386,7 +398,9 @@ class FormField extends RequestHandler {
 	}
 
 	/**
-	 * Set name of template (without path or extension)
+	 * Set name of template (without path or extension).
+	 * Caution: Not consistently implemented in all subclasses,
+	 * please check the {@link Field()} method on the subclass for support.
 	 * 
 	 * @param String
 	 */
@@ -412,7 +426,8 @@ class FormField extends RequestHandler {
 	 * @return string
 	 */
 	function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('FormField');
+		$obj = ($properties) ? $this->customise($properties) : $this;
+		return $obj->renderWith($this->getTemplate());
 	}
 
 	/**
@@ -426,9 +441,8 @@ class FormField extends RequestHandler {
 	 * @return string
 	 */
 	function FieldHolder($properties = array()) {
-		return $this->customise($properties)->renderWith(
-			($this->fieldHolderTemplate) ? $this->fieldHolderTemplate : 'FieldHolder'
-		);
+		$obj = ($properties) ? $this->customise($properties) : $this;
+		return $obj->renderWith($this->getFieldHolderTemplate());
 	}
 
    /**
diff --git a/forms/HeaderField.php b/forms/HeaderField.php
index 708d87824..caa44b5e4 100644
--- a/forms/HeaderField.php
+++ b/forms/HeaderField.php
@@ -6,6 +6,8 @@
  * @subpackage fields-dataless
  */
 class HeaderField extends DatalessField {
+
+	protected $template = 'HeaderField';
 	
 	/**
 	 * @var int $headingLevel The level of the <h1> to <h6> HTML tag. Default: 2
@@ -33,9 +35,5 @@ class HeaderField extends DatalessField {
 	public function getHeadingLevel() {
 		return $this->headingLevel;
 	}
-	
-	function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('HeaderField');
-	}
 
 }
\ No newline at end of file
diff --git a/forms/HiddenField.php b/forms/HiddenField.php
index 460967fc3..f1d799157 100644
--- a/forms/HiddenField.php
+++ b/forms/HiddenField.php
@@ -6,9 +6,7 @@
  */
 class HiddenField extends FormField {
 
-	function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('HiddenField');
-	}
+	protected $template = 'HiddenField';
 
 	function FieldHolder() {
 		return $this->Field();
diff --git a/forms/ImageFormAction.php b/forms/ImageFormAction.php
index 3ca2b8303..957d6e8e2 100644
--- a/forms/ImageFormAction.php
+++ b/forms/ImageFormAction.php
@@ -21,6 +21,7 @@ class ImageFormAction extends FormAction {
 		$this->className = $className;
 		parent::__construct($action, $title, $form);
 	}
+
 	function Field() {
 		Requirements::javascript(THIRDPARTY_DIR . '/jquery/jquery.js');
 		Requirements::javascript(SAPPHIRE_DIR . '/javascript/ImageFormAction.js');
@@ -30,6 +31,4 @@ class ImageFormAction extends FormAction {
 		if($this->hoverImage) $classClause .= 'rollover ';
 		return "<input class=\"{$classClause}action\" id=\"" . $this->id() . "\" type=\"image\" name=\"{$this->name}\" src=\"{$this->image}\" title=\"{$this->title}\" alt=\"{$this->title}\" />";
 	}
-}
-
-?>
\ No newline at end of file
+}
\ No newline at end of file
diff --git a/forms/LabelField.php b/forms/LabelField.php
index c160e6f7b..33d8f00a8 100644
--- a/forms/LabelField.php
+++ b/forms/LabelField.php
@@ -8,6 +8,8 @@
  * @subpackage fields-dataless
  */
 class LabelField extends DatalessField {
+
+	protected $template = 'LabelField';
 	
 	/**
 	 * @param string $name
@@ -27,11 +29,4 @@ class LabelField extends DatalessField {
 		parent::__construct($name, $title, $form);
 	}
 
-	/**
-	 * Returns a label containing the title, and an HTML class if given.
-	 */
-	function Field($properties = array()) {
-		return $this->customise($properties)->renderWith('LabelField');
-	}
-
 }
\ No newline at end of file
diff --git a/forms/OptionsetField.php b/forms/OptionsetField.php
index 66f88e548..8d02c12aa 100644
--- a/forms/OptionsetField.php
+++ b/forms/OptionsetField.php
@@ -55,6 +55,8 @@
  * @subpackage fields-basic
  */
 class OptionsetField extends DropdownField {
+
+	protected $template = 'OptionsetField';
 	
 	/**
 	 * @var Array
@@ -86,7 +88,7 @@ class OptionsetField extends DropdownField {
 
 		$properties = array_merge($properties, array('Options' => new ArrayList($options)));
 
-		return $this->customise($properties)->renderWith('OptionsetField');
+		return $this->customise($properties)->renderWith($this->getTemplate());
 	}
 
 	function performReadonlyTransformation() {
diff --git a/forms/PasswordField.php b/forms/PasswordField.php
index f2165a93a..d44633ae7 100644
--- a/forms/PasswordField.php
+++ b/forms/PasswordField.php
@@ -4,7 +4,7 @@
  * @package forms
  * @subpackage fields-formattedinput
  */
-class PasswordField extends FormField {
+class PasswordField extends TextField {
 
 	/**
 	 * maxlength of the password field
@@ -24,20 +24,10 @@ class PasswordField extends FormField {
 	}
 
 
-	function Field() {
-		$disabled = $this->isDisabled()?"disabled=\"disabled\"":""; 
-		$readonly = $this->isReadonly()?"readonly=\"readonly\"":"";
-		if($this->maxLength) {
-			return "<input class=\"text\" type=\"password\" id=\"" . $this->id() .
-				"\" name=\"{$this->name}\" value=\"" . $this->attrValue() .
-				"\" maxlength=\"$this->maxLength\" size=\"$this->maxLength\" $disabled $readonly />"; 
-		} else {
-			return "<input class=\"text\" type=\"password\" id=\"" . $this->id() .
-				"\" name=\"{$this->name}\" value=\"" . $this->attrValue() . "\" $disabled $readonly />"; 
-		}
+	function Type() {
+		return 'password';
 	}
 
-
 	/**
 	 * Makes a pretty readonly field with some stars in it
 	 */
diff --git a/forms/TextField.php b/forms/TextField.php
index 7c372adac..d0f409516 100644
--- a/forms/TextField.php
+++ b/forms/TextField.php
@@ -6,6 +6,8 @@
  */
 class TextField extends FormField {
 
+	protected $template = 'TextField';
+
 	/**
 	 * @var Int
 	 */
@@ -43,7 +45,7 @@ class TextField extends FormField {
 			)
 		);
 
-		return $this->customise($properties)->renderWith('TextField');
+		return parent::Field($properties);
 	}
 
 	function InternallyLabelledField() {
diff --git a/forms/TextareaField.php b/forms/TextareaField.php
index 461951f4d..48b2ffe1e 100644
--- a/forms/TextareaField.php
+++ b/forms/TextareaField.php
@@ -22,6 +22,8 @@
  */
 class TextareaField extends FormField {
 
+	protected $template = 'TextareaField';
+
 	protected $rows, $cols;
 
 	/**
@@ -57,7 +59,7 @@ class TextareaField extends FormField {
 			)
 		);
 
-		return $this->customise($properties)->renderWith('TextareaField');
+		return parent::Field($properties);
 	}
 
 	/**