/ 
CGI-FormBuilder-3.000
River stage two • 11 direct dependents • 16 total dependents
/ CGI::FormBuilder::Util

NAME

CGI::FormBuilder::Util - utility functions for FormBuilder

SYNOPSIS

use CGI::FormBuilder::Util;

belch "Badness";
puke "Egads";
debug 2, "Debug message for level 2";

DESCRIPTION

This module exports some common utility functions for FormBuilder. These functions are intended for internal use, however I must admit that, from time to time, I just import this module and use some of the routines directly (like htmltag() to generate HTML).

USEFUL FUNCTIONS

These can be used directly and are somewhat useful. Don't tell anyone I said that, though.

debug($level, $string)

This prints out the given string only if $DEBUG is greater than the $level specified. For example:

$CGI::FormBuilder::Util::DEBUG = 1;
debug 1, "this is printed";
debug 2, "but not this one";

A newline is automatically included, so don't provide one of your own.

belch($string)

A modified warn that prints out a better message with a newline added.

puke($string)

A modified die that prints out a full stack trace, including newlines.

escapeurl($string)

Returns a properly escaped string suitable for including in URL params.

escapehtml($string)

Returns an HTML-escaped string suitable for embedding in HTML tags. This dispatches to HTML::Entities::encode() if available.

htmltag($name, %attr)

This generates an XHTML-compliant tag for the name $name based on the %attr specified. For example:

my $table = htmltag('table', cellpadding => 1, border => 0);

No routines are provided to close tags; you must manually print a closing </table> tag.

htmlattr($name, %attr)

This cleans any internal FormBuilder attributes from the specified tag. It is automatically called by htmltag().

toname($string)

This is responsible for the auto-naming functionality of FormBuilder. Since you know Perl, it's easiest to just show what it does:

$name =~ s!\.\w+$!!;                # lose trailing ".suf"
$name =~ s![^a-zA-Z0-9.-/]+! !g;    # strip non-alpha chars
$name =~ s!\b(\w)!\u$1!g;           # convert _ to space/upper

This results in something like "cgi_script.pl" becoming "Cgi Script".

ismember($el, @array)

Returns true if $el is in @array

USELESS FUNCTIONS

These are totally useless outside of FormBuilder internals.

autodata($ref)

This dereferences $ref and returns the underlying data. For example:

%hash  = autodata($hashref);
@array = autodata($arrayref);

cleanargs(@_)

This returns a hash of options passed into a sub:

sub field {
    my $self = shift;
    my %opt  = cleanargs(@_);
}

It does some minor sanity checks as well.

# strip off any leading '-opt' crap
my @args;
while (@_) {
    (my $k = shift) =~ s/^-//;
    push @args, $k, shift;
}

indent($num)

A simple sub that returns 4 spaces x $num. Used to indent code.

optalign(\@opt)

This returns the options specified as an array of arrayrefs, which is what FormBuilder expects internally.

optsort($sortref, @opt)

This sorts and returns the options based on $sortref. It expects @opt to be in the format returned by optalign(). The $sortref spec can be the string NAME, NUM, or a reference to a &sub which takes pairs of values to compare.

optval($opt)

This takes one of the elements of @opt and returns it split up. Useless outside of FormBuilder.

SEE ALSO

CGI::FormBuilder

REVISION

$Id: Util.pm,v 1.6 2005/02/07 19:16:28 nwiger Exp $

AUTHOR

Copyright (c) 2000-2005 Nathan Wiger <nate@sun.com>. All Rights Reserved.

This module is free software; you may copy this under the terms of the GNU General Public License, or the Artistic License, copies of which should have accompanied your Perl kit.