RT 5.0.3 Documentation

• • AddRecord
  • Limit { FIELD => undef, OPERATOR => '=', VALUE => 'undef'}
  • LimitName { OPERATOR => 'LIKE', VALUE => undef }
  • LimitSummary { OPERATOR => 'LIKE', VALUE => undef }
  • LimitToParent ID
  • LimitCustomField HASH
  • LimitRefersTo URI
  • LimitReferredToBy URI
  • LimitAppliedClasses Queue => QueueObj
  • SimpleSearch

AddRecord

Overrides the collection to ensure that only Articles the user can see are returned.

Limit { FIELD => undef, OPERATOR => '=', VALUE => 'undef'}

Limit the result set. See DBIx::SearchBuilder docs In addition to the "normal" stuff, value can be an array.

LimitName { OPERATOR => 'LIKE', VALUE => undef }

Find all articles with Name fields which satisfy OPERATOR for VALUE

LimitSummary { OPERATOR => 'LIKE', VALUE => undef }

Find all articles with summary fields which satisfy OPERATOR for VALUE

LimitToParent ID

Limit the returned set of articles to articles which are children of article ID. This does not recurse.

LimitCustomField HASH

Limit the result set to articles which have or do not have the custom field value listed, using a left join to catch things where no rows match.

HASH needs the following fields: FIELD (A custom field id) or undef for any custom field ENTRYAGGREGATOR => (AND, OR) OPERATOR ('=', 'LIKE', '!=', 'NOT LIKE') VALUE ( a single scalar value or a list of possible values to be concatenated with ENTRYAGGREGATOR)

The subclause that the LIMIT statement(s) should be done in can also be passed in with a SUBCLAUSE parameter.

LimitRefersTo URI

Limit the result set to only articles which are referred to by the URI passed in.

LimitReferredToBy URI

Limit the result set to only articles which are referred to by the URI passed in.

LimitAppliedClasses Queue => QueueObj

Takes a Queue and limits articles returned to classes which are applied to that Queue

Accepts either a Queue obj or a Queue id

SimpleSearch

Does a 'simple' search of Articles against a specified Term.

This Term is compared to a number of fields using various types of SQL comparison operators.

Ensures that the returned collection of Articles will have a value for Return.

This method is passed the following. You must specify a Term and a Return.

    Queue      - Limit the search to classes applied to this queue
    Fields     - Hashref of data - defaults to C<$ArticleSearchFields> emulate that if you want to override
    Term       - String that is in the fields specified by Fields
    Return     - What field on the Article you want to be sure isn't empty
    Max        - What to limit this collection to

← Back to index