WWWWWW

Current Directory: /home/.cpanm/work/1729881451.851394/HTML-Form-6.12/blib/man3
Viewing File: /home/.cpanm/work/1729881451.851394/HTML-Form-6.12/blib/man3/HTML::Form.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::Form 3"
.TH HTML::Form 3 "2024-10-18" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::Form \- Class that represents an HTML form element
.SH "VERSION"
.IX Header "VERSION"
version 6.12
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use HTML::Form;
\& $form = HTML::Form\->parse($html, $base_uri);
\& $form\->value(query => "Perl");
\&
\& use LWP::UserAgent;
\& $ua = LWP::UserAgent\->new;
\& $response = $ua\->request($form\->click);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects of the \f(CW\*(C`HTML::Form\*(C'\fR class represents a single \s-1HTML\s0
\&\f(CW\*(C`<form> ... </form>\*(C'\fR instance.  A form consists of a
sequence of inputs that usually have names, and which can take on
various values.  The state of a form can be tweaked and it can then be
asked to provide HTTP::Request objects that can be passed to the
\&\fBrequest()\fR method of LWP::UserAgent.
.PP
The following methods are available:
.ie n .IP "@forms = HTML::Form\->parse( $html_document, $base_uri )" 4
.el .IP "\f(CW@forms\fR = HTML::Form\->parse( \f(CW$html_document\fR, \f(CW$base_uri\fR )" 4
.IX Item "@forms = HTML::Form->parse( $html_document, $base_uri )"
.PD 0
.ie n .IP "@forms = HTML::Form\->parse( $html_document, base => $base_uri, %opt )" 4
.el .IP "\f(CW@forms\fR = HTML::Form\->parse( \f(CW$html_document\fR, base => \f(CW$base_uri\fR, \f(CW%opt\fR )" 4
.IX Item "@forms = HTML::Form->parse( $html_document, base => $base_uri, %opt )"
.ie n .IP "@forms = HTML::Form\->parse( $response, %opt )" 4
.el .IP "\f(CW@forms\fR = HTML::Form\->parse( \f(CW$response\fR, \f(CW%opt\fR )" 4
.IX Item "@forms = HTML::Form->parse( $response, %opt )"
.PD
The \fBparse()\fR class method will parse an \s-1HTML\s0 document and build up
\&\f(CW\*(C`HTML::Form\*(C'\fR objects for each <form> element found.  If called in scalar
context only returns the first <form>.  Returns an empty list if there
are no forms to be found.
.Sp
The required arguments is the \s-1HTML\s0 document to parse ($html_document) and the
\&\s-1URI\s0 used to retrieve the document ($base_uri).  The base \s-1URI\s0 is needed to resolve
relative action URIs.  The provided \s-1HTML\s0 document should be a Unicode string
(or US-ASCII).
.Sp
By default HTML::Form assumes that the original document was \s-1UTF\-8\s0 encoded and
thus encode forms that don't specify an explicit \fIaccept-charset\fR as \s-1UTF\-8.\s0
The charset assumed can be overridden by providing the \f(CW\*(C`charset\*(C'\fR option to
\&\fBparse()\fR.  It's a good idea to be explicit about this parameter as well, thus
the recommended simplest invocation becomes:
.Sp
.Vb 5
\&    my @forms = HTML::Form\->parse(
\&        Encode::decode($encoding, $html_document_bytes),
\&        base => $base_uri,
\&        charset => $encoding,
\&    );
.Ve
.Sp
If the document was retrieved with \s-1LWP\s0 then the response object provide methods
to obtain a proper value for \f(CW\*(C`base\*(C'\fR and \f(CW\*(C`charset\*(C'\fR:
.Sp
.Vb 6
\&    my $ua = LWP::UserAgent\->new;
\&    my $response = $ua\->get("http://www.example.com/form.html");
\&    my @forms = HTML::Form\->parse($response\->decoded_content,
\&        base => $response\->base,
\&        charset => $response\->content_charset,
\&    );
.Ve
.Sp
In fact, the \fBparse()\fR method can parse from an HTTP::Response object
directly, so the example above can be more conveniently written as:
.Sp
.Vb 3
\&    my $ua = LWP::UserAgent\->new;
\&    my $response = $ua\->get("http://www.example.com/form.html");
\&    my @forms = HTML::Form\->parse($response);
.Ve
.Sp
Note that any object that implements a \fBdecoded_content()\fR, \fBbase()\fR and
\&\fBcontent_charset()\fR method with similar behaviour as HTTP::Response will do.
.Sp
Additional options might be passed in to control how the parse method
behaves.  The following are all the options currently recognized:
.RS 4
.ie n .IP """base => $uri""" 4
.el .IP "\f(CWbase => $uri\fR" 4
.IX Item "base => $uri"
This is the \s-1URI\s0 used to retrieve the original document.  This option is not optional ;\-)
.ie n .IP """charset => $str""" 4
.el .IP "\f(CWcharset => $str\fR" 4
.IX Item "charset => $str"
Specify what charset the original document was encoded in.  This is used as
the default for accept_charset.  If not provided this defaults to \*(L"\s-1UTF\-8\*(R".\s0
.ie n .IP """verbose => $bool""" 4
.el .IP "\f(CWverbose => $bool\fR" 4
.IX Item "verbose => $bool"
Warn (print messages to \s-1STDERR\s0) about any bad \s-1HTML\s0 form constructs found.
You can trap these with \f(CW$SIG\fR{_\|_WARN_\|_}.  The default is not to issue warnings.
.ie n .IP """strict => $bool""" 4
.el .IP "\f(CWstrict => $bool\fR" 4
.IX Item "strict => $bool"
Initialize any form objects with the given strict attribute.
If the strict is turned on the methods that change values of the form will croak if you try
to set illegal values or modify readonly fields.
The default is not to be strict.
.RE
.RS 4
.RE
.ie n .IP "$form\->push_input( $type, \e%attr, $verbose )" 4
.el .IP "\f(CW$form\fR\->push_input( \f(CW$type\fR, \e%attr, \f(CW$verbose\fR )" 4
.IX Item "$form->push_input( $type, %attr, $verbose )"
This method adds additional inputs to the form.
The first argument is the type of input (e.g. hidden, option, etc.).
The second argument is a reference to a hash of the input attributes.
The third argument is optional, and will issue warnings about unknown input types.
.Sp
Example:
.Sp
.Vb 5
\&    push_input( \*(Aqhidden\*(Aq, {
\&        name  => \*(AqNewFormElement\*(Aq,
\&        id    => \*(AqNewFormElementId\*(Aq,
\&        value => \*(Aqsome value\*(Aq,
\&    });
.Ve
.ie n .IP "$method = $form\->method" 4
.el .IP "\f(CW$method\fR = \f(CW$form\fR\->method" 4
.IX Item "$method = $form->method"
.PD 0
.ie n .IP "$form\->method( $new_method )" 4
.el .IP "\f(CW$form\fR\->method( \f(CW$new_method\fR )" 4
.IX Item "$form->method( $new_method )"
.PD
This method is gets/sets the \fImethod\fR name used for the
HTTP::Request generated.  It is a string like \*(L"\s-1GET\*(R"\s0 or \*(L"\s-1POST\*(R".\s0
.ie n .IP "$action = $form\->action" 4
.el .IP "\f(CW$action\fR = \f(CW$form\fR\->action" 4
.IX Item "$action = $form->action"
.PD 0
.ie n .IP "$form\->action( $new_action )" 4
.el .IP "\f(CW$form\fR\->action( \f(CW$new_action\fR )" 4
.IX Item "$form->action( $new_action )"
.PD
This method gets/sets the \s-1URI\s0 which we want to apply the request
\&\fImethod\fR to.
.ie n .IP "$enctype = $form\->enctype" 4
.el .IP "\f(CW$enctype\fR = \f(CW$form\fR\->enctype" 4
.IX Item "$enctype = $form->enctype"
.PD 0
.ie n .IP "$form\->enctype( $new_enctype )" 4
.el .IP "\f(CW$form\fR\->enctype( \f(CW$new_enctype\fR )" 4
.IX Item "$form->enctype( $new_enctype )"
.PD
This method gets/sets the encoding type for the form data.  It is a
string like \*(L"application/x\-www\-form\-urlencoded\*(R" or \*(L"multipart/form\-data\*(R".
.ie n .IP "$accept = $form\->accept_charset" 4
.el .IP "\f(CW$accept\fR = \f(CW$form\fR\->accept_charset" 4
.IX Item "$accept = $form->accept_charset"
.PD 0
.ie n .IP "$form\->accept_charset( $new_accept )" 4
.el .IP "\f(CW$form\fR\->accept_charset( \f(CW$new_accept\fR )" 4
.IX Item "$form->accept_charset( $new_accept )"
.PD
This method gets/sets the list of charset encodings that the server processing
the form accepts. Current implementation supports only one-element lists.
Default value is \*(L"\s-1UNKNOWN\*(R"\s0 which we interpret as a request to use document
charset as specified by the 'charset' parameter of the \fBparse()\fR method.
.ie n .IP "$value = $form\->attr( $name )" 4
.el .IP "\f(CW$value\fR = \f(CW$form\fR\->attr( \f(CW$name\fR )" 4
.IX Item "$value = $form->attr( $name )"
.PD 0
.ie n .IP "$form\->attr( $name, $new_value )" 4
.el .IP "\f(CW$form\fR\->attr( \f(CW$name\fR, \f(CW$new_value\fR )" 4
.IX Item "$form->attr( $name, $new_value )"
.PD
This method give access to the original \s-1HTML\s0 attributes of the <form> tag.
The \f(CW$name\fR should always be passed in lower case.
.Sp
Example:
.Sp
.Vb 4
\&   @f = HTML::Form\->parse( $html, $foo );
\&   @f = grep $_\->attr("id") eq "foo", @f;
\&   die "No form named \*(Aqfoo\*(Aq found" unless @f;
\&   $foo = shift @f;
.Ve
.ie n .IP "$bool = $form\->strict" 4
.el .IP "\f(CW$bool\fR = \f(CW$form\fR\->strict" 4
.IX Item "$bool = $form->strict"
.PD 0
.ie n .IP "$form\->strict( $bool )" 4
.el .IP "\f(CW$form\fR\->strict( \f(CW$bool\fR )" 4
.IX Item "$form->strict( $bool )"
.PD
Gets/sets the strict attribute of a form.  If the strict is turned on
the methods that change values of the form will croak if you try to
set illegal values or modify readonly fields.  The default is not to be strict.
.ie n .IP "@inputs = $form\->inputs" 4
.el .IP "\f(CW@inputs\fR = \f(CW$form\fR\->inputs" 4
.IX Item "@inputs = $form->inputs"
This method returns the list of inputs in the form.  If called in
scalar context it returns the number of inputs contained in the form.
See \*(L"\s-1INPUTS\*(R"\s0 for what methods are available for the input objects
returned.
.ie n .IP "$input = $form\->find_input( $selector )" 4
.el .IP "\f(CW$input\fR = \f(CW$form\fR\->find_input( \f(CW$selector\fR )" 4
.IX Item "$input = $form->find_input( $selector )"
.PD 0
.ie n .IP "$input = $form\->find_input( $selector, $type )" 4
.el .IP "\f(CW$input\fR = \f(CW$form\fR\->find_input( \f(CW$selector\fR, \f(CW$type\fR )" 4
.IX Item "$input = $form->find_input( $selector, $type )"
.ie n .IP "$input = $form\->find_input( $selector, $type, $index )" 4
.el .IP "\f(CW$input\fR = \f(CW$form\fR\->find_input( \f(CW$selector\fR, \f(CW$type\fR, \f(CW$index\fR )" 4
.IX Item "$input = $form->find_input( $selector, $type, $index )"
.ie n .IP "@inputs = $form\->find_input( $selector )" 4
.el .IP "\f(CW@inputs\fR = \f(CW$form\fR\->find_input( \f(CW$selector\fR )" 4
.IX Item "@inputs = $form->find_input( $selector )"
.ie n .IP "@inputs = $form\->find_input( $selector, $type )" 4
.el .IP "\f(CW@inputs\fR = \f(CW$form\fR\->find_input( \f(CW$selector\fR, \f(CW$type\fR )" 4
.IX Item "@inputs = $form->find_input( $selector, $type )"
.PD
This method is used to locate specific inputs within the form.  All
inputs that match the arguments given are returned.  In scalar context
only the first is returned, or \f(CW\*(C`undef\*(C'\fR if none match.
.Sp
If \f(CW$selector\fR is not \f(CW\*(C`undef\*(C'\fR, then the input's \fIname\fR, \fIid\fR or \fIclass\fR
attribute must match.
A selector prefixed with '#' must match the \fIid\fR attribute of the input.
A selector prefixed with '.' matches the \fIclass\fR attribute. A selector prefixed
with '^' or with no prefix matches the \fIname\fR attribute.
.Sp
.Vb 4
\&    my @by_id         = $form\->find_input( \*(Aq#some\-id\*(Aq );
\&    my @by_class      = $form\->find_input( \*(Aq.some\-class\*(Aq );
\&    my @by_name       = $form\->find_input( \*(Aq^some\-name\*(Aq );
\&    my @also_by_name  = $form\->find_input( \*(Aqsome\-name\*(Aq );
.Ve
.Sp
If you want to find an input that has no \fIname\fR at all, pass in a reference
to \f(CW\*(C`undef\*(C'\fR.
.Sp
.Vb 1
\&    my @nameless_inputs = $form\->find_input( \eundef );
.Ve
.Sp
If \f(CW$type\fR is not \f(CW\*(C`undef\*(C'\fR, then the input must have the specified type.
The following type names are used: \*(L"text\*(R", \*(L"password\*(R", \*(L"hidden\*(R",
\&\*(L"textarea\*(R", \*(L"file\*(R", \*(L"image\*(R", \*(L"submit\*(R", \*(L"radio\*(R", \*(L"checkbox\*(R" and \*(L"option\*(R".
.Sp
The \f(CW$index\fR is the sequence number of the input matched where 1 is the
first.  If combined with \f(CW$selector\fR and/or \f(CW$type\fR, then it selects the
\&\fIn\fRth input with the given \fIname\fR and/or type.
.ie n .IP "$value = $form\->value( $selector )" 4
.el .IP "\f(CW$value\fR = \f(CW$form\fR\->value( \f(CW$selector\fR )" 4
.IX Item "$value = $form->value( $selector )"
.PD 0
.ie n .IP "$form\->value( $selector, $new_value )" 4
.el .IP "\f(CW$form\fR\->value( \f(CW$selector\fR, \f(CW$new_value\fR )" 4
.IX Item "$form->value( $selector, $new_value )"
.PD
The \fBvalue()\fR method can be used to get/set the value of some input.  If
strict is enabled and no input has the indicated name, then this method will croak.
.Sp
If multiple inputs have the same name, only the first one will be
affected.
.Sp
The call:
.Sp
.Vb 1
\&    $form\->value(\*(Aqfoo\*(Aq)
.Ve
.Sp
is basically a short-hand for:
.Sp
.Vb 1
\&    $form\->find_input(\*(Aqfoo\*(Aq)\->value;
.Ve
.ie n .IP "@names = $form\->param" 4
.el .IP "\f(CW@names\fR = \f(CW$form\fR\->param" 4
.IX Item "@names = $form->param"
.PD 0
.ie n .IP "@values = $form\->param( $name )" 4
.el .IP "\f(CW@values\fR = \f(CW$form\fR\->param( \f(CW$name\fR )" 4
.IX Item "@values = $form->param( $name )"
.ie n .IP "$form\->param( $name, $value, ... )" 4
.el .IP "\f(CW$form\fR\->param( \f(CW$name\fR, \f(CW$value\fR, ... )" 4
.IX Item "$form->param( $name, $value, ... )"
.ie n .IP "$form\->param( $name, \e@values )" 4
.el .IP "\f(CW$form\fR\->param( \f(CW$name\fR, \e@values )" 4
.IX Item "$form->param( $name, @values )"
.PD
Alternative interface to examining and setting the values of the form.
.Sp
If called without arguments then it returns the names of all the
inputs in the form.  The names will not repeat even if multiple inputs
have the same name.  In scalar context the number of different names
is returned.
.Sp
If called with a single argument then it returns the value or values
of inputs with the given name.  If called in scalar context only the
first value is returned.  If no input exists with the given name, then
\&\f(CW\*(C`undef\*(C'\fR is returned.
.Sp
If called with 2 or more arguments then it will set values of the
named inputs.  This form will croak if no inputs have the given name
or if any of the values provided does not fit.  Values can also be
provided as a reference to an array.  This form will allow unsetting
all values with the given name as well.
.Sp
This interface resembles that of the \fBparam()\fR function of the \s-1CGI\s0
module.
.ie n .IP "$form\->try_others( \e&callback )" 4
.el .IP "\f(CW$form\fR\->try_others( \e&callback )" 4
.IX Item "$form->try_others( &callback )"
This method will iterate over all permutations of unvisited enumerated
values (<select>, <radio>, <checkbox>) and invoke the callback for
each.  The callback is passed the \f(CW$form\fR as argument.  The return value
from the callback is ignored and the \fBtry_others()\fR method itself does
not return anything.
.ie n .IP "$request = $form\->make_request" 4
.el .IP "\f(CW$request\fR = \f(CW$form\fR\->make_request" 4
.IX Item "$request = $form->make_request"
Will return an HTTP::Request object that reflects the current setting
of the form.  You might want to use the \fBclick()\fR method instead.
.ie n .IP "$request = $form\->click" 4
.el .IP "\f(CW$request\fR = \f(CW$form\fR\->click" 4
.IX Item "$request = $form->click"
.PD 0
.ie n .IP "$request = $form\->click( $selector )" 4
.el .IP "\f(CW$request\fR = \f(CW$form\fR\->click( \f(CW$selector\fR )" 4
.IX Item "$request = $form->click( $selector )"
.ie n .IP "$request = $form\->click( $x, $y )" 4
.el .IP "\f(CW$request\fR = \f(CW$form\fR\->click( \f(CW$x\fR, \f(CW$y\fR )" 4
.IX Item "$request = $form->click( $x, $y )"
.ie n .IP "$request = $form\->click( $selector, $x, $y )" 4
.el .IP "\f(CW$request\fR = \f(CW$form\fR\->click( \f(CW$selector\fR, \f(CW$x\fR, \f(CW$y\fR )" 4
.IX Item "$request = $form->click( $selector, $x, $y )"
.PD
Will \*(L"click\*(R" on the first clickable input (which will be of type
\&\f(CW\*(C`submit\*(C'\fR or \f(CW\*(C`image\*(C'\fR).  The result of clicking is an HTTP::Request
object that can then be passed to LWP::UserAgent if you want to
obtain the server response.
.Sp
If a \f(CW$selector\fR is specified, we will click on the first clickable input
matching the selector, and the method will croak if no matching clickable
input is found.  If \f(CW$selector\fR is \fInot\fR specified, then it
is ok if the form contains no clickable inputs.  In this case the
\&\fBclick()\fR method returns the same request as the \fBmake_request()\fR method
would do.  See description of the \fBfind_input()\fR method above for how
the \f(CW$selector\fR is specified.
.Sp
If there are multiple clickable inputs with the same name, then there
is no way to get the \fBclick()\fR method of the \f(CW\*(C`HTML::Form\*(C'\fR to click on
any but the first.  If you need this you would have to locate the
input with \fBfind_input()\fR and invoke the \fBclick()\fR method on the given
input yourself.
.Sp
A click coordinate pair can also be provided, but this only makes a
difference if you clicked on an image.  The default coordinate is
(1,1).  The upper-left corner of the image is (0,0), but some badly
coded \s-1CGI\s0 scripts are known to not recognize this.  Therefore (1,1) was
selected as a safer default.
.ie n .IP "@kw = $form\->form" 4
.el .IP "\f(CW@kw\fR = \f(CW$form\fR\->form" 4
.IX Item "@kw = $form->form"
Returns the current setting as a sequence of key/value pairs.  Note
that keys might be repeated, which means that some values might be
lost if the return values are assigned to a hash.
.Sp
In scalar context this method returns the number of key/value pairs
generated.
.ie n .IP "$form\->dump" 4
.el .IP "\f(CW$form\fR\->dump" 4
.IX Item "$form->dump"
Returns a textual representation of current state of the form.  Mainly
useful for debugging.  If called in void context, then the dump is
printed on \s-1STDERR.\s0
.SH "NAME"
HTML::Form \- Class that represents an HTML form element
.SH "INPUTS"
.IX Header "INPUTS"
An \f(CW\*(C`HTML::Form\*(C'\fR object contains a sequence of \fIinputs\fR.  References to
the inputs can be obtained with the \f(CW$form\fR\->inputs or \f(CW$form\fR\->find_input
methods.
.PP
Note that there is \fInot\fR a one-to-one correspondence between input
\&\fIobjects\fR and <input> \fIelements\fR in the \s-1HTML\s0 document.  An
input object basically represents a name/value pair, so when multiple
\&\s-1HTML\s0 elements contribute to the same name/value pair in the submitted
form they are combined.
.PP
The input elements that are mapped one-to-one are \*(L"text\*(R", \*(L"textarea\*(R",
\&\*(L"password\*(R", \*(L"hidden\*(R", \*(L"file\*(R", \*(L"image\*(R", \*(L"submit\*(R" and \*(L"checkbox\*(R".  For
the \*(L"radio\*(R" and \*(L"option\*(R" inputs the story is not as simple: All
<input type=\*(L"radio\*(R"> elements with the same name will
contribute to the same input radio object.  The number of radio input
objects will be the same as the number of distinct names used for the
<input type=\*(L"radio\*(R"> elements.  For a <select> element
without the \f(CW\*(C`multiple\*(C'\fR attribute there will be one input object of
type of \*(L"option\*(R".  For a <select multiple> element there will
be one input object for each contained <option> element.  Each
one of these option objects will have the same name.
.PP
The following methods are available for the \fIinput\fR objects:
.ie n .IP "$input\->type" 4
.el .IP "\f(CW$input\fR\->type" 4
.IX Item "$input->type"
Returns the type of this input.  The type is one of the following
strings: \*(L"text\*(R", \*(L"password\*(R", \*(L"hidden\*(R", \*(L"textarea\*(R", \*(L"file\*(R", \*(L"image\*(R", \*(L"submit\*(R",
\&\*(L"radio\*(R", \*(L"checkbox\*(R" or \*(L"option\*(R".
.ie n .IP "$name = $input\->name" 4
.el .IP "\f(CW$name\fR = \f(CW$input\fR\->name" 4
.IX Item "$name = $input->name"
.PD 0
.ie n .IP "$input\->name( $new_name )" 4
.el .IP "\f(CW$input\fR\->name( \f(CW$new_name\fR )" 4
.IX Item "$input->name( $new_name )"
.PD
This method can be used to get/set the current name of the input.
.ie n .IP "$input\->id" 4
.el .IP "\f(CW$input\fR\->id" 4
.IX Item "$input->id"
.PD 0
.ie n .IP "$input\->class" 4
.el .IP "\f(CW$input\fR\->class" 4
.IX Item "$input->class"
.PD
These methods can be used to get/set the current id or class attribute for the input.
.ie n .IP "$input\->selected( $selector )" 4
.el .IP "\f(CW$input\fR\->selected( \f(CW$selector\fR )" 4
.IX Item "$input->selected( $selector )"
Returns \s-1TRUE\s0 if the given selector matched the input.  See the description of
the \fBfind_input()\fR method above for a description of the selector syntax.
.ie n .IP "$value = $input\->value" 4
.el .IP "\f(CW$value\fR = \f(CW$input\fR\->value" 4
.IX Item "$value = $input->value"
.PD 0
.ie n .IP "$input\->value( $new_value )" 4
.el .IP "\f(CW$input\fR\->value( \f(CW$new_value\fR )" 4
.IX Item "$input->value( $new_value )"
.PD
This method can be used to get/set the current value of an
input.
.Sp
If strict is enabled and the input only can take an enumerated list of values,
then it is an error to try to set it to something else and the method will
croak if you try.
.Sp
You will also be able to set the value of read-only inputs, but a
warning will be generated if running under \f(CW\*(C`perl \-w\*(C'\fR.
.ie n .IP "$autocomplete = $input\->autocomplete" 4
.el .IP "\f(CW$autocomplete\fR = \f(CW$input\fR\->autocomplete" 4
.IX Item "$autocomplete = $input->autocomplete"
.PD 0
.ie n .IP "$input\->autocomplete( $new_autocomplete )" 4
.el .IP "\f(CW$input\fR\->autocomplete( \f(CW$new_autocomplete\fR )" 4
.IX Item "$input->autocomplete( $new_autocomplete )"
.PD
This method can be used to get/set the current value (if any) of \f(CW\*(C`autcomplete\*(C'\fR for the input.
.ie n .IP "$input\->possible_values" 4
.el .IP "\f(CW$input\fR\->possible_values" 4
.IX Item "$input->possible_values"
Returns a list of all values that an input can take.  For inputs that
do not have discrete values, this returns an empty list.
.ie n .IP "$input\->other_possible_values" 4
.el .IP "\f(CW$input\fR\->other_possible_values" 4
.IX Item "$input->other_possible_values"
Returns a list of all values not tried yet.
.ie n .IP "$input\->value_names" 4
.el .IP "\f(CW$input\fR\->value_names" 4
.IX Item "$input->value_names"
For some inputs the values can have names that are different from the
values themselves.  The number of names returned by this method will
match the number of values reported by \f(CW$input\fR\->possible_values.
.Sp
When setting values using the \fBvalue()\fR method it is also possible to
use the value names in place of the value itself.
.ie n .IP "$bool = $input\->readonly" 4
.el .IP "\f(CW$bool\fR = \f(CW$input\fR\->readonly" 4
.IX Item "$bool = $input->readonly"
.PD 0
.ie n .IP "$input\->readonly( $bool )" 4
.el .IP "\f(CW$input\fR\->readonly( \f(CW$bool\fR )" 4
.IX Item "$input->readonly( $bool )"
.PD
This method is used to get/set the value of the readonly attribute.
You are allowed to modify the value of readonly inputs, but setting
the value will generate some noise when warnings are enabled.  Hidden
fields always start out readonly.
.ie n .IP "$bool = $input\->disabled" 4
.el .IP "\f(CW$bool\fR = \f(CW$input\fR\->disabled" 4
.IX Item "$bool = $input->disabled"
.PD 0
.ie n .IP "$input\->disabled( $bool )" 4
.el .IP "\f(CW$input\fR\->disabled( \f(CW$bool\fR )" 4
.IX Item "$input->disabled( $bool )"
.PD
This method is used to get/set the value of the disabled attribute.
Disabled inputs do not contribute any key/value pairs for the form
value.
.ie n .IP "$input\->form_name_value" 4
.el .IP "\f(CW$input\fR\->form_name_value" 4
.IX Item "$input->form_name_value"
Returns a (possible empty) list of key/value pairs that should be
incorporated in the form value from this input.
.ie n .IP "$input\->check" 4
.el .IP "\f(CW$input\fR\->check" 4
.IX Item "$input->check"
Some input types represent toggles that can be turned on/off.  This
includes \*(L"checkbox\*(R" and \*(L"option\*(R" inputs.  Calling this method turns
this input on without having to know the value name.  If the input is
already on, then nothing happens.
.Sp
This has the same effect as:
.Sp
.Vb 1
\&    $input\->value($input\->possible_values[1]);
.Ve
.Sp
The input can be turned off with:
.Sp
.Vb 1
\&    $input\->value(undef);
.Ve
.ie n .IP "$input\->click($form, $x, $y)" 4
.el .IP "\f(CW$input\fR\->click($form, \f(CW$x\fR, \f(CW$y\fR)" 4
.IX Item "$input->click($form, $x, $y)"
Some input types (currently \*(L"submit\*(R" buttons and \*(L"images\*(R") can be
clicked to submit the form.  The \fBclick()\fR method returns the
corresponding HTTP::Request object.
.PP
If the input is of type \f(CW\*(C`file\*(C'\fR, then it has these additional methods:
.ie n .IP "$input\->file" 4
.el .IP "\f(CW$input\fR\->file" 4
.IX Item "$input->file"
This is just an alias for the \fBvalue()\fR method.  It sets the filename to
read data from.
.Sp
For security reasons this field will never be initialized from the parsing
of a form.  This prevents the server from triggering stealth uploads of
arbitrary files from the client machine.
.ie n .IP "$filename = $input\->filename" 4
.el .IP "\f(CW$filename\fR = \f(CW$input\fR\->filename" 4
.IX Item "$filename = $input->filename"
.PD 0
.ie n .IP "$input\->filename( $new_filename )" 4
.el .IP "\f(CW$input\fR\->filename( \f(CW$new_filename\fR )" 4
.IX Item "$input->filename( $new_filename )"
.PD
This get/sets the filename reported to the server during file upload.
This attribute defaults to the value reported by the \fBfile()\fR method.
.ie n .IP "$content = $input\->content" 4
.el .IP "\f(CW$content\fR = \f(CW$input\fR\->content" 4
.IX Item "$content = $input->content"
.PD 0
.ie n .IP "$input\->content( $new_content )" 4
.el .IP "\f(CW$input\fR\->content( \f(CW$new_content\fR )" 4
.IX Item "$input->content( $new_content )"
.PD
This get/sets the file content provided to the server during file
upload.  This method can be used if you do not want the content to be
read from an actual file.
.ie n .IP "@headers = $input\->headers" 4
.el .IP "\f(CW@headers\fR = \f(CW$input\fR\->headers" 4
.IX Item "@headers = $input->headers"
.PD 0
.ie n .IP "input\->headers($key => $value, .... )" 4
.el .IP "input\->headers($key => \f(CW$value\fR, .... )" 4
.IX Item "input->headers($key => $value, .... )"
.PD
This get/set additional header fields describing the file uploaded.
This can for instance be used to set the \f(CW\*(C`Content\-Type\*(C'\fR reported for
the file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1LWP\s0, LWP::UserAgent, HTML::Parser
.SH "AUTHOR"
.IX Header "AUTHOR"
Gisle Aas <gisle@activestate.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 1998 by Gisle Aas.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
F1l3 Manager
