tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-28 23:49:26 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Documentation for Form class

Browse Source 
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@63760 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2008-10-07 16:47:01 +00:00
parent f009e8de8a
commit 0084e993cc
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
forms/Form.php
View File

@ -24,7 +24,7 @@
class Form extends RequestHandlingData {
/**
* Accessed by Form.ss; modified by 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
*/
public $IncludeFormTag = true;
@ -43,6 +43,9 @@ class Form extends RequestHandlingData {
protected static $current_action;
/**
* @var Dataobject $record Populated by {@link loadDataFrom()} or {@link loadNonBlankDataFrom()}.
*/
protected $record;
/**
@ -456,7 +459,8 @@ class Form extends RequestHandlingData {
/**
* Returns the encoding type of the form.
* This will be either multipart/form-data - if there are field fields - or application/x-www-form-urlencoded
* 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
*/
@ -650,7 +654,9 @@ class Form extends RequestHandlingData {
}
/**
* Returns the DataObject that has given this form its data.
* Returns the DataObject that has given this form its data
* through {@link loadDataFrom()} or {@link loadNonBlankDataFrom()}.
*
* @return DataObject
*/
function getRecord() {