Class: DcMenuRenderer
- Inherits:
-
Object
- Object
- DcMenuRenderer
- Includes:
- CmsCommonHelper, DcApplicationHelper
- Defined in:
- app/renderers/dc_menu_renderer.rb
Overview
Default menu renderer for dc_menus collection. Renderer produces output for rendering menu with (theoretically) infinite level of sub menus. In practice reasonable maximum level of 4 is advised.
Example (as used in design):
dc_render(:dc_menu, name: 'my_menu')
# when :name option is ommited it will use site document's menu_name field
dc_render(:dc_menu)
Instance Attribute Summary
Attributes included from DcApplicationHelper
#design, #form, #ids, #json_ld, #menu, #menu_item, #options, #page, #page_title, #part, #parts, #record, #record_footer, #site, #tables
Instance Method Summary collapse
-
#default ⇒ Object
Creates default menu.
-
#do_menu_level(menu, options = {}) ⇒ Object
Creates HTML code required for submenu on single level.
-
#find_selected ⇒ Object
Return selected topmenu level.
-
#initialize(parent, opts) ⇒ DcMenuRenderer
constructor
Object initialization.
-
#link_4edit(opts) ⇒ Object
Creates edit link if in edit mode.
-
#link_4menu(item) ⇒ Object
Returns html code required for creating one link in a menu.
-
#render_css ⇒ Object
Return CSS part of code.
-
#render_html ⇒ Object
Renderer dispatcher.
Methods included from CmsCommonHelper
#dc_choices4_field, #dc_choices_for_field, dc_choices_for_field, #dc_date_time, #dc_format_date_time, dc_format_date_time, #dc_format_number, dc_format_number, #dc_help_body, #dc_help_button, #dc_help_fields, #dc_help_for_tab, #dc_icon4_boolean, #dc_icon_for_boolean, #dc_name4_id, #dc_name4_value, #dc_name_for_id, #dc_name_for_value, dc_name_for_value, #dc_steps_menu_get, #t, t, #t_label_for_column, #t_label_for_field, #t_tablename
Methods included from DcApplicationHelper
#_origin, #dc_add2_record_cookie, #dc_add_json_ld, #dc_add_meta_tag, #dc_big_table, #dc_choices4, #dc_choices4_all_collections, #dc_choices4_folders_list, #dc_choices4_menu, #dc_choices4_site_policies, #dc_cms_menu, #dc_deprecate, #dc_document_path, #dc_dont?, #dc_edit_mode?, #dc_edit_title, #dc_error_messages_for, #dc_flash_messages, #dc_get_json_ld, #dc_get_seo_meta_tags, #dc_get_site, #dc_icon_for_link, #dc_iframe_edit, #dc_img_alt, #dc_img_alt_tag, #dc_internal_var, #dc_limit_string, #dc_link_for_create, #dc_link_for_edit, #dc_link_for_edit1, #dc_link_menu_tag, #dc_link_to, #dc_menu_class, #dc_new_title, #dc_page_bottom, #dc_page_class, #dc_page_edit_menu, #dc_page_top, #dc_render, #dc_render_design, #dc_render_design_part, #dc_render_from_site, #dc_render_partial, #dc_replace_in_design, #dc_submit_tag, #dc_table_title, #dc_user_can_view, #dc_user_has_role, #dc_warning_messages_for, #decamelize_type
Constructor Details
#initialize(parent, opts) ⇒ DcMenuRenderer
Object initialization. Will also prepare DcMenu document.
42 43 44 45 46 47 |
# File 'app/renderers/dc_menu_renderer.rb', line 42 def initialize( parent, opts ) #:nodoc: @parent = parent @menu = opts[:name] ? DcMenu.find_by(name: opts[:name].to_s) : DcMenu.find(@parent.site.) @opts = opts self end |
Instance Method Details
#default ⇒ Object
Creates default menu.
200 201 202 203 204 205 206 207 208 209 |
# File 'app/renderers/dc_menu_renderer.rb', line 200 def default return "(#{@opts[:name]}) menu not found!" if @menu.nil? # @selected = find_selected html = '' html << "<div id='#{@menu.div_name}'>" unless @menu.div_name.blank? html << (@menu, table: 'dc_menu') html << "</div>" unless @menu.div_name.blank? html end |
#do_menu_level(menu, options = {}) ⇒ Object
Creates HTML code required for submenu on single level. Subroutine of default.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'app/renderers/dc_menu_renderer.rb', line 163 def (, ={}) html = "<ul>" if @opts[:edit_mode] > 1 [:title] = .respond_to?('name') ? .name : . # 1. level or submenus [:id] = ._id html << link_4edit() end # sort items acording to :order ..order_by(order: 1).each do |item| next unless item.active # menu can be hidden from user can_view, msg = dc_user_can_view(@parent, item) next unless can_view html << if item.id == @selected.id "<li class=\"menu-selected\">#{ (item) }" else "<li>#{ (item) }" end # do submenu if (sub = item.).size > 0 if @opts[:edit_mode] > 1 opts = .clone opts['ids'] = (opts['ids'] ? "#{opts['ids']};" : '') + ._id.to_s opts['table'] = (opts['table'] ? "#{opts['table']};" : '') + 'dc_menu_item' opts['form_name'] = nil # must be end html << (item, opts) end html << '</li>' end html << '</ul>' end |
#find_selected ⇒ Object
Return selected topmenu level.
52 53 54 55 56 57 58 59 60 |
# File 'app/renderers/dc_menu_renderer.rb', line 52 def find_selected if @parent.page. = @parent.page. = @parent.page..split(';')[1] if @parent.page..match(';') ret = @menu..find() end # return first if not found (something is wrong) ret ||= @menu.[0] end |
#link_4edit(opts) ⇒ Object
Creates edit link if in edit mode.
65 66 67 68 69 70 71 72 73 74 |
# File 'app/renderers/dc_menu_renderer.rb', line 65 def link_4edit(opts) #:nodoc: html = '' # return html unless @opts[:edit_mode] > 1 opts.merge!( { controller: 'cmsedit', action: 'edit' } ) title = "#{t('drgcms.edit')}: " opts[:title] = "#{title} #{opts[:title]}" html << '<li>'+dc_link_for_edit(opts)+'</li>' end |
#link_4menu(item) ⇒ Object
Returns html code required for creating one link in a menu.
Parameters:
- item
-
MenuItem.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'app/renderers/dc_menu_renderer.rb', line 79 def (item) # prepand to link link = if !item.link_prepend.blank? item.link_prepend elsif !@menu.link_prepend.blank? @menu.link_prepend else '' end if item.link.match('http') link = item.link else link += (item.link[0] == '/' ? '' : '/') + item.link link = '/' + link unless link[0] == '/' # link should start with '/' end target = item.target.blank? ? nil : item.target # - in first place won't write caption text = item.[0] == '-' ? '' : item..to_s img_title = item..to_s.sub('-','') # add picture if picture is not blank html = '' if !item.picture.blank? if item.picture[0,3] == 'fa-' << @parent.fa_icon(item.picture[3,20]) else html = @parent.link_to( @parent.image_tag(item.picture), link, {title: img_title, target: target} ) rescue '' end end html << @parent.link_to(.html_safe, link, {target: target}) unless .blank? html end |
#render_css ⇒ Object
Return CSS part of code.
222 223 224 |
# File 'app/renderers/dc_menu_renderer.rb', line 222 def render_css @menu.css if @menu end |
#render_html ⇒ Object
Renderer dispatcher. Method returns HTML part of code.
214 215 216 217 |
# File 'app/renderers/dc_menu_renderer.rb', line 214 def render_html method = @opts[:method] || 'default' respond_to?(method) ? send(method) : "Error DcMenu: Method #{method} doesn't exist!" end |