module Alchemy class PageLayout def self.included(base) get_layouts end def self.element_names_for(page_layout) layout_description = get(page_layout) if layout_description.blank? puts "\n+++ Warning: No Layout Description for #{page_layout} found! in page_layouts.yml\n" return [] else layout_description["elements"] end end # Returns the page_layout.yml file. Tries to first load from config/alchemy and if not found from vendor/plugins/alchemy/config/alchemy. def self.get_layouts @@definitions ||= read_layouts_file end # Add additional pagelayout definitions. I.E. from your module. # Call +Alchemy::PageLayout.add(your_layout_definition)+ in your engine.rb file. # You can pass a single layout definition as Hash, or a collection of pagelayouts as Array. # Example Pagelayout definitions can be found in the +page_layouts.yml+ from the standard set. def self.add(page_layout) get_layouts if page_layout.is_a?(Array) @@definitions += page_layout elsif page_layout.is_a?(Hash) @@definitions << page_layout else raise TypeError end end # Returns the page_layout description found by name in page_layouts.yml def self.get(name) return {} if name.blank? get_layouts.detect { |a| a["name"].downcase == name.downcase } end def self.get_all_by_attributes(attributes) return [] if attributes.blank? if attributes.class.name == 'Hash' layouts = [] attributes.stringify_keys.each do |key, value| result = get_layouts.select { |a| a[key].to_s.downcase == value.to_s.downcase if a.has_key?(key) } layouts += result unless result.empty? end return layouts else return [] end end # Returns page layouts ready for Rails' select form helper. def self.get_layouts_for_select(language_id, layoutpage = false) layouts_for_select = [[Alchemy::I18n.t("Please choose"), ""]] selectable_layouts(language_id, layoutpage).each do |layout| display_name = Alchemy::I18n.t("page_layout_names.#{layout['name']}", :default => layout['name'].camelize) layouts_for_select << [display_name, layout["name"]] end layouts_for_select end def self.selectable_layouts(language_id, layoutpage = false) get_layouts.select do |layout| next if layout["hide"] used = layout["unique"] && has_a_page_this_layout?(layout["name"], language_id) if layoutpage layout["layoutpage"] == true && !used else layout["layoutpage"] != true && !used end end end def self.has_a_page_this_layout?(layout, language_id) Page.where({:page_layout => layout, :language_id => language_id}).any? end # Reads the layout definitions from +config/alchemy/page_layouts.yml+. def self.read_layouts_file if File.exists? "#{Rails.root}/config/alchemy/page_layouts.yml" layouts = YAML.load_file "#{Rails.root}/config/alchemy/page_layouts.yml" else raise LoadError, "Could not find page_layouts.yml file! Please run: rails generate alchemy:scaffold" end # Since YAML returns false for an empty file, we have to normalize it here. layouts || [] end end end