Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r4  >  r3  >  r2  >  r1
TWikiFormDotPm 4 - 16 Jan 2007 - Main.TWikiContributor
Line: 5 to 5
 
Changed:
<
<

ClassMethod new ($session,$web,$form)

>
>

ClassMethod new ($session,$web,$form,$def)

 
  • $web - default web to recover form from, if $form doesn't specify a web
  • $form - topic name to read form definition from
Added:
>
>
  • $def - optional. a reference to a list of field definitions. if present, these definitions will be used, rather than those in $form.
 May throw TWiki::OopsException
Line: 35 to 39
 types

SMELL: this should be a method on a field class

Deleted:
<
<		SMELL: JSCalendarContrib ought to provide a 'date' handler.
 
Line: 58 to 65
 For each field, if there is a value in the query, use it. Otherwise if there is already entry for the field in the meta, keep it.
Changed:
<
<		Returns the number of fields which had values provided by the query, and a references to an array of the names of mandatory fields that were missing from the query.
>
>		Returns the number of fields which had values provided by the query, and a references to an array of the names of mandatory fields that were missing from the query.
 

TWikiFormDotPm 3 - 25 Jun 2006 - Main.TWikiContributor
Line: 14 to 14
 
Changed:
<
<

ObjectMethod renderForEdit ($web,$topic,$meta,$useDefaults) -> $html

>
>

ObjectMethod renderForEdit ($web,$topic,$meta) -> $html

 
  • $web the web of the topic being rendered
  • $topic the topic being rendered
  • $meta the meta data for the form
Deleted:
<
<
  • $useDefaults if true, will use default values from the form definition if no other value is given
 Render the form fields for entry during an edit session, using data values from $meta
Line: 40 to 39
 
Changed:
<
<

ObjectMethod renderHidden ($meta,$useDefaults) -> $html

  • $useDefaults if true, will use default values from the form definition if no other value is given
>
>

ObjectMethod renderHidden ($meta) -> $html

 Render form fields found in the meta as hidden inputs, so they pass through edits untouched.
Line: 53 to 50
 
Changed:
<
<

ObjectMethod getFieldValuesFromQuery ($query,$metaObject,$initialiseMissing) -> ($seen,\@missing)

>
>

ObjectMethod getFieldValuesFromQuery ($query,$metaObject) -> ($seen,\@missing)

 Extract new values for form fields from a query.
  • $query - the query
  • $metaObject - the meta object that is storing the form values
Deleted:
<
<
  • $initialiseMissing - if true, will cause fields that are in the form but have no value in the query or in the meta to be initialised to ''.
 For each field, if there is a value in the query, use it. Otherwise if there is already entry for the field in the meta, keep it.
Line: 80 to 76
 
Added:
>
>

ObjectMethod getFields () -> \@fields

Return a list containing references to field name/value pairs. Each entry in the list has a {name} field and a {value} field. It may have other fields as well, which caller should ignore. The returned list should be treated as read only (must not be written to).

 

StaticMethod renderForDisplay ($templates,$meta)

  • $templates ref to templates singleton
  • $meta - meta object containing the form to be rendered

TWikiFormDotPm 2 - 01 Apr 2006 - Main.TWikiContributor
Line: 53 to 53
 
Changed:
<
<

ObjectMethod getFieldValuesFromQuery ($query,$metaObject,$handleMandatory) -> $metaObject

>
>

ObjectMethod getFieldValuesFromQuery ($query,$metaObject,$initialiseMissing) -> ($seen,\@missing)

 Extract new values for form fields from a query.
  • $query - the query
  • $metaObject - the meta object that is storing the form values
Changed:
<
<
  • $handleMandatory - if set, will throw an OopsException? if any mandatory fields are absent from the query.
>
>
  • $initialiseMissing - if true, will cause fields that are in the form but have no value in the query or in the meta to be initialised to ''.
 For each field, if there is a value in the query, use it. Otherwise if there is already entry for the field in the meta, keep it.
Changed:
<
<		Otherwise, if $handleMandatory, initialise the field to '' and set it in the meta.
>
>		Returns the number of fields which had values provided by the query, and a references to an array of the names of mandatory fields that were missing from the query.
 

TWikiFormDotPm 1 - 01 Feb 2006 - Main.TWikiContributor
Line: 1 to 1
Added:
>
>

Package TWiki::Form

Object representing a single form definition.

ClassMethod new ($session,$web,$form)

  • $web - default web to recover form from, if $form doesn't specify a web
  • $form - topic name to read form definition from

May throw TWiki::OopsException

ObjectMethod renderForEdit ($web,$topic,$meta,$useDefaults) -> $html

  • $web the web of the topic being rendered
  • $topic the topic being rendered
  • $meta the meta data for the form
  • $useDefaults if true, will use default values from the form definition if no other value is given

Render the form fields for entry during an edit session, using data values from $meta

ObjectMethod renderFieldForEdit ($fieldDef,$web,$topic,$value) -> $html

  • $fieldDef the field being rendered
  • $web the web of the topic being rendered
  • $topic the topic being rendered
  • $value the current value of the field

Render a single form field for entry during an edit session, using data values from $meta. Plugins can provide a handler that extends the set of supported types

SMELL: this should be a method on a field class SMELL: JSCalendarContrib ought to provide a 'date' handler.

ObjectMethod renderHidden ($meta,$useDefaults) -> $html

  • $useDefaults if true, will use default values from the form definition if no other value is given

Render form fields found in the meta as hidden inputs, so they pass through edits untouched.

ObjectMethod cgiName ($field) -> $string

Generate the 'name' of the CGI parameter used to represent a field.

ObjectMethod getFieldValuesFromQuery ($query,$metaObject,$handleMandatory) -> $metaObject

Extract new values for form fields from a query.
  • $query - the query
  • $metaObject - the meta object that is storing the form values
  • $handleMandatory - if set, will throw an OopsException? if any mandatory fields are absent from the query.

For each field, if there is a value in the query, use it. Otherwise if there is already entry for the field in the meta, keep it. Otherwise, if $handleMandatory, initialise the field to '' and set it in the meta.

ObjectMethod isTextMergeable ($name) -> $boolean

  • $name - name of a form field (value of the name attribute)
Returns true if the type of the named field allows it to be text-merged.

If the form does not define the field, it is assumed to be mergeable.

ObjectMethod getField ($name) -> \%row

  • $name - name of a form field (value of the name attribute)
Returns the field, or undef if the form does not define the field.

StaticMethod renderForDisplay ($templates,$meta)

  • $templates ref to templates singleton
  • $meta - meta object containing the form to be rendered
Static because we want to be able to do this without a form definition.

SMELL: Why? Is reading the form topic such a big burden?


Revision 4r4 - 16 Jan 2007 - 04:11:58 - TWikiContributor
Revision 3r3 - 25 Jun 2006 - 16:26:33 - TWikiContributor
Revision 2r2 - 01 Apr 2006 - 05:55:39 - TWikiContributor
Revision 1r1 - 01 Feb 2006 - 12:01:25 - TWikiContributor
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM