NAME

Reaction::UI::ViewPort::Collection::Role::Order - Order support for collections

DESCRIPTION

Role to add order support to collection viewports.

ATTRIBUTES

enable_order_by

Re-writable array reference. Optionally use this to manually specify a list of fields that support ordering, instead of the default of all fields. This is useful to exclude computed values or non-indexed columns from being sortable.

coerce_order_by

Re-writeable hash reference. Optionally use this to manually specify the way in which a field should be ordered. This is useful when the field name and the query to sort it differ. E.g. for a belongs_to item:

    coerce_order_by => { foo => ['foo.last_name', 'foo.first_name'] },

order_by

Re-writeable string. Optionally set it to dictate which field to use when sorting.

order_by_desc

Re-writeable boolean. Optionally use descending order when sorting. Defaults to false.

METHODS

can_order_by $field_name

Returns true if sorting by that field is supported, false otherwise.

AUTHORS

See Reaction::Class for authors.

LICENSE

See Reaction::Class for the license.