Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

net::trac::ticket(3pm) [debian man page]

Net::Trac::Ticket(3pm)					User Contributed Perl Documentation				    Net::Trac::Ticket(3pm)

NAME

       Net::Trac::Ticket - Create, read, and update tickets on a remote Trac instance

SYNOPSIS

	   my $ticket = Net::Trac::Ticket->new( connection => $trac );
	   $ticket->load( 1 );

	   print $ticket->summary, "
";

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.

   timestamp_to_datetime $stamp
       Accept's a timestamp in Trac's somewhat idiosyncratic format and returns a DateTime object

METHODS

   new HASH
       Takes a key "connection" with a value of a Net::Trac::Connection.  Returns an empty ticket object.

   load ID
       Loads up the ticket with the specified ID.  Returns the ticket ID loaded on success and undef on failure.

   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
       "valid_*" accessors).

   create HASH
       Creates and loads a new ticket with the values specified.  Returns undef on failure and the new ticket ID on success.

   update HASH
       Updates the current ticket with the specified values.

       Returns undef on failure, and the ID of the current ticket on success.

   comment TEXT
       Adds a comment to the current ticket.  Returns undef on failure, true on success.

   history
       Returns a Net::Trac::TicketHistory object for this ticket.

   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.

   attach PARAMHASH
       Attaches the specified "file" with an optional "description".  Returns undef on failure and the new Net::Trac::TicketAttachment object on
       success.

   attachments
       Returns an array or arrayref (depending on context) of all the Net::Trac::TicketAttachment objects for this ticket.

ACCESSORS

   connection
   id
   summary
   type
   status
   priority
   severity
   resolution
   owner
   reporter
   cc
   description
   keywords
   component
   milestone
   version
   created
       Returns a DateTime object

   last_modified
       Returns a DateTime object

   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.

   valid_props
       Returns a list of the valid properties of a ticket.

   add_custom_props
       Adds custom properties to valid properties list.

   valid_create_props
       Returns a list of the valid properties specifiable when creating a ticket.

   valid_update_props
       Returns a list of the valid updatable properties.

   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.

       valid_milestones
       valid_types
       valid_components
       valid_priorities
       valid_resolutions - Only loaded when a ticket is loaded.
       valid_severities - May not be provided by the Trac instance.

LICENSE

       Copyright 2008-2009 Best Practical Solutions.

       This package is licensed under the same terms as Perl 5.8.8.

perl v5.12.3							    2011-04-02						    Net::Trac::Ticket(3pm)

Check Out this Related Man Page

Net::Trac::TicketSearch(3pm)				User Contributed Perl Documentation			      Net::Trac::TicketSearch(3pm)

NAME

       Net::Trac::TicketSearch - A ticket search (custom query) in Trac

SYNOPSIS

	   my $search = Net::Trac::TicketSearch->new( connection => $trac );

	   $search->query(
	       owner	   => 'hiro',
	       status	   => { 'not' => [qw(new reopened)] },
	       summary	   => { 'contains' => 'yatta!' },
	       reporter    => [qw( foo@example.com bar@example.com )]
	   );

	   print $_->id, "
" for @{$search->results};

DESCRIPTION

       This class allows you to run ticket searches on a remote Trac instance.

ACCESSORS

   connection
   limit [NUMBER]
       Get/set the maximum number of results to fetch.	Default is 500.  This may also be limited by the Trac instance itself.

   results
       Returns an arrayref of Net::Trac::Tickets for the current query.

   url
       Returns the relative URL for the current query (note the format will be CSV).

METHODS

   query [PARAMHASH]
       Performs a ticket search with the given search conditions.  Specify a hash of "column =" value> pairs for which to search.  Values may be a
       simple scalar, a hashref, or an arrayref.  Specifying a hashref allows you to select a different operator for comparison (see below for a
       list).  An arrayref allows multiple values to be or'd for the same column.  Unfortunately Trac has no way of anding multiple values for the
       same column.

       Valid operators are "is" (default), "not", "contains", "lacks", "startswith", and "endswith".

       Returns undef on error and the results otherwise.

LICENSE

       Copyright 2008-2009 Best Practical Solutions.

       This package is licensed under the same terms as Perl 5.8.8.

perl v5.12.3							    2009-05-27					      Net::Trac::TicketSearch(3pm)
Man Page