Module: Redmine::MenuManager::MenuHelper
- Defined in:
- lib/redmine/menu_manager.rb
Instance Method Summary collapse
-
#allowed_node?(node, user, project) ⇒ Boolean
See MenuItem#allowed?.
-
#current_menu_item ⇒ Object
Returns the current menu item name.
- #display_main_menu?(project) ⇒ Boolean
- #extract_node_details(node, project = nil) ⇒ Object
- #menu_items_for(menu, project = nil) ⇒ Object
-
#render_main_menu(project) ⇒ Object
Renders the application main menu.
- #render_menu(menu, project = nil) ⇒ Object
- #render_menu_node(node, project = nil) ⇒ Object
- #render_menu_node_with_children(node, project = nil) ⇒ Object
- #render_single_menu_node(item, caption, url, selected) ⇒ Object
-
#render_unattached_children_menu(node, project) ⇒ Object
Returns a list of unattached children menu items.
- #render_unattached_menu_item(menu_item, project) ⇒ Object
-
#use_absolute_controller(url) ⇒ Object
Prevent hash type URLs (e.g. ‘foo’, action: ‘bar) from being namespaced when menus are rendered from views in namespaced controllers in plugins or engines.
Instance Method Details
#allowed_node?(node, user, project) ⇒ Boolean
See MenuItem#allowed?
235 236 237 238 239 240 241 |
# File 'lib/redmine/menu_manager.rb', line 235 def allowed_node?(node, user, project) unless node.is_a? MenuItem raise MenuError, ":child_menus must be an array of MenuItems" end node.allowed?(user, project) end |
#current_menu_item ⇒ Object
Returns the current menu item name
97 98 99 |
# File 'lib/redmine/menu_manager.rb', line 97 def controller. end |
#display_main_menu?(project) ⇒ Boolean
108 109 110 111 |
# File 'lib/redmine/menu_manager.rb', line 108 def (project) = controller.(project) .present? && Redmine::MenuManager.items().children.present? end |
#extract_node_details(node, project = nil) ⇒ Object
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/redmine/menu_manager.rb', line 215 def extract_node_details(node, project=nil) item = node url = case item.url when Hash project.nil? ? item.url : {item.param => project}.merge(item.url) when Symbol if project send(item.url, project) else send(item.url) end else item.url end = item.(project) return [, url, ( == item.name)] end |
#menu_items_for(menu, project = nil) ⇒ Object
201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/redmine/menu_manager.rb', line 201 def (, project=nil) items = [] Redmine::MenuManager.items().root.children.each do |node| if node.allowed?(User.current, project) if block_given? yield node else items << node # TODO: not used? end end end return block_given? ? nil : items end |
#render_main_menu(project) ⇒ Object
Renders the application main menu
102 103 104 105 106 |
# File 'lib/redmine/menu_manager.rb', line 102 def (project) if = controller.(project) (, project) end end |
#render_menu(menu, project = nil) ⇒ Object
113 114 115 116 117 118 119 |
# File 'lib/redmine/menu_manager.rb', line 113 def (, project=nil) links = [] (, project) do |node| links << (node, project) end links.empty? ? nil : content_tag('ul', links.join.html_safe) end |
#render_menu_node(node, project = nil) ⇒ Object
121 122 123 124 125 126 127 128 129 |
# File 'lib/redmine/menu_manager.rb', line 121 def (node, project=nil) if node.children.present? || !node..nil? return (node, project) else , url, selected = extract_node_details(node, project) return content_tag('li', (node, , url, selected)) end end |
#render_menu_node_with_children(node, project = nil) ⇒ Object
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/redmine/menu_manager.rb', line 131 def (node, project=nil) , url, selected = extract_node_details(node, project) html = [].tap do |html| html << '<li>' # Parent html << (node, , url, selected) # Standard children standard_children_list = "".html_safe.tap do |child_html| node.children.each do |child| child_html << (child, project) if allowed_node?(child, User.current, project) end end html << content_tag(:ul, standard_children_list, :class => 'menu-children') unless standard_children_list.empty? # Unattached children unattached_children_list = (node, project) html << content_tag(:ul, unattached_children_list, :class => 'menu-children unattached') unless unattached_children_list.blank? html << '</li>' end return html.join("\n").html_safe end |
#render_single_menu_node(item, caption, url, selected) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/redmine/menu_manager.rb', line 174 def (item, , url, selected) = item.(:selected => selected) # virtual nodes are only there for their children to be displayed in the menu # and should not do anything on click, except if otherwise defined elsewhere if url.blank? url = '#' .reverse_merge!(:onclick => 'return false;') end label = if item.icon.present? sprite_icon(item.icon, h()) else h() end link_to(label, use_absolute_controller(url), ) end |
#render_unattached_children_menu(node, project) ⇒ Object
Returns a list of unattached children menu items
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/redmine/menu_manager.rb', line 158 def (node, project) return nil unless node. "".html_safe.tap do |child_html| unattached_children = node..call(project) # Tree nodes support #each so we need to do object detection if unattached_children.is_a? Array unattached_children.each do |child| child_html << content_tag(:li, (child, project)) if allowed_node?(child, User.current, project) end else raise MenuError, ":child_menus must be an array of MenuItems" end end end |
#render_unattached_menu_item(menu_item, project) ⇒ Object
193 194 195 196 197 198 199 |
# File 'lib/redmine/menu_manager.rb', line 193 def (, project) raise MenuError, ":child_menus must be an array of MenuItems" unless .is_a? MenuItem if .allowed?(User.current, project) link_to(., use_absolute_controller(.url), .) end end |
#use_absolute_controller(url) ⇒ Object
Prevent hash type URLs (e.g. ‘foo’, action: ‘bar) from being namespaced when menus are rendered from views in namespaced controllers in plugins or engines
245 246 247 248 249 250 |
# File 'lib/redmine/menu_manager.rb', line 245 def use_absolute_controller(url) if url.is_a?(Hash) && url[:controller].present? && !url[:controller].start_with?('/') url[:controller] = "/#{url[:controller]}" end url end |