Class: Principal
- Inherits:
-
ActiveRecord::Base
- Object
- ActiveRecord::Base
- Principal
- Defined in:
- app/models/principal.rb
Overview
Redmine - project management software Copyright (C) 2006-2020 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.
Constant Summary collapse
- STATUS_ANONYMOUS =
Account statuses
0
- STATUS_ACTIVE =
1
- STATUS_REGISTERED =
2
- STATUS_LOCKED =
3
Class Method Summary collapse
-
.detect_by_keyword(principals, keyword) ⇒ Object
Returns the principal that matches the keyword among principals.
-
.fields_for_order_statement(table = nil) ⇒ Object
Returns an array of fields names than can be used to make an order statement for principals.
Instance Method Summary collapse
- #<=>(principal) ⇒ Object
- #mail ⇒ Object
- #mail=(*args) ⇒ Object
-
#member_of?(project) ⇒ Boolean
Returns true if the principal is a member of project.
- #name(formatter = nil) ⇒ Object
- #nullify_projects_default_assigned_to ⇒ Object
-
#project_ids ⇒ Object
Returns an array of the project ids that the principal is a member of.
- #reload(*args) ⇒ Object
- #visible?(user = User.current) ⇒ Boolean
Class Method Details
.detect_by_keyword(principals, keyword) ⇒ Object
Returns the principal that matches the keyword among principals
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'app/models/principal.rb', line 175 def self.detect_by_keyword(principals, keyword) keyword = keyword.to_s return nil if keyword.blank? principal = nil principal ||= principals.detect {|a| keyword.casecmp(a.login.to_s) == 0} principal ||= principals.detect {|a| keyword.casecmp(a.mail.to_s) == 0} if principal.nil? && / /.match?(keyword) firstname, lastname = *(keyword.split) # "First Last Throwaway" principal ||= principals.detect {|a| a.is_a?(User) && firstname.casecmp(a.firstname.to_s) == 0 && lastname.casecmp(a.lastname.to_s) == 0 } end if principal.nil? principal ||= principals.detect {|a| keyword.casecmp(a.name) == 0} end principal end |
.fields_for_order_statement(table = nil) ⇒ Object
Returns an array of fields names than can be used to make an order statement for principals. Users are sorted before Groups. Examples:
168 169 170 171 172 |
# File 'app/models/principal.rb', line 168 def self.fields_for_order_statement(table=nil) table ||= table_name columns = ['type DESC'] + (User.name_formatter[:order] - ['id']) + ['lastname', 'id'] columns.uniq.map {|field| "#{table}.#{field}"} end |
Instance Method Details
#<=>(principal) ⇒ Object
154 155 156 157 158 159 160 161 162 163 |
# File 'app/models/principal.rb', line 154 def <=>(principal) if principal.nil? -1 elsif self.class.name == principal.class.name self.to_s.casecmp(principal.to_s) else # groups after users principal.class.name <=> self.class.name end end |
#mail ⇒ Object
136 137 138 |
# File 'app/models/principal.rb', line 136 def mail nil end |
#mail=(*args) ⇒ Object
132 133 134 |
# File 'app/models/principal.rb', line 132 def mail=(*args) nil end |
#member_of?(project) ⇒ Boolean
Returns true if the principal is a member of project
145 146 147 |
# File 'app/models/principal.rb', line 145 def member_of?(project) project.is_a?(Project) && project_ids.include?(project.id) end |
#name(formatter = nil) ⇒ Object
128 129 130 |
# File 'app/models/principal.rb', line 128 def name(formatter = nil) to_s end |
#nullify_projects_default_assigned_to ⇒ Object
198 199 200 |
# File 'app/models/principal.rb', line 198 def nullify_projects_default_assigned_to Project.where(default_assigned_to: self).update_all(default_assigned_to_id: nil) end |
#project_ids ⇒ Object
Returns an array of the project ids that the principal is a member of
150 151 152 |
# File 'app/models/principal.rb', line 150 def project_ids @project_ids ||= super.freeze end |
#reload(*args) ⇒ Object
123 124 125 126 |
# File 'app/models/principal.rb', line 123 def reload(*args) @project_ids = nil super end |
#visible?(user = User.current) ⇒ Boolean
140 141 142 |
# File 'app/models/principal.rb', line 140 def visible?(user=User.current) Principal.visible(user).find_by(:id => id) == self end |