class SimpleNavigation::Adapters::Base

This is the base class for all adapters. This class mainly exists for documenting reasons. It lists all the methods that an adapter should implement.

Attributes

context[R]
request[R]

Public Class Methods

register() click to toggle source

This method is usually called when the framework is initialized. It should call SimpleNavigation.set_env and install SimpleNavigation::Helpers where appropriate.

# File lib/simple_navigation/adapters/base.rb, line 12
def self.register; end

Public Instance Methods

content_tag(type, content, options={}) click to toggle source

Returns a tag of the specified type, content and options. Used for rendering.

# File lib/simple_navigation/adapters/base.rb, line 33
def content_tag(type, content, options={}); end
context_for_eval() click to toggle source

Returns the context in which the config files will be evaluated

# File lib/simple_navigation/adapters/base.rb, line 21
def context_for_eval; end
current_page?(url) click to toggle source

Returns true if the current request's url matches the specified url. Used to determine if an item should be autohighlighted.

# File lib/simple_navigation/adapters/base.rb, line 25
def current_page?(url); end
request_path() click to toggle source

Returns the path without query params

# File lib/simple_navigation/adapters/base.rb, line 18
def request_path; end
request_uri() click to toggle source

Returns the full path incl. query params

# File lib/simple_navigation/adapters/base.rb, line 15
def request_uri; end