/usr/share/doc/rt4-doc-html/RT/Scrips.html is in rt4-doc-html 4.2.12-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | <ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#LimitToQueue">LimitToQueue</a></li>
<li><a href="#LimitToGlobal">LimitToGlobal</a></li>
<li><a href="#LimitByTemplate">LimitByTemplate</a></li>
<li><a href="#AddRecord">AddRecord</a></li>
<li><a href="#Apply">Apply</a></li>
<li><a href="#Commit">Commit</a></li>
<li><a href="#Prepare">Prepare</a></li>
<li><a href="#Prepared">Prepared</a></li>
<li><a href="#SetupSourceObjects-TicketObj-Ticket-Transaction-TransactionObj">_SetupSourceObjects { TicketObj , Ticket, Transaction, TransactionObj }</a></li>
<li><a href="#FindScrips">_FindScrips</a></li>
</ul>
</li>
</ul>
<h1 id="NAME"><a href="#___top">NAME</a></h1>
<pre><code> RT::Scrips - a collection of RT Scrip objects</code></pre>
<h1 id="SYNOPSIS"><a href="#___top">SYNOPSIS</a></h1>
<pre><code> use RT::Scrips;</code></pre>
<h1 id="DESCRIPTION"><a href="#___top">DESCRIPTION</a></h1>
<h1 id="METHODS"><a href="#___top">METHODS</a></h1>
<h2 id="LimitToQueue"><a href="#___top">LimitToQueue</a></h2>
<p>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</p>
<h2 id="LimitToGlobal"><a href="#___top">LimitToGlobal</a></h2>
<p>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</p>
<h2 id="LimitByTemplate"><a href="#___top">LimitByTemplate</a></h2>
<p>Takes a <a href="../../../rt/latest/RT/Template.html">RT::Template</a> object and limits scrips to those that use the template.</p>
<h2 id="AddRecord"><a href="#___top">AddRecord</a></h2>
<p>Overrides the collection to ensure that only scrips the user can see are returned.</p>
<h2 id="Apply"><a href="#___top">Apply</a></h2>
<p>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.)</p>
<h2 id="Commit"><a href="#___top">Commit</a></h2>
<p>Commit all of this object's prepared scrips</p>
<h2 id="Prepare"><a href="#___top">Prepare</a></h2>
<p>Only prepare the scrips, returning an array of the scrips we're interested in in order of preparation, not execution</p>
<h2 id="Prepared"><a href="#___top">Prepared</a></h2>
<p>Returns an arrayref of the scrips this object has prepared</p>
<h2 id="SetupSourceObjects-TicketObj-Ticket-Transaction-TransactionObj"><a href="#___top">_SetupSourceObjects { TicketObj , Ticket, Transaction, TransactionObj }</a></h2>
<p>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)</p>
<p>Returns: nothing</p>
<h2 id="FindScrips"><a href="#___top">_FindScrips</a></h2>
<p>Find only the appropriate scrips for whatever we're doing now. Order them by the SortOrder field from the ObjectScrips table.</p>
<a href="./../">← Back to index</a>
|