changed POD formatting
This commit is contained in:
JT Smith
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -77,14 +77,10 @@ sub _checkEmailAddy {
|
|||
|
||||
Returns an array or a carriage return ("\n") separated scalar depending upon whether you're returning the values into an array or a scalar.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub checkbox {
|
||||
|
|
@ -98,14 +94,10 @@ sub checkbox {
|
|||
|
||||
Returns an array or a carriage return ("\n") separated scalar depending upon whether you're returning the values into an array or a scalar.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub checkList {
|
||||
|
|
@ -119,14 +111,10 @@ sub checkList {
|
|||
|
||||
Returns either an array of values or a scalar value depending upon what you request.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub combo {
|
||||
|
|
@ -143,14 +131,10 @@ sub combo {
|
|||
|
||||
Returns a content type. Defaults to "mixed".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub contentType {
|
||||
|
|
@ -163,14 +147,10 @@ sub contentType {
|
|||
|
||||
Returns an epoch datestamp.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub date {
|
||||
|
|
@ -184,14 +164,10 @@ sub date {
|
|||
|
||||
Returns an epoch datestamp.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub dateTime {
|
||||
|
|
@ -204,14 +180,10 @@ sub dateTime {
|
|||
|
||||
Returns an email address.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub email {
|
||||
|
|
@ -228,14 +200,10 @@ sub email {
|
|||
|
||||
Returns a field type. Defaults to "text".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub fieldType {
|
||||
|
|
@ -249,14 +217,10 @@ sub fieldType {
|
|||
|
||||
Returns a scalar filter type. Defaults to "most".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub filter {
|
||||
|
|
@ -270,14 +234,10 @@ sub filter {
|
|||
|
||||
Returns a floating point (decimal) number. Defaults to "0.0".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub float {
|
||||
|
|
@ -294,14 +254,10 @@ sub float {
|
|||
|
||||
Returns a group Id. Defaults to 2 (registered users).
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub group {
|
||||
|
|
@ -318,14 +274,10 @@ sub group {
|
|||
|
||||
Returns a string.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub hidden {
|
||||
|
|
@ -339,14 +291,10 @@ sub hidden {
|
|||
|
||||
Returns an array or a carriage return ("\n") separated scalar depending upon whether you're returning the values into an array or a scalar.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub hiddenList {
|
||||
|
|
@ -360,14 +308,10 @@ sub hiddenList {
|
|||
|
||||
Returns a string of HTML that has been cleaned of header information.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub HTMLArea {
|
||||
|
|
@ -381,14 +325,10 @@ sub HTMLArea {
|
|||
|
||||
Returns an integer. Defaults to "0".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub integer {
|
||||
|
|
@ -405,14 +345,10 @@ sub integer {
|
|||
|
||||
Returns an interval in seconds. Defaults to "0".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub interval {
|
||||
|
|
@ -426,14 +362,10 @@ sub interval {
|
|||
|
||||
Returns a string.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub password {
|
||||
|
|
@ -447,14 +379,10 @@ sub password {
|
|||
|
||||
Returns a string filtered to allow only digits, spaces, and these special characters: + - ( )
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub phone {
|
||||
|
|
@ -471,22 +399,18 @@ sub phone {
|
|||
|
||||
Returns whatever would be the expected result of the method type that was specified. This method also checks to make sure that the field is not returning a string filled with nothing but whitespace.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=item type
|
||||
=head3 type
|
||||
|
||||
The type of form element this variable came from. Defaults to "text" if not specified.
|
||||
|
||||
=item default
|
||||
=head3 default
|
||||
|
||||
The default value for this variable. If the variable is undefined then the default value will be returned instead.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub process {
|
||||
|
|
@ -510,14 +434,10 @@ sub process {
|
|||
|
||||
Returns a string.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub radio {
|
||||
|
|
@ -531,14 +451,10 @@ sub radio {
|
|||
|
||||
Returns a string.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub radioList {
|
||||
|
|
@ -552,14 +468,10 @@ sub radioList {
|
|||
|
||||
Returns an array or a carriage return ("\n") separated scalar depending upon whether you're returning the values into an array or a scalar.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub selectList {
|
||||
|
|
@ -574,14 +486,10 @@ sub selectList {
|
|||
|
||||
Returns a template id. Defaults to "1".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub template {
|
||||
|
|
@ -598,14 +506,10 @@ sub template {
|
|||
|
||||
Returns a string of text.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub text {
|
||||
|
|
@ -619,14 +523,10 @@ sub text {
|
|||
|
||||
Returns a string of text.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub textarea {
|
||||
|
|
@ -641,14 +541,10 @@ sub textarea {
|
|||
Returns the number of seconds since 00:00:00 on a 24 hour clock. Note, this will adjust for the user's time offset in the reverse manner that the form field
|
||||
adjusts for it in order to make the times come out appropriately.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub timeField {
|
||||
|
|
@ -662,14 +558,10 @@ sub timeField {
|
|||
|
||||
Returns a URL.
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub url {
|
||||
|
|
@ -690,14 +582,10 @@ sub url {
|
|||
|
||||
Returns either a 1 or 0 representing yes and no. Defaults to "0".
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub yesNo {
|
||||
|
|
@ -714,14 +602,10 @@ sub yesNo {
|
|||
|
||||
Returns a string which allows uppercase alpha characters, digits, spaces, and hypens (dashes).
|
||||
|
||||
=over
|
||||
|
||||
=item name
|
||||
=head3 name
|
||||
|
||||
The name of the form variable to retrieve.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub zipcode {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue