Class: Kadmin::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/kadmin/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration



16
17
18
19
20
21
 
# File 'lib/kadmin/configuration.rb', line 16

def initialize
  @mount_path = '/admin'
  @logger = Rails.logger
  @navbar_items = []
  @handle_errors = false
end

Instance Attribute Details

#handle_errors ⇒ Boolean

Returns if true, any Kadmin::ApplicationController will catch errors and display a custom page

Returns:

  • (Boolean) —

    if true, any Kadmin::ApplicationController will catch errors and display a custom page



14
15
16
 
# File 'lib/kadmin/configuration.rb', line 14

def handle_errors
  @handle_errors
end

#logger ⇒ Logger

Returns An instance of a Ruby compatible logger

Returns:

  • (Logger) —

    An instance of a Ruby compatible logger



5
6
7
 
# File 'lib/kadmin/configuration.rb', line 5

def logger
  @logger
end

#mount_path ⇒ String

Returns the path the engine is mounted at (used for authentication routes)

Returns:

  • (String) —

    the path the engine is mounted at (used for authentication routes)



8
9
10
 
# File 'lib/kadmin/configuration.rb', line 8

def mount_path
  @mount_path
end

#navbar_items ⇒ Array<Kadmin::Navbar::Section, Kadmin::Navbar::Link>

Returns list of admin links or sections

Returns:



11
12
13
 
# File 'lib/kadmin/configuration.rb', line 11

def navbar_items
  @navbar_items
end

Instance Method Details

#add_navbar_items(*items) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/kadmin/configuration.rb', line 23

def add_navbar_items(*items)
  items.each do |item|
    index = @navbar_items.bsearch_index { |navbar_item| navbar_item.text >= item.text }
    @navbar_items.insert(index || @navbar_items.size, item)
  end
end