Class: Redmine::MenuManager::Mapper

Inherits:
Object
  • Object
show all
Defined in:
lib/redmine/menu_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(menu, items) ⇒ Mapper

Returns a new instance of Mapper

Since:

  • 0.8.0



227
228
229
230
231
 
# File 'lib/redmine/menu_manager.rb', line 227

def initialize(menu, items)
  items[menu] ||= MenuNode.new(:root, {})
  @menu = menu
  @menu_items = items[menu]
end

Instance Attribute Details

Returns the value of attribute menu

Since:

  • 2.4.0



225
226
227
 
# File 'lib/redmine/menu_manager.rb', line 225

def menu
  @menu
end

#menu_items ⇒ Object (readonly)

Returns the value of attribute menu_items

Since:

  • 2.4.0



225
226
227
 
# File 'lib/redmine/menu_manager.rb', line 225

def menu_items
  @menu_items
end

Instance Method Details

#delete(name) ⇒ Object

Removes a menu item

Since:

  • 0.8.0



288
289
290
291
292
 
# File 'lib/redmine/menu_manager.rb', line 288

def delete(name)
  if found = self.find(name)
    @menu_items.remove!(found)
  end
end

#exists?(name) ⇒ Boolean

Checks if a menu item exists

Returns:

  • (Boolean)

Since:

  • 0.9.0



295
296
297
 
# File 'lib/redmine/menu_manager.rb', line 295

def exists?(name)
  @menu_items.any? {|node| node.name == name}
end

#find(name) ⇒ Object

Since:

  • 0.9.0



299
300
301
 
# File 'lib/redmine/menu_manager.rb', line 299

def find(name)
  @menu_items.find {|node| node.name == name}
end

#position_of(name) ⇒ Object

Since:

  • 0.9.0



303
304
305
306
307
308
309
 
# File 'lib/redmine/menu_manager.rb', line 303

def position_of(name)
  @menu_items.each do |node|
    if node.name == name
      return node.position
    end
  end
end

#push(name, url, options = {}) ⇒ Object

Adds an item at the end of the menu. Available options:

  • param: the parameter name that is used for the project id (default is :id)

  • if: a Proc that is called before rendering the item, the item is displayed only if it returns true

  • caption that can be:

    • a localized string Symbol

    • a String

    • a Proc that can take the project as argument

  • before, after: specify where the menu item should be inserted (eg. :after => :activity)

  • parent: menu item will be added as a child of another named menu (eg. :parent => :issues)

  • children: a Proc that is called before rendering the item. The Proc should return an array of MenuItems, which will be added as children to this item. eg. :children => Proc.new {|project| [Redmine::MenuManager::MenuItem.new(…)] }

  • last: menu item will stay at the end (eg. :last => true)

  • html_options: a hash of html options that are passed to link_to

Since:

  • 0.6.0



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/redmine/menu_manager.rb', line 246

def push(name, url, options={})
  options = options.dup

  if options[:parent]
    subtree = self.find(options[:parent])
    if subtree
      target_root = subtree
    else
      target_root = @menu_items.root
    end

  else
    target_root = @menu_items.root
  end

  # menu item position
  if first = options.delete(:first)
    target_root.prepend(MenuItem.new(name, url, options))
  elsif before = options.delete(:before)

    if exists?(before)
      target_root.add_at(MenuItem.new(name, url, options), position_of(before))
    else
      target_root.add(MenuItem.new(name, url, options))
    end

  elsif after = options.delete(:after)

    if exists?(after)
      target_root.add_at(MenuItem.new(name, url, options), position_of(after) + 1)
    else
      target_root.add(MenuItem.new(name, url, options))
    end

  elsif options[:last] # don't delete, needs to be stored
    target_root.add_last(MenuItem.new(name, url, options))
  else
    target_root.add(MenuItem.new(name, url, options))
  end
end