Class SimpleNavigation::Adapters::Base
In: lib/simple_navigation/adapters/base.rb
Parent: Object

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.

Methods

Attributes

context  [R] 
request  [R] 

Public Class methods

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

[Source]

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

Public Instance methods

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

[Source]

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

Returns the context in which the config files will be evaluated

[Source]

# File lib/simple_navigation/adapters/base.rb, line 21
      def context_for_eval; end

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

[Source]

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

Returns a link with the specified name, url and options. Used for rendering.

[Source]

# File lib/simple_navigation/adapters/base.rb, line 29
      def link_to(name, url, options={}); end

Returns the path without query params

[Source]

# File lib/simple_navigation/adapters/base.rb, line 18
      def request_path; end

Returns the full path incl. query params

[Source]

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

[Validate]