• NAME
• SYNOPSIS
• DESCRIPTION
• METHODS
  • LimitToQueue
  • LimitToGlobal
  • Next
  • Apply
  • Commit
  • Prepare
  • Prepared
  • _StashCurrentUser TicketObj => RT::Ticket
  • _RestoreCurrentUser TicketObj => RT::Ticket
  • _SetupSourceObjects { TicketObj , Ticket, Transaction, TransactionObj }
  • _FindScrips

NAME

  RT::Scrips - a collection of RT Scrip objects

SYNOPSIS

  use RT::Scrips;

DESCRIPTION

METHODS

LimitToQueue

Takes a queue id (numerical) as its only argument. Makes sure that Scopes it pulls out apply to this queue (or another that you've selected with another call to this method

LimitToGlobal

Makes sure that Scopes it pulls out apply to all queues (or another that you've selected with another call to this method or LimitToQueue

Next

Returns the next scrip that this user can see.

Apply

Run through the relevant scrips. Scrips will run in order based on description. (Most common use case is to prepend a number to the description, forcing the scrips to run in ascending alphanumerical order.)

Commit

Commit all of this object's prepared scrips

Prepare

Only prepare the scrips, returning an array of the scrips we're interested in in order of preparation, not execution

Prepared

Returns an arrayref of the scrips this object has prepared

_StashCurrentUser TicketObj => RT::Ticket

Saves aside the current user of the original ticket that was passed to these scrips. This is used to make sure that we don't accidentally leak the RT_System current user back to the calling code.

_RestoreCurrentUser TicketObj => RT::Ticket

Uses the current user saved by _StashCurrentUser to reset a Ticket object back to the caller's current user and avoid leaking an RT_System ticket to calling code.

_SetupSourceObjects { TicketObj , Ticket, Transaction, TransactionObj }

Setup a ticket and transaction for this Scrip collection to work with as it runs through the relevant scrips. (Also to figure out which scrips apply)

Returns: nothing

_FindScrips

Find only the apropriate scrips for whatever we're doing now. Order them by their description. (Most common use case is to prepend a number to the description, forcing the scrips to display and run in ascending alphanumerical order.)

← Back to index