.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Trac::Connection 3pm"
.TH Net::Trac::Connection 3pm "2018-07-06" "perl v5.26.2" "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"
Net::Trac::Connection \- Connection to a remote Trac server
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a connection to a remote Trac instance.  It is
required by all other classes which need to talk to Trac.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::Trac::Connection;
\&
\&    my $trac = Net::Trac::Connection\->new( 
\&        url      => \*(Aqhttp://trac.example.com\*(Aq,
\&        user     => \*(Aqsnoopy\*(Aq,
\&        password => \*(Aqdoghouse\*(Aq
\&    );
.Ve
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "url"
.IX Subsection "url"
The url of the Trac instance used by this connection.  Read-only after
initialization.
.SS "user"
.IX Subsection "user"
.SS "password"
.IX Subsection "password"
.SH "ACCESSORS / MUTATORS"
.IX Header "ACCESSORS / MUTATORS"
.SS "logged_in [\s-1BOOLEAN\s0]"
.IX Subsection "logged_in [BOOLEAN]"
Gets/sets a boolean indicating whether or not the connection is logged in yet.
.SS "mech [\s-1MECH\s0]"
.IX Subsection "mech [MECH]"
Gets/sets the Net::Trac::Mechanize (or subclassed) object for this
connection to use.  Unless you want to replace it with one of your own,
the default will suffice.
.SH "METHODS"
.IX Header "METHODS"
.SS "new \s-1PARAMHASH\s0"
.IX Subsection "new PARAMHASH"
Creates a new Net::Trac::Connection given a paramhash with values for
the keys \f(CW\*(C`url\*(C'\fR, \f(CW\*(C`user\*(C'\fR, and \f(CW\*(C`password\*(C'\fR.
.SS "ensure_logged_in"
.IX Subsection "ensure_logged_in"
Ensures this connection is logged in.  Returns true on success, and undef
on failure.  Sets the \f(CW\*(C`logged_in\*(C'\fR flag.
.SH "PRIVATE METHODS"
.IX Header "PRIVATE METHODS"
.SS "_fetch \s-1URL\s0"
.IX Subsection "_fetch URL"
Fetches the provided \fBrelative\fR \s-1URL\s0 from the Trac server.  Returns undef
on an error (after \f(CW\*(C`warn\*(C'\fRing) and the content (\f(CW\*(C`$self\-\*(C'\fRmech\->content>)
on success.
.SS "_warn_on_error \s-1URL\s0"
.IX Subsection "_warn_on_error URL"
Checks the last request for an error condition and warns about them if found.
Returns with a \fB\s-1TRUE\s0\fR value if errors occurred and a \fB\s-1FALSE\s0\fR value otherwise
for nicer conditionals.
.SS "_tsv_to_struct \s-1PARAMHASH\s0"
.IX Subsection "_tsv_to_struct PARAMHASH"
Takes a paramhash of the keys \f(CW\*(C`data\*(C'\fR
Given \s-1TSV\s0 data this method will return a reference to an array.
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2008\-2009 Best Practical Solutions.
.PP
This package is licensed under the same terms as Perl 5.8.8.