• $options - hash reference having various options. Curently the boolean option suppressValsEval is the only one supported

StaticMethod getListOfForms ($session,$web) -> @topics

Return a list of TWiki Form Templates found in a web. The name of Form Template topics ends in Form, and topics must contain a table heading like this:

A form definition consists of a TWiki::Form object, which has a list of field definitions. Each field definition is an object of a type derived from TWiki::Form::FieldDefinition. These objects are responsible for the actual syntax and semantics of the field type. Form definitions are parsed from TWiki tables, and the types are mapped by name to a class declared in TWiki::Form::* - for example, the text type is mapped to TWiki::Form::Text and the checkbox type to TWiki::Form::Checkbox.

The TWiki::Form::FieldDefinition class declares default behaviours for types that accept a single value in their definitions. The TWiki::Form::ListFieldDefinition extends this for types that have lists of possible values.

ObjectMethod finish ()

StaticMethod fieldTitle2FieldName ($title) -> $name

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

• $meta the meta data for the form

ObjectMethod getField ($name) -> $fieldDefinition

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

• $def - optional. a reference to a list of field definitions. if present, these definitions will be used, rather than those in $form.

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

ObjectMethod renderHidden ($meta) -> $html

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

ObjectMethod getFields () -> \@fields

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

• $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 ''.

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

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

• $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)

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)

StaticMethod renderForDisplay ($templates,$meta)

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

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