NAME

RT::URI::transaction - Internal URIs for linking to an RT::Transaction

DESCRIPTION

This class should rarely be used directly, but via RT::URI instead.

Represents, parses, and generates internal RT URIs such as:

    transaction:42
    transaction://example.com/42

These URIs are used to link directly to a transaction within RT, for example when recording links in ticket history.

METHODS

Much of the interface below is dictated by RT::URI and RT::URI::base.

Scheme

Return the URI scheme for transactions

LocalURIPrefix

Returns the site-specific prefix for a local transaction URI

IsLocal

Returns a true value, the transaction ID, if this object represents a local transaction, undef otherwise.

URIForObject RT::Transaction

Returns the URI for a local RT::Transaction object

ParseURI URI

Primarily used by RT::URI to set internal state.

Figures out from a transaction: URI whether it refers to a local transaction and the transaction ID.

Returns the transaction ID if local, otherwise returns false. A transaction on an object type "HREF" can't build a URL for also returns false, so link creation fails with a resolve error, the same way a nonexistent id does, instead of storing a link whose href goes nowhere.

Object

Returns the object for this URI, if it's local. Otherwise returns undef.

HREF

For a local transaction, return an HTTP URL that lands on it, anchored at the transaction in its object's history (...#txn-NN); which page depends on the object type, see below. Otherwise return the URI unchanged.

ParseURI only accepts the object types handled here, so a stored transaction link always resolves to one of them.

AsString

Returns a description of this object

← Back to index