tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

ENHANCEMENT: Made the form enctype configurable via a method Form->setEncType().

Browse Source 
API CHANGE: Deprecated Form->FormEncType() in favour of Form->getEncType().
MINOR: Added enctypes as constants to the Form class.
This commit is contained in:
ajshort 2011-12-26 18:36:24 +11:00
parent 6aa90e6288
commit 3478e4f9e6
2 changed files with 61 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
forms/Form.php
View File

@ -44,6 +44,9 @@
*/ */
class Form extends RequestHandler { class Form extends RequestHandler {
const ENC_TYPE_URLENCODED = 'application/x-www-form-urlencoded';
const ENC_TYPE_MULTIPART = 'multipart/form-data';
/** /**
* @var boolean $includeFormTag Accessed by Form.ss; modified by {@link formHtmlContent()}. * @var boolean $includeFormTag Accessed by Form.ss; modified by {@link formHtmlContent()}.
* A performance enhancement over the generate-the-form-tag-and-then-remove-it code that was there previously * A performance enhancement over the generate-the-form-tag-and-then-remove-it code that was there previously
@ -137,6 +140,11 @@ class Form extends RequestHandler {
*/ */
protected $extraClasses = array(); protected $extraClasses = array();
/**
* @var string
*/
protected $encType;
/** /**
* Create a new form, with the given fields an action buttons. * Create a new form, with the given fields an action buttons.
* *
@ -600,7 +608,7 @@ class Form extends RequestHandler {
$attributes['id'] = $this->FormName(); $attributes['id'] = $this->FormName();
$attributes['action'] = $this->FormAction(); $attributes['action'] = $this->FormAction();
$attributes['method'] = $this->FormMethod(); $attributes['method'] = $this->FormMethod();
$attributes['enctype'] = $this->FormEncType(); $attributes['enctype'] = $this->getEncType();
if($this->target) $attributes['target'] = $this->target; if($this->target) $attributes['target'] = $this->target;
if($this->extraClass()) $attributes['class'] = $this->extraClass(); if($this->extraClass()) $attributes['class'] = $this->extraClass();
if($this->validator && $this->validator->getErrors()) { if($this->validator && $this->validator->getErrors()) {
@ -658,19 +666,42 @@ class Form extends RequestHandler {
} }
/** /**
* Returns the encoding type of the form. * Returns the encoding type for the form.
* This will be either "multipart/form-data"" if there are any {@link FileField} instances,
* otherwise "application/x-www-form-urlencoded"
* *
* @return string The encoding mime type * By default this will be URL encoded, unless there is a file field present
* in which case multipart is used. You can also set the enc type using
* {@link setEncType}.
*/ */
function FormEncType() { public function getEncType() {
if(is_array($this->fields->dataFields())){ if ($this->encType) {
foreach($this->fields->dataFields() as $field) { return $this->encType;
if(is_a($field, "FileField")) return "multipart/form-data"; }
if ($fields = $this->fields->dataFields()) {
foreach ($fields as $field) {
if ($field instanceof FileField) return self::ENC_TYPE_MULTIPART;
} }
} }
return "application/x-www-form-urlencoded";
return self::ENC_TYPE_URLENCODED;
}
/**
* Sets the form encoding type. The most common encoding types are defined
* in {@link ENC_TYPE_URLENCODED} and {@link ENC_TYPE_MULTIPART}.
*
* @param string $enctype
*/
public function setEncType($encType) {
$this->encType = $encType;
}
/**
* @deprecated 3.0 Please use {@link getEncType}.
*/
public function FormEncType() {
Deprecation::notice('3.0', 'Please use Form->getEncType() instead.');
return $this->getEncType();
} }
/** /**

15
tests/forms/FormTest.php
View File

@ -325,6 +325,21 @@ class FormTest extends FunctionalTest {
SecurityToken::disable(); // restore original SecurityToken::disable(); // restore original
} }
public function testEncType() {
$form = $this->getStubForm();
$this->assertEquals('application/x-www-form-urlencoded', $form->getEncType());
$form->setEncType(Form::ENC_TYPE_MULTIPART);
$this->assertEquals('multipart/form-data', $form->getEncType());
$form = $this->getStubForm();
$form->Fields()->push(new FileField(null));
$this->assertEquals('multipart/form-data', $form->getEncType());
$form->setEncType(Form::ENC_TYPE_URLENCODED);
$this->assertEquals('application/x-www-form-urlencoded', $form->getEncType());
}
protected function getStubForm() { protected function getStubForm() {
return new Form( return new Form(
new Controller(), new Controller(),