Contents

# Defines the section interface. Include this module in all your sections.
#
# If you're creating your Section within the Skyline module (you probably shouldn't), it
# will automatically sets your models table name to `skyline_sections_#{base.table_name}`
#
# @example Usage: 
# 
# class Model < ActiveRecord::Base
#   include Skyline::Sections::Interface
# end
#
# @example Defines the following interface:
# 
# class Model < ActiveRecord::Base
#   has_one :section, :as => :sectionable, :class_name => "Skyline::Section" # The link back to the section
#   self.default_interface = true # defaults to true
#   
#   def to_text
#     ...
#   end
# end
# 
module Skyline::Sections::Interface
 
  def self.included(base)
    base.class_eval do
      set_table_name "skyline_sections_#{base.table_name}" if base.parents.include?(Skyline)
      has_one :section, :as => :sectionable, :class_name => "Skyline::Section"
    end
    base.send(:cattr_accessor, :default_interface)
    base.send(:default_interface=, true)
  end

  # The to_text method is needed for searching and other string operations which
  # just want the content of this section without any markup.
  # 
  # @return [String] The section's content flattened to only text
  # @abstract Implement in your own section
  def to_text
    ""
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
skylinecms-3.2.0	lib/skyline/sections/interface.rb
skylinecms-3.1.0	lib/skyline/sections/interface.rb
westarete-skylinecms-3.0.8.20100329	lib/skyline/sections/interface.rb
westarete-skylinecms-3.0.8.20100330	lib/skyline/sections/interface.rb