Class: QueryColumn

Inherits:
Object
  • Object
show all
Includes:
Redmine::I18n
Defined in:
app/models/query.rb

Overview

Redmine - project management software Copyright (C) 2006-2017 Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Since:

  • 0.6.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Redmine::I18n

#current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #set_language_if_valid, #valid_languages

Constructor Details

#initialize(name, options = {}) ⇒ QueryColumn

Returns a new instance of QueryColumn



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'app/models/query.rb', line 22

def initialize(name, options={})
  self.name = name
  self.sortable = options[:sortable]
  self.groupable = options[:groupable] || false
  if groupable == true
    self.groupable = name.to_s
  end
  self.totalable = options[:totalable] || false
  self.default_order = options[:default_order]
  @inline = options.key?(:inline) ? options[:inline] : true
  @caption_key = options[:caption] || "field_#{name}".to_sym
  @frozen = options[:frozen]
end

Instance Attribute Details

#default_order ⇒ Object

Returns the value of attribute default_order

Since:

  • 0.7.0



19
20
21
 
# File 'app/models/query.rb', line 19

def default_order
  @default_order
end

#groupable ⇒ Object

Returns the value of attribute groupable

Since:

  • 0.9.0



19
20
21
 
# File 'app/models/query.rb', line 19

def groupable
  @groupable
end

#name ⇒ Object

Returns the value of attribute name



19
20
21
 
# File 'app/models/query.rb', line 19

def name
  @name
end

#sortable ⇒ Object

Returns the value of attribute sortable



19
20
21
 
# File 'app/models/query.rb', line 19

def sortable
  @sortable
end

#totalable ⇒ Object

Returns the value of attribute totalable

Since:

  • 3.2.0



19
20
21
 
# File 'app/models/query.rb', line 19

def totalable
  @totalable
end

Instance Method Details

#caption ⇒ Object

Since:

  • 0.6.1



36
37
38
39
40
41
42
43
44
45
 
# File 'app/models/query.rb', line 36

def caption
  case @caption_key
  when Symbol
    l(@caption_key)
  when Proc
    @caption_key.call
  else
    @caption_key
  end
end

#css_classes ⇒ Object

Since:

  • 1.2.0



72
73
74
 
# File 'app/models/query.rb', line 72

def css_classes
  name
end

#frozen? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.3.0



60
61
62
 
# File 'app/models/query.rb', line 60

def frozen?
  @frozen
end

#inline? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 2.2.0



56
57
58
 
# File 'app/models/query.rb', line 56

def inline?
  @inline
end

#sortable? ⇒ Boolean

Returns true if the column is sortable, otherwise false

Returns:

  • (Boolean)

Since:

  • 0.9.0



48
49
50
 
# File 'app/models/query.rb', line 48

def sortable?
  !@sortable.nil?
end

#value(object) ⇒ Object

Since:

  • 0.9.0



64
65
66
 
# File 'app/models/query.rb', line 64

def value(object)
  object.send name
end

#value_object(object) ⇒ Object

Since:

  • 2.6.0



68
69
70
 
# File 'app/models/query.rb', line 68

def value_object(object)
  object.send name
end