API CHANGE Don't allow specifying $form as constructor argument in va…

…rious form fields, use setForm() instead (to achieve a cleaner API with less confusing parameter order)
silverstripe · Jan 2, 2012 · cc32957 · cc32957
1 parent 3c5c04c
commit cc32957
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 16 deletions.
diff --git a/docs/en/changelogs/3.0.0.md b/docs/en/changelogs/3.0.0.md
@@ -84,6 +84,14 @@ as well as the HTML form element itself.
 		<input type="checkbox" class="checkbox extraClass".../>
 	</div>
 
+### FormField constructor argument changes ###
+
+In order to enforce a consistent parameter order in core [api:FormField] subclasses,
+its no longer possible to set the following optional attributes via constructor arguments:
+`$form`, `$maxLength`, `$rightTitle`, `$rows`/`$cols` (for `TextareaField` and `HtmlEditorField`)
+and `$folderName` (for `FileField` and `SimpleImageField`).
+Please use the appropriate setters on the form field instance instead.
+
 ### Restructured files and folders ###
 
 In order to make the `sapphire` framework useable without the `cms` module,

diff --git a/forms/CountryDropdownField.php b/forms/CountryDropdownField.php
@@ -12,7 +12,7 @@ class CountryDropdownField extends DropdownField {
 
 	protected $defaultToVisitorCountry = true;
 
-	function __construct($name, $title = null, $source = null, $value = "", $form=null) {
+	function __construct($name, $title = null, $source = null, $value = "") {
 		if(!is_array($source)) $source = Geoip::getCountryDropDown();
 		if(!$value) $value = Geoip::visitor_country();
 

diff --git a/forms/DateField.php b/forms/DateField.php
@@ -87,7 +87,7 @@ class DateField extends TextField {
 	 */
 	protected $valueObj = null;
 
-	function __construct($name, $title = null, $value = null, $form = null, $rightTitle = null) {
+	function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
 		}

diff --git a/forms/FormField.php b/forms/FormField.php
@@ -100,10 +100,8 @@ class FormField extends RequestHandler {
 	 * @param name The internal field name, passed to forms.
 	 * @param title The field label.
 	 * @param value The value of the field.
-	 * @param form Reference to the container form
-	 * @param maxLength The Maximum length of the attribute
 	 */
-	function __construct($name, $title = null, $value = null, $form = null, $rightTitle = null) {
+	function __construct($name, $title = null, $value = null) {
 		$this->name = $name;
 		$this->title = ($title === null) ? $name : $title;
 

diff --git a/forms/HeaderField.php b/forms/HeaderField.php
@@ -14,7 +14,7 @@ class HeaderField extends DatalessField {
 	 */
 	protected $headingLevel = 2;
 
-	function __construct($name, $title = null, $headingLevel = 2, $form = null) {
+	function __construct($name, $title = null, $headingLevel = 2) {
 		// legacy handling for old parameters: $title, $heading, ...
 		// instead of new handling: $name, $title, $heading, ...
 		$args = func_get_args();
@@ -29,7 +29,7 @@ function __construct($name, $title = null, $headingLevel = 2, $form = null) {
 
 		if($headingLevel) $this->headingLevel = $headingLevel;
 
-		parent::__construct($name, $title, null, $form);
+		parent::__construct($name, $title);
 	}
 
 	public function getHeadingLevel() {

diff --git a/forms/LabelField.php b/forms/LabelField.php
@@ -16,7 +16,7 @@ class LabelField extends DatalessField {
 	 * @param string $title
 	 * @param Form $form
 	 */
-	function __construct($name, $title, $form = null) {
+	function __construct($name, $title) {
 		// legacy handling for old parameters: $title, $heading, ...
 		// instead of new handling: $name, $title, $heading, ...
 		$args = func_get_args();
@@ -26,7 +26,7 @@ function __construct($name, $title, $form = null) {
 			$form = (isset($args[3])) ? $args[3] : null;
 		} 
 
-		parent::__construct($name, $title, $form);
+		parent::__construct($name, $title);
 	}
 
 }
diff --git a/forms/ListboxField.php b/forms/ListboxField.php
@@ -51,10 +51,10 @@ class ListboxField extends DropdownField {
 	 * @param int $size Optional size of the select element
 	 * @param form The parent form
 	 */
-	function __construct($name, $title = '', $source = array(), $value = '', $size = null, $multiple = false, $form = null) {
+	function __construct($name, $title = '', $source = array(), $value = '', $size = null, $multiple = false) {
 		if($size) $this->size = $size;
 		if($multiple) $this->multiple = $multiple;
-		parent::__construct($name, $title, $source, $value, $form);
+		parent::__construct($name, $title, $source, $value);
 	}
 
 	/**

diff --git a/forms/MoneyField.php b/forms/MoneyField.php
@@ -32,12 +32,12 @@ class MoneyField extends FormField {
 	 */
 	protected $fieldCurrency = null;
 
-	function __construct($name, $title = null, $value = "", $form = null) {
+	function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
 		$this->fieldCurrency = $this->FieldCurrency($name);
 
-		parent::__construct($name, $title, $value, $form);
+		parent::__construct($name, $title, $value);
 	}
 
 	/**

diff --git a/forms/PhoneNumberField.php b/forms/PhoneNumberField.php
@@ -17,14 +17,13 @@ class PhoneNumberField extends FormField {
 	protected $countryCode;
 	protected $ext;
 
-	public function __construct( $name, $title = null, $value = '', $extension = null, 
-		$areaCode = null, $countryCode = null, $form = null ) {
+	public function __construct( $name, $title = null, $value = '', $extension = null, $areaCode = null, $countryCode = null) {
 
 		$this->areaCode = $areaCode;
 		$this->ext = $extension;
 		$this->countryCode = $countryCode;
 
-		parent::__construct( $name, $title, $value, $form );
+		parent::__construct($name, $title, $value);
 	}
 
 	public function Field() {