Sha256: fb43015f382e54efd7a15e53c7fcf5444563fdf5d26aca90babbf8a62f6b734e

Contents?: true

Size: 1.24 KB

Versions: 30

Compression:

Stored size: 1.24 KB

Contents

module SimpleNavigation
  module Adapters
    
    # 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.
    #
    class Base
      attr_reader :context, :request
      
      # This method is usually called when the framework is initialized. 
      # It should call SimpleNavigation.set_env and install SimpleNavigation::Helpers where appropriate.
      def self.register; end
      
      # Returns the full path incl. query params
      def request_uri; end
      
      # Returns the path without query params
      def request_path; end
      
      # Returns the context in which the config files will be evaluated
      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.
      def current_page?(url); end
      
      # Returns a link with the specified name, url and options.
      # Used for rendering.
      def link_to(name, url, options={}); end
      
      # Returns a tag of the specified type, content and options.
      # Used for rendering.
      def content_tag(type, content, options={}); end
      
    end
  end
end

Version data entries

30 entries across 30 versions & 3 rubygems

Version Path
simple-navigation-3.12.0 lib/simple_navigation/adapters/base.rb
jordanyeo-simple-navigation-3.11.1 lib/simple_navigation/adapters/base.rb
jordanyeo-simple-navigation-3.11.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.11.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.10.1 lib/simple_navigation/adapters/base.rb
simple-navigation-3.10.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.9.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.8.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.7.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.6.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.5.1 lib/simple_navigation/adapters/base.rb
simple-navigation-3.5.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.4.2 lib/simple_navigation/adapters/base.rb
simple-navigation-3.4.1 lib/simple_navigation/adapters/base.rb
simple-navigation-3.4.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.3.4 lib/simple_navigation/adapters/base.rb
simple-navigation-3.3.3 lib/simple_navigation/adapters/base.rb
simple-navigation-3.3.2 lib/simple_navigation/adapters/base.rb
simple-navigation-3.3.1 lib/simple_navigation/adapters/base.rb
simple-navigation-3.3.0 lib/simple_navigation/adapters/base.rb