app/helpers/cms/page_helper.rb
module Cms
# Deprecated in 4.0. Remove in 4.1
module DeprecatedBehavior
# Add the code to render the CMS toolbar.
# @deprecated This method is no longer required for BrowserCMS templates.
def cms_toolbar
ActiveSupport::Deprecation.warn "The cms_toolbar helper is deprecated and no longer necessary. You can safely remove <%= cms_toolbar %> from templates.", caller
return ""
end
def deprecated_set_page_title_usage(args)
ActiveSupport::Deprecation.warn "Calling page_title('#{args.first}') is deprecated and will be remove in 4.1. Call use_page_title('#{args.first}') instead.", caller
use_page_title args.first
end
end
module PageHelper
include Cms::DeprecatedBehavior
# Keep this taller until we reverse the iframes (so menus will work)
PAGE_TOOLBAR_HEIGHT = 159
TOOLBAR_HEIGHT = 100
# Return the JS file to load the configured default WYSIWYG editor
#
# Ideally, this could be improved if sprockets allows for dynamically determining which js library to use.
# @return [String] Names of the JS file needed to load the editor.
def cms_content_editor
"bcms/#{Cms.content_editor}"
end
# Outputs the title for this page. Used by both internal CMS pages, as well as page templates. Call use_page_title to
# change this value.
#
# @param [String] If provided, this is the name of the page to set. (This usage is deprecated in 4.0 and will be removed in 4.1)
# @return [String] The title of the page.
def page_title(*args)
if args.first
deprecated_set_page_title_usage(args)
else
if @page_title
@page_title
elsif current_page
current_page.page_title
else
"Untitled"
end
end
end
# Returns the Page title in an In Context editable area.
#
# Use for h1/h2 elements. Use page_title for title elements.
def page_header()
if (is_current_user_able_to_edit_this_content?(current_page))
options = {id: 'page_title', contenteditable: true, data: {attribute: "title", content_name: "page", id: current_page.id, page_id: current_page.id}}
content_tag "div", page_title, options
else
page_title
end
end
# Allows Views to set what will be displayed as the <title> element for Page Templates (and Cms admin pages.)
#
def use_page_title(title)
# Implementation note: This method is named use_page_title rather than page_title= because ruby will create a
# local variable if you call <%= page_title = "A New Page Name" %>
@page_title = title
end
def current_page
@page
end
# Outputs the content of a particular container. If the user is in 'edit' mode the container and block controls will
# be rendered.
#
# @return [String] The HTML content for the container.
def container(name)
content = content_for(name)
if is_current_user_able_to_edit_this_content?(@page)
render :partial => 'cms/pages/simple_container', :locals => {:name => name, :content => content, :container => name}
else
content
end
end
# Determine if a given container has any blocks within it. Useful for determine if markup should be conditionally included
# when a block is present, but not shown if no block was added. For example:
#
# <% unless container_has_block? :sidebar %>
# <div id="sidebar">
# <%= container :sidebar %>
# </div>
# <% end %>
#
# @param [Symbol] name The name of the container to check
# @param [Proc] block
# @return [Boolean] True if the container has one or more blocks, or if we are in edit mode. False otherwise.
def container_has_block?(name, &block)
has_block = (edit_mode?) || current_page.connectable_count_for_container(name) > 0
logger.info "mode = #{@mode}, has_block = #{has_block}"
if block_given?
concat(capture(&block)) if has_block
else
has_block
end
end
# Renders breadcrumbs based on the current_page. This will generate an unordered list representing the
# current page and all it's ancestors including the root name of of the site. The UL can be styled via CSS for
# layout purposes. Each breadcrumb except the last will be linked to the page in question.
#
# If the current_page is nil, it will return an empty string.
#
# ==== Params:
# options = A hash of options which determine how the breadcrumbs will be laid out.
#
# ==== Options:
# * <tt>:from_top</tt> - How many below levels from the root the tree should start at.
# All sections at this level will be shown. The default is 0, which means show all
# nodes that are direct children of the root.
# * <tt>:show_parent</tt> - Determines if the name of the page itself show be shown as a breadcrumb link. Defaults to false, meaning
# that the parent section of the current page will be the 'last' breadcrumb link. (Note: This probably better renamed as 'show_page').
#
def render_breadcrumbs(options={})
return "" unless current_page
start = options[:from_top] || 0
show_parent = options[:show_parent].nil? ? false : options[:show_parent]
ancestors = current_page.ancestors
items = []
ancestors[start..ancestors.size].each_with_index do |sec, i|
items << content_tag(:li,
link_to(sec.name, sec.actual_path), (i == 0 ? {:class => "first"} : {}))
end
if !show_parent && current_page.landing_page?
items[items.size-1] = content_tag(:li, current_page.parent.name)
else
items << content_tag(:li, current_page.page_title)
end
content_tag(:ul, "\n #{items.join("\n ")}\n".html_safe, :class => "breadcrumbs")
end
def render_portlet(name)
portlets = Portlet.all(:conditions => ["name = ?", name.to_s])
if portlets.size > 1
edit_mode? ? "ERROR: Multiple Portlets with name '#{name}'" : nil
elsif portlets.empty?
edit_mode? ? "ERROR: No Portlet with name '#{name}'" : nil
else
render_connectable(portlets.first)
end
end
# Determines if the current_user is able to do specific permissions.
def able_to?(*perms, &block)
block.call if current_user.able_to?(*perms)
return ''
end
# Determines whether this page is in edit mode or not.
def edit_mode?()
@mode == "edit"
end
end
end