Module: Kaminari

Defined in:

lib/kaminari/engine.rb,
lib/kaminari.rb,
lib/kaminari/hooks.rb,
lib/kaminari/config.rb,
lib/kaminari/railtie.rb,
lib/kaminari/version.rb,
lib/kaminari/helpers/tags.rb,
lib/kaminari/helpers/paginator.rb,
lib/kaminari/models/array_extension.rb,
lib/kaminari/models/mongoid_extension.rb,
lib/kaminari/models/page_scope_methods.rb,
lib/generators/kaminari/views_generator.rb,
lib/generators/kaminari/config_generator.rb,
lib/kaminari/models/data_mapper_extension.rb,
lib/kaminari/models/configuration_methods.rb,
lib/kaminari/models/mongo_mapper_extension.rb,
lib/kaminari/helpers/action_view_extension.rb,
lib/kaminari/models/plucky_criteria_methods.rb,
lib/kaminari/models/active_record_extension.rb,
lib/kaminari/models/mongoid_criteria_methods.rb,
lib/kaminari/models/active_record_model_extension.rb,
lib/kaminari/models/data_mapper_collection_methods.rb,
lib/kaminari/models/active_record_relation_methods.rb

Overview

Defined Under Namespace

Modules: ActionViewExtension, ActiveRecordExtension, ActiveRecordModelExtension, ActiveRecordRelationMethods, ConfigurationMethods, DataMapperCollectionMethods, DataMapperExtension, Generators, Helpers, MongoMapperExtension, MongoidCriteriaMethods, MongoidExtension, PageScopeMethods, PluckyCriteriaMethods Classes: Configuration, Engine, Hooks, PaginatableArray, Railtie

Constant Summary

VERSION =

'0.14.1'

Class Method Summary (collapse)

• + (Object) config

  Global settings for Kaminari.

• + (Object) configure {|@config ||= Kaminari::Configuration.new| ... }

  Configures global settings for Kaminari.

• + (Object) paginate_array(array, options = {})

  Wrap an Array object to make it paginatable

  Options

  • :limit - limit

  • :offset - offset

  • :total_count - total_count.

13
14
15

# File 'lib/kaminari/config.rb', line 13

def self.config
  @config
end

Kaminari.configure do |config|
  config.default_per_page = 10
end

8
9
10

# File 'lib/kaminari/config.rb', line 8

def self.configure(&block)
  yield @config ||= Kaminari::Configuration.new
end

55
56
57

# File 'lib/kaminari/models/array_extension.rb', line 55

def self.paginate_array(array, options = {})
  PaginatableArray.new array, options
end