class Marten::Handlers::RecordList

• Marten::Handlers::RecordList
• Marten::Handlers::Template
• Marten::Handlers::Base
• Reference
• Object

Overview

Handler allowing to list model records.

This base handler can be used to easily expose a list of model records:

class MyHandler < Marten::Handlers::RecordList
  template_name "my_template"
  model Post
end

Optionally, it is possible to configure that records should be paginated:

class MyHandler < Marten::Handlers::RecordList
  template_name "my_template"
  model Post
  page_size 12
end

When records are paginated, a Marten::DB::Query::Page will be exposed in the template context (instead of the raw query set).

Included Modules

• Marten::Handlers::RecordListing

Extended Modules

• Marten::Handlers::RecordListing::ClassMethods

Defined in:

Class Method Summary

• .list_context_name(name : String | Symbol)

  Allows to configure the name to use to include the list of records into the template context.

• .list_context_name : String

  Returns the name to use to include the record list into the template context (defaults to records).

• .ordering : Array(String) | Nil

  Returns the array of fields to use to order the records.

• .page_number_param : String

  Returns the name of the page number parameter.

• .page_size : Int32 | Nil

  Returns the page size to use if records should be paginated.

Class Method Detail