RT::Tickets - A collection of Ticket objects
use RT::Tickets;
my $tickets = RT::Tickets->new($CurrentUser);
A collection of RT::Tickets.
Returns the list of fields that lists of tickets can easily be sorted by
These routines are the targets of a dispatch table depending on the type of field. They all share the same signature:
my ($self,$field,$op,$value,@rest) = @_;
The values in @rest should be suitable for passing directly to DBIx::SearchBuilder::Limit.
Essentially they are an expanded/broken out (and much simplified) version of what ProcessRestrictions used to do. They're also much more clearly delineated by the TYPE of field being processed.
Handle ID field.
Handle Fields which are limited to certain values, and potentially need to be looked up from another class.
This subroutine actually handles two different kinds of fields. For some the user is responsible for limiting the values. (i.e. Status, Type).
For others, the value specified by the user will be looked by via specified class.
Meta Data: name of class to lookup in (Optional)
Handle fields where the values are limited to integers. (For example, Priority, TimeWorked.)
Meta Data: None
Handle fields which deal with links between tickets. (MemberOf, DependsOn)
Meta Data: 1: Direction (From, To) 2: Link Type (MemberOf, DependsOn, RefersTo)
Handle date fields. (Created, LastTold..)
Meta Data: 1: type of link. (Probably not necessary.)
Handle simple fields which are just strings. (Subject,Type)
Meta Data: None
Handle Queue field supporting both "is" and "match".
Input should be a queue name or a partial string.
Handle fields limiting based on Transaction Date.
The input value must be in a format parse-able by Time::ParseDate
Meta Data: None
Limit based on the ContentType or the Filename of a transaction.
Limit based on the Content of a transaction.
Try and turn a custom role descriptor (e.g. CustomRole.{Engineer}
) into (role, column, original name).
Handle watcher limits. (Requestor, CC, etc..)
Meta Data: 1: Field to query on
Handle watcher membership limits, i.e. whether the watcher belongs to a specific group or not.
Meta Data: 1: Role to query on
Try and turn a CF descriptor into (cfid, cfname) object pair.
Takes an optional second parameter of the CF LookupType, defaults to Ticket CFs.
Limit based on CustomFields
Meta Data: none
A modified version of the OrderBy method which automatically joins where ALIAS
is set to the name of a watcher type.
Takes a paramhash with the fields FIELD, OPERATOR, VALUE and DESCRIPTION Generally best called from LimitFoo methods
LimitQueue takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. (It defaults to =). VALUE is a queue id or Name.
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a status.
RT adds Status != 'deleted' until object has allow_deleted_search internal property set. $tickets->{'allow_deleted_search'} = 1; $tickets->LimitStatus( VALUE => 'deleted' );
Limits the status to "ActiveStatusArray" in RT::Queue
TODO: make this respect lifecycles for the queues associated with the search
Limits the status to "InactiveStatusArray" in RT::Queue
TODO: make this respect lifecycles for the queues associated with the search
If called, this search will not automatically limit the set of results found to tickets of type "Ticket". Tickets of other types, such as "project" and "approval" will be found.
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=, it defaults to "=". VALUE is a string to search for in the type of the ticket.
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a string to search for in the subject of the ticket.
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a ticket Id to search for
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's priority against
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's initial priority against
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's final priority against
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's TimeWorked attribute
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, >, < or !=. VALUE is a value to match the ticket's TimeLeft attribute
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, LIKE, NOT LIKE or !=. VALUE is a string to search for in the body of the ticket
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, LIKE, NOT LIKE or !=. VALUE is a string to search for in the body of the ticket
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of =, LIKE, NOT LIKE or !=. VALUE is a content type to search ticket attachments for
Takes a paramhash with the fields OPERATOR and VALUE. OPERATOR is one of = or !=. VALUE is a user id.
Takes a paramhash with the fields OPERATOR, TYPE and VALUE.
OPERATOR is one of =, LIKE, NOT LIKE or !=.
VALUE is a value to match the ticket's watcher email addresses against
TYPE is the sort of watchers you want to match against. Leave it undef if you want to search all of them
LimitLinkedTo takes a paramhash with two fields: TYPE and TARGET TYPE limits the sort of link we want to search on
TYPE = { RefersTo, MemberOf, DependsOn }
TARGET is the id or URI of the TARGET of the link
LimitLinkedFrom takes a paramhash with two fields: TYPE and BASE TYPE limits the sort of link we want to search on
BASE is the id or URI of the BASE of the link
Takes a paramhash with the fields FIELD OPERATOR and VALUE.
OPERATOR is one of > or < VALUE is a date and time in ISO format in GMT FIELD is one of Starts, Started, Told, Created, Resolved, LastUpdated
There are also helper functions of the form LimitFIELD that eliminate the need to pass in a FIELD argument.
Takes a paramhash with the fields FIELD OPERATOR and VALUE.
OPERATOR is one of > or < VALUE is a date and time in ISO format in GMT
Takes a paramhash of key/value pairs with the following keys:
Keep track of the counter for the array of restrictions
Returns a reference to the set of all items found in this search
Removes all restrictions irretrievably
Build up a "ItemMap" of first/last/next/prev items, so that we can display search nav quickly.
Returns an a map of all items found by this search. The map is a hash of the form:
{
first => <first ticket id found>,
last => <last ticket id found or undef>,
<ticket id> => {
prev => <the ticket id found before>,
next => <the ticket id found after>,
},
<ticket id> => {
prev => ...,
next => ...,
},
}
You don't want to serialize a big tickets object, as the {items} hash will be instantly invalid _and_ eat lots of space
RT::Tickets supports several flags which alter search behavior:
allow_deleted_search (Otherwise never show deleted tickets in search results)
These flags are set by calling
$tickets->{'flagname'} = 1;
BUG: There should be an API for this
Convert a RT-SQL string into a set of SearchBuilder restrictions.
Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
Returns the last string passed to "FromSQL".
← Back to index