[interchange-docs] xmldocs - docelic modified 5 files

docs at icdevgroup.org docs at icdevgroup.org
Thu Nov 16 08:36:23 EST 2006


User:      docelic
Date:      2006-11-16 13:36:22 GMT
Added:     refs     always_fail.ordercheck always_pass.ordercheck
Added:              email_only.ordercheck exists.ordercheck
Added:              filter.ordercheck
Log:
Document a few orderchecks

Revision  Changes    Path
1.1                  xmldocs/refs/always_fail.ordercheck


rev 1.1, prev_rev 1.0
Index: always_fail.ordercheck
===================================================================
__NAME__ purpose
always fail
__END__

__NAME__ see also
always_pass
__END__


__NAME__ description
Verification of the form field value always fails.
__END__

__NAME__ notes
__END__

__NAME__ example: __FILENAME__
<programlisting>
FORM_FIELD_NAME=__FILENAME__
</programlisting>
__END__




1.1                  xmldocs/refs/always_pass.ordercheck


rev 1.1, prev_rev 1.0
Index: always_pass.ordercheck
===================================================================
__NAME__ purpose
always pass
__END__

__NAME__ see also
always_fail
__END__


__NAME__ description
Verification of the form field value always succeeds.
__END__

__NAME__ notes
__END__

__NAME__ example: __FILENAME__
<programlisting>
FORM_FIELD_NAME=__FILENAME__
</programlisting>
__END__




1.1                  xmldocs/refs/email_only.ordercheck


rev 1.1, prev_rev 1.0
Index: email_only.ordercheck
===================================================================
__NAME__ purpose
e-mail address is syntactically correct
__END__

__NAME__ see also
__END__


__NAME__ description
Verification of the form field value succeeds if it
contains a syntactically valid e-mail address.
__END__

__NAME__ notes
__END__

__NAME__ example: __FILENAME__
<programlisting>
FORM_FIELD_NAME=__FILENAME__
</programlisting>
__END__




1.1                  xmldocs/refs/exists.ordercheck


rev 1.1, prev_rev 1.0
Index: exists.ordercheck
===================================================================
__NAME__ purpose
record exists in a database table
__END__

__NAME__ see also
__END__


__NAME__ description
Verification of the form field value succeeds if
it contains code that exists in the specified &glos-database; table.
</para><para>
Foreign lookups are possible; see <xref linkend="exists_examples" />.
__END__

__NAME__ notes
__END__

__NAME__ example: Check for value in database table "products"
<programlisting>
FORM_FIELD_NAME=__FILENAME__ products
</programlisting>
__END__

__NAME__ example: Check for value in database table "products", with custom error message
<programlisting>
FORM_FIELD_NAME=__FILENAME__ products Product not found in database
</programlisting>
__END__

__NAME__ example: Check for value in database table "products", in foreign column "price"
<programlisting>
FORM_FIELD_NAME=__FILENAME__ products:price
</programlisting>
__END__




1.1                  xmldocs/refs/filter.ordercheck


rev 1.1, prev_rev 1.0
Index: filter.ordercheck
===================================================================
__NAME__ purpose
value passes through specified filter unmodified
__END__

__NAME__ see also
__END__


__NAME__ description
Verification of the form field value succeeds if it
passes the specified filter unaltered.
__END__

__NAME__ notes
For a list of all possible filters, see <olink targetdoc='filters'/>.
Filters that unconditionally modify input data are generally not suitable
for use with this &glos-order-check;; the data is always changed so it
always fails the validation.
__END__

__NAME__ example: __FILENAME__
<programlisting>
FORM_FIELD_NAME=__FILENAME__ alpha "The value contains non-alpha characters"
</programlisting>
__END__

__NAME__ example: __FILENAME__
<programlisting>
FORM_FIELD_NAME=__FILENAME__ name "Name entered is not in format 'First Last'"
</programlisting>
__END__









More information about the docs mailing list