Module: Ramaze::Helper::Paginate

### Home Classes Methods

### In Files

- lib/ramaze/helper/paginate.rb

### Namespace

- CLASS Ramaze::Helper::Paginate::Paginator

### Methods

- #paginate

### Included Modules

- Traited

### Files

- Gemfile
- Rakefile

### Class/Module Index

Quicksearch

- Ramaze
- Ramaze::App
- Ramaze::Bin
- Ramaze::Bin::Create
- Ramaze::Bin::Runner
- Ramaze::Cache
- Ramaze::Cache::LRU
- Ramaze::Cache::LocalMemCache
- Ramaze::Cache::MemCache
- Ramaze::Cache::Redis
- Ramaze::Cache::Sequel
- Ramaze::Controller
- Ramaze::CoreExtensions
- Ramaze::CoreExtensions::Object
- Ramaze::CoreExtensions::String
- Ramaze::Current
- Ramaze::DefaultController
- Ramaze::Files
- Ramaze::Gestalt
- Ramaze::Helper
- Ramaze::Helper::Auth
- Ramaze::Helper::Bench
- Ramaze::Helper::BlueForm
- Ramaze::Helper::BlueForm::Form
- Ramaze::Helper::CSRF
- Ramaze::Helper::Cache
- Ramaze::Helper::Cache::SingletonMethods
- Ramaze::Helper::Email
- Ramaze::Helper::Erector
- Ramaze::Helper::Flash
- Ramaze::Helper::Formatting
- Ramaze::Helper::Gestalt
- Ramaze::Helper::Gravatar
- Ramaze::Helper::Identity
- Ramaze::Helper::Layout
- Ramaze::Helper::Layout::SingletonMethods
- Ramaze::Helper::Link
- Ramaze::Helper::Localize
- Ramaze::Helper::Localize::Dictionary
- Ramaze::Helper::Localize::Parser
- Ramaze::Helper::Markaby
- Ramaze::Helper::Maruku
- Ramaze::Helper::Paginate
- Ramaze::Helper::Paginate::Paginator
- Ramaze::Helper::Paginate::Paginator::ArrayPager
- Ramaze::Helper::Paginate::Paginator::DataMapperPager
- Ramaze::Helper::Remarkably
- Ramaze::Helper::RequestAccessor
- Ramaze::Helper::SendFile
- Ramaze::Helper::SimpleCaptcha
- Ramaze::Helper::Stack
- Ramaze::Helper::Thread
- Ramaze::Helper::Upload
- Ramaze::Helper::Upload::ClassMethods
- Ramaze::Helper::Upload::UploadedFile
- Ramaze::Helper::UserHelper
- Ramaze::Helper::UserHelper::Wrapper
- Ramaze::Helper::XHTML
- Ramaze::LRUHash
- Ramaze::Logger
- Ramaze::Logger::Informer
- Ramaze::Logger::LogHub
- Ramaze::Logger::Logger
- Ramaze::Logger::RotatingInformer
- Ramaze::Logger::Syslog
- Ramaze::Logging
- Ramaze::Reloader
- Ramaze::Reloader::Hooks
- Ramaze::Reloader::WatchInotify
- Ramaze::Reloader::WatchStat
- Ramaze::Request
- Ramaze::Response
- Ramaze::SpecLogger
- Ramaze::View
- Ramaze::View::Erector
- Ramaze::View::Erubis
- Ramaze::View::Ezamar
- Ramaze::View::Gestalt
- Ramaze::View::Haml
- Ramaze::View::Liquid
- Ramaze::View::Liquid::Tag
- Ramaze::View::Lokar
- Ramaze::View::Mustache
- Ramaze::View::Mustache::RamazeContext
- Ramaze::View::Nagoro
- Ramaze::View::Remarkably
- Ramaze::View::Sass
- Ramaze::View::Slippers
- Ramaze::View::Tagz
- Ramaze::View::Tagz::Methods
- Ramaze::View::Tenjin
- Innate
- Innate::View
- Innate::View::Slim
- Nagoro
- Nagoro::Pipe
- Nagoro::Pipe::RenderPartial
- Bacon
- Bacon::PrettyOutput
- Erector
- Erector::Widget
- Rack
- Rack::RouteExceptions
- Tenjin
- Tenjin::Template
- BlankSlate
- Controller
- MainController
- Object

No matching classes.

# Ramaze::Helper::Paginate

Helper for pagination and pagination-navigation.

See {Ramaze::Helper::Paginate#paginate} for more information.

### Public Instance Methods

paginate(dataset, options = {}) click to toggle source

Returns a new Paginator instance.

Note that the pagination relies on being inside a Ramaze request to gain necessary metadata about the page it resides on, you cannot use it outside of Ramaze yet.

The examples below are meant to be used within your controller or view.

Usage with Array:

    data = (1..100).to_a
    @pager = paginate(data, :limit => 30, :page => 2)
    @pager.navigation
    @pager.each{|e| puts(e) }

Usage with Sequel:

    data = Article.filter(:public => true)
    @pager = paginate(data, :limit => 5)
    @pager.navigation
    @pager.each{|e| puts(e)

Note that you must first extend Sequel with the pagination extension"

    Sequel.extension :pagination

Customizing the classes to use for the various HTML elements of the page list can be done by passing a key ":css" to the list of options. In this hash you can set the following keys:

- first, defaults to "first"

- prev, defaults to "prev"

- next, defaults to "next"

- last, defaults to "last"

- current, defaults to "current"

- number, empty by default

- disabled, defaults to "grey"

These options can also be specified globally in the trait ":paginate" as following:

    class Posts < Ramaze::Controller
      map '/'

      trait :paginate => {
        :limit => 10,
        :var   => 'page',
        :css   => {
          :first => 'first_item',
          :prev  => 'prev_item',
          # and so on.
        }
      }
    end

@param [Sequel::Dataset|Array] dataset May be a Sequel dataset or an

    Array

@param [Hash] options A hash containing custom options that takes

    precedence to ``trait[:paginate].

@option options [Fixnum] :limit The number of elements used when you

    call #each on the paginator

@option options [String] :var The variable name being used in the

    request, this is helpful if you want to use two or more independent
    paginations on the same page.

@option options [Fixnum] :page The page you are currently on, if not

    given it will be retrieved from current request variables. Defaults to
    1 if neither exists.

@option options [Hash] :css A hash containing various options that can

    be used to customize the HTML classes to use for the various page
    links.

    # File lib/ramaze/helper/paginate.rb, line 100
    def paginate(dataset, options = {})
      options = ancestral_trait[:paginate].merge(options)
      limit = options[:limit]
      var   = options[:var]
      page  = options[:page] || (request[var] || 1).to_i
      opts = {}
      opts.merge!({:css => options[:css]}) if options[:css]
      Paginator.new(dataset, page, limit, var, opts)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.