Sha256: 3a08bf3df1c96445454de902af5fb4daa306bbe055a0d883eafc7a8cefda856e

Contents?: true

Size: 1.2 KB

Versions: 14

Compression:

Stored size: 1.2 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

14 entries across 14 versions & 1 rubygems

Version Path
simple-navigation-4.4.0 lib/simple_navigation/adapters/base.rb
simple-navigation-4.3.0 lib/simple_navigation/adapters/base.rb
simple-navigation-4.2.0 lib/simple_navigation/adapters/base.rb
simple-navigation-4.1.0 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.5 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.4 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.3 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.2 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.1 lib/simple_navigation/adapters/base.rb
simple-navigation-4.0.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.14.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.13.0 lib/simple_navigation/adapters/base.rb
simple-navigation-3.12.2 lib/simple_navigation/adapters/base.rb
simple-navigation-3.12.1 lib/simple_navigation/adapters/base.rb