From 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Sun, 30 Dec 2012 14:43:00 +0200 Subject: Use sdoc to generate application code documentation --- doc/code/classes/Team.html | 470 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 470 insertions(+) create mode 100644 doc/code/classes/Team.html (limited to 'doc/code/classes/Team.html') diff --git a/doc/code/classes/Team.html b/doc/code/classes/Team.html new file mode 100644 index 00000000000..08d2c07e3c6 --- /dev/null +++ b/doc/code/classes/Team.html @@ -0,0 +1,470 @@ + + + + + Team + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
A
+
+ +
+ +
D
+
+ +
+ +
T
+
+ +
+ +
U
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + add_user_id_to_team(user_id, access_role) + + +
+ + +
+

Add user to project with passed access role by user id

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 26
+def add_user_id_to_team(user_id, access_role)
+  users_projects.create(
+    user_id: user_id,
+    project_access: access_role
+  )
+end
+
+
+ +
+ +
+
+ + add_user_to_team(user, access_role) + + +
+ + +
+

Add user to project with passed access role

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 14
+def add_user_to_team(user, access_role)
+  add_user_id_to_team(user.id, access_role)
+end
+
+
+ +
+ +
+
+ + add_users_ids_to_team(users_ids, access_role) + + +
+ + +
+

Add multiple users to project with same access role by user ids

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 35
+def add_users_ids_to_team(users_ids, access_role)
+  UsersProject.bulk_import(self, users_ids, access_role)
+end
+
+
+ +
+ +
+
+ + add_users_to_team(users, access_role) + + +
+ + +
+

Add multiple users to project with same access role

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 20
+def add_users_to_team(users, access_role)
+  add_users_ids_to_team(users.map(&:id), access_role)
+end
+
+
+ +
+ +
+
+ + delete_users_ids_from_team(users_ids) + + +
+ + +
+

Delete multiple users from project by user ids

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 46
+def delete_users_ids_from_team(users_ids)
+  UsersProject.bulk_delete(self, users_ids)
+end
+
+
+ +
+ +
+
+ + team_member_by_id(user_id) + + +
+ + +
+

Get Team Member record by user id

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 8
+def team_member_by_id(user_id)
+  users_projects.find_by_user_id(user_id)
+end
+
+
+ +
+ +
+
+ + team_member_by_name_or_email(name = nil, email = nil) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 2
+def team_member_by_name_or_email(name = nil, email = nil)
+  user = users.where("name like ? or email like ?", name, email).first
+  users_projects.where(user: user) if user
+end
+
+
+ +
+ +
+
+ + truncate_team() + + +
+ + +
+

Remove all users from project team

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 51
+def truncate_team
+  UsersProject.truncate_team(self)
+end
+
+
+ +
+ +
+
+ + update_users_ids_to_role(users_ids, access_role) + + +
+ + +
+

Update multiple project users to same access role by user ids

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/team.rb, line 41
+def update_users_ids_to_role(users_ids, access_role)
+  UsersProject.bulk_update(self, users_ids, access_role)
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1