.\" 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::Ticket 3pm"
.TH Net::Trac::Ticket 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::Ticket \- Create, read, and update tickets on a remote Trac instance
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    my $ticket = Net::Trac::Ticket\->new( connection => $trac );
\&    $ticket\->load( 1 );
\&    
\&    print $ticket\->summary, "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a ticket on a remote Trac instance.  It provides methods
for creating, reading, and updating tickets and their history as well as adding
comments and getting attachments.
.ie n .SS "timestamp_to_datetime $stamp"
.el .SS "timestamp_to_datetime \f(CW$stamp\fP"
.IX Subsection "timestamp_to_datetime $stamp"
Accept's a timestamp in Trac's somewhat idiosyncratic format and returns a DateTime object
.SH "METHODS"
.IX Header "METHODS"
.SS "new \s-1HASH\s0"
.IX Subsection "new HASH"
Takes a key \f(CW\*(C`connection\*(C'\fR with a value of a Net::Trac::Connection.  Returns
an empty ticket object.
.SS "load \s-1ID\s0"
.IX Subsection "load ID"
Loads up the ticket with the specified \s-1ID.\s0  Returns the ticket \s-1ID\s0 loaded on success
and undef on failure.
.SS "load_from_hashref \s-1HASHREF\s0 [\s-1SKIP\s0]"
.IX Subsection "load_from_hashref HASHREF [SKIP]"
You should never need to use this method yourself.  Loads a ticket from a hashref
of data, optionally skipping metadata loading (values of \f(CW\*(C`valid_*\*(C'\fR accessors).
.SS "create \s-1HASH\s0"
.IX Subsection "create HASH"
Creates and loads a new ticket with the values specified.
Returns undef on failure and the new ticket \s-1ID\s0 on success.
.SS "update \s-1HASH\s0"
.IX Subsection "update HASH"
Updates the current ticket with the specified values.
.PP
Returns undef on failure, and the \s-1ID\s0 of the current ticket on success.
.SS "comment \s-1TEXT\s0"
.IX Subsection "comment TEXT"
Adds a comment to the current ticket.  Returns undef on failure, true on success.
.SS "history"
.IX Subsection "history"
Returns a Net::Trac::TicketHistory object for this ticket.
.SS "comments"
.IX Subsection "comments"
Returns an array or arrayref (depending on context) of history entries which
have comments included.  This will include history entries representing
attachments if they have descriptions.
.SS "attach \s-1PARAMHASH\s0"
.IX Subsection "attach PARAMHASH"
Attaches the specified \f(CW\*(C`file\*(C'\fR with an optional \f(CW\*(C`description\*(C'\fR.
Returns undef on failure and the new Net::Trac::TicketAttachment object
on success.
.SS "attachments"
.IX Subsection "attachments"
Returns an array or arrayref (depending on context) of all the
Net::Trac::TicketAttachment objects for this ticket.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "connection"
.IX Subsection "connection"
.SS "id"
.IX Subsection "id"
.SS "summary"
.IX Subsection "summary"
.SS "type"
.IX Subsection "type"
.SS "status"
.IX Subsection "status"
.SS "priority"
.IX Subsection "priority"
.SS "severity"
.IX Subsection "severity"
.SS "resolution"
.IX Subsection "resolution"
.SS "owner"
.IX Subsection "owner"
.SS "reporter"
.IX Subsection "reporter"
.SS "cc"
.IX Subsection "cc"
.SS "description"
.IX Subsection "description"
.SS "keywords"
.IX Subsection "keywords"
.SS "component"
.IX Subsection "component"
.SS "milestone"
.IX Subsection "milestone"
.SS "version"
.IX Subsection "version"
.SS "created"
.IX Subsection "created"
Returns a DateTime object
.SS "last_modified"
.IX Subsection "last_modified"
Returns a DateTime object
.SS "basic_statuses"
.IX Subsection "basic_statuses"
Returns a list of the basic statuses available for a ticket.  Others
may be defined by the remote Trac instance, but we have no way of easily
getting them.
.SS "valid_props"
.IX Subsection "valid_props"
Returns a list of the valid properties of a ticket.
.SS "add_custom_props"
.IX Subsection "add_custom_props"
Adds custom properties to valid properties list.
.SS "valid_create_props"
.IX Subsection "valid_create_props"
Returns a list of the valid properties specifiable when creating a ticket.
.SS "valid_update_props"
.IX Subsection "valid_update_props"
Returns a list of the valid updatable properties.
.SS "Valid property values"
.IX Subsection "Valid property values"
These accessors are loaded from the remote Trac instance with the valid
values for the properties upon instantiation of a ticket object.
.IP "valid_milestones" 4
.IX Item "valid_milestones"
.PD 0
.IP "valid_types" 4
.IX Item "valid_types"
.IP "valid_components" 4
.IX Item "valid_components"
.IP "valid_priorities" 4
.IX Item "valid_priorities"
.IP "valid_resolutions \- Only loaded when a ticket is loaded." 4
.IX Item "valid_resolutions - Only loaded when a ticket is loaded."
.IP "valid_severities \- May not be provided by the Trac instance." 4
.IX Item "valid_severities - May not be provided by the Trac instance."
.PD
.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.