Module: Cms::PageHelper

Includes:: DeprecatedBehavior

Defined in:: app/helpers/cms/page_helper.rb

Constant Summary collapse

PAGE_TOOLBAR_HEIGHT = Keep this taller until we reverse the iframes (so menus will work)

TOOLBAR_HEIGHT =

Instance Method Summary collapse

#able_to?(*perms, &block) ⇒ Boolean
Determines if the current_user is able to do specific permissions.
#cms_content_editor ⇒ String
Return the JS file to load the configured default WYSIWYG editor.
#container(name) ⇒ String
Outputs the content of a particular container.
#container_has_block?(name, &block) ⇒ Boolean
Determine if a given container has any blocks within it.
#current_page ⇒ Object
#edit_mode? ⇒ Boolean
Determines whether this page is in edit mode or not.
#page_header ⇒ Object
Returns the Page title in an In Context editable area.
#page_title(*args) ⇒ String
Outputs the title for this page.
#render_breadcrumbs(options = {}) ⇒ Object
Renders breadcrumbs based on the current_page.
#render_portlet(name) ⇒ Object
#use_page_title(title) ⇒ Object
Allows Views to set what will be displayed as the element for Page Templates (and Cms admin pages.).</div> </li> </ul> <h3 class="inherited">Methods included from <a href="/gems/browsercms-artirix/Cms/DeprecatedBehavior" title="Cms::DeprecatedBehavior (module)">DeprecatedBehavior</a></h3> <a href="/gems/browsercms-artirix/Cms/DeprecatedBehavior#cms_toolbar-instance_method" title="Cms::DeprecatedBehavior#cms_toolbar (method)">#cms_toolbar</a>, <a href="/gems/browsercms-artirix/Cms/DeprecatedBehavior#deprecated_set_page_title_usage-instance_method" title="Cms::DeprecatedBehavior#deprecated_set_page_title_usage (method)">#deprecated_set_page_title_usage</a> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="able_to?-instance_method"> #able_to?(*perms, &block) ⇒ <tt>Boolean</tt> </h3><script> document.getElementById("able_to?-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:able_to%3F">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Determines if the current_user is able to do specific permissions. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 159 160 161 162</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 159 def able_to?(*perms, &block) block.call if current_user.able_to?(*perms) return '' end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="cms_content_editor-instance_method"> #cms_content_editor ⇒ <tt>String</tt> </h3><script> document.getElementById("cms_content_editor-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:cms_content_editor">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> 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. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>Names of the JS file needed to load the editor.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 30 31 32</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 30 def cms_content_editor "bcms/#{<a href="/gems/browsercms-artirix/Cms" title="Cms (module)">Cms</a>.<a href="/gems/browsercms-artirix/Cms#content_editor-class_method" title="Cms.content_editor (method)">content_editor</a>}" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="container-instance_method"> #container(name) ⇒ <tt>String</tt> </h3><script> document.getElementById("container-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:container">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Outputs the content of a particular container. If the user is in 'edit' mode the container and block controls will be rendered. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The HTML content for the container.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 81 82 83 84 85 86 87 88</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 81 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="container_has_block?-instance_method"> #container_has_block?(name, &block) ⇒ <tt>Boolean</tt> </h3><script> document.getElementById("container_has_block?-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:container_has_block%3F">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> 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 %> </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> name (<tt>Symbol</tt>) — <div class='inline'>The name of the container to check</div> </li> <li> block (<tt>Proc</tt>) </li> </ul> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>True if the container has one or more blocks, or if we are in edit mode. False otherwise.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 102 103 104 105 106 107 108 109 110</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 102 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="current_page-instance_method"> #current_page ⇒ <tt>Object</tt> </h3><script> document.getElementById("current_page-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:current_page">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 73 74 75</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 73 def current_page @page end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="edit_mode?-instance_method"> #edit_mode? ⇒ <tt>Boolean</tt> </h3><script> document.getElementById("edit_mode?-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:edit_mode%3F">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Determines whether this page is in edit mode or not. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 165 166 167</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 165 def edit_mode?() @mode == "edit" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="page_header-instance_method"> #page_header ⇒ <tt>Object</tt> </h3><script> document.getElementById("page_header-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:page_header">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns the Page title in an In Context editable area. Use for h1/h2 elements. Use page_title for title elements. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 56 57 58 59 60 61 62 63</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 56 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="page_title-instance_method"> #page_title(*args) ⇒ <tt>String</tt> </h3><script> document.getElementById("page_title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:page_title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> 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. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> If (<tt>String</tt>) — <div class='inline'>provided, this is the name of the page to set. (This usage is deprecated in 4.0 and will be removed in 4.1)</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>String</tt>) — <div class='inline'>The title of the page.</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 39 40 41 42 43 44 45 46 47 48 49 50 51</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 39 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="render_breadcrumbs-instance_method"> #render_breadcrumbs(options = {}) ⇒ <tt>Object</tt> </h3><script> document.getElementById("render_breadcrumbs-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:render_breadcrumbs">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> 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. <h4 id="Params_">Params:</h4> <pre class="code ruby"><code class="ruby">options = A hash of options which determine how the breadcrumbs will be laid out. </code></pre> <h4 id="Options_">Options:</h4> <ul> <li><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.</li> <li><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').</li> </ul> </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 128 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="render_portlet-instance_method"> #render_portlet(name) ⇒ <tt>Object</tt> </h3><script> document.getElementById("render_portlet-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:render_portlet">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 147 148 149 150 151 152 153 154 155 156</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 147 def render_portlet(name) portlets = <a href="/gems/browsercms-artirix/Cms/Portlet" title="Cms::Portlet (class)">Portlet</a>.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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="use_page_title-instance_method"> #use_page_title(title) ⇒ <tt>Object</tt> </h3><script> document.getElementById("use_page_title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/browsercms-artirix/Cms%2FPageHelper:use_page_title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Allows Views to set what will be displayed as the <title> element for Page Templates (and Cms admin pages.) </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 67 68 69 70 71</pre> </td> <td> <pre class="code"># File 'app/helpers/cms/page_helper.rb', line 67 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</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Thu Sep 17 08:12:39 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.7). </div> </div> </body> </html>