Class Group
In: app/models/group.rb
Parent: ActiveRecord::Base

Group

Original by:Sysphonic
Authors:MORITA Shintaro
Copyright:Copyright (c) 2007 MORITA Shintaro, Sysphonic. All rights reserved.
License:New BSD License (See LICENSE file)
URL:http://sysphonic.com/

Group contains Users and sub Groups, and represents the unit in the organization.

Note:

  • Root Group has no records in DB, and its ID is ‘0’.

Methods

count_users   create_group_folder   delete   delete   delete_all   destroy   destroy   destroy_all   get_childs   get_childs   get_group_folder   get_group_folder   get_name   get_parents   get_path   get_path   get_tree   get_users   rename  

Public Class methods

delete(id)

self.delete

Overrides ActionRecord::Base.delete().

id:Target Group-ID.
delete_all(conditions = nil)

self.delete_all

Overrides ActionRecord::Base.delete_all().

conditions:Conditions.
destroy(id)

self.destroy

Overrides ActionRecord::Base.destroy().

id:Target Group-ID.
destroy_all(conditions = nil)

self.destroy_all

Overrides ActionRecord::Base.delete_all().

conditions:Conditions.
get_childs(group_id, recursive, ret_obj)

self.get_childs

Gets childs array of the specified Group.

group_id:Target Group-ID.
recursive:Specify true if recursive search is required.
ret_obj:Flag to require Group instances by return.
return:Array of child Group-IDs, or Groups if ret_obj is true.
get_group_folder(group_id)

self.get_group_folder

Gets Group Folder of specified Group-ID.

group_id:Target Group-ID.
return:Folder object of the Group.
get_name(group_id)

self.get_name

Gets the name of the specified Group.

return:Group name. If not found, prearranged string.
get_path(group_id)

self.get_path

Gets path-string which represents the position of this Group in the organization.

group_id:Target Group-ID.
return:Group path like "/parent_name1/parent_name2/this_name".
get_tree(group_tree, conditions, tree_id)

self.get_tree

Gets tree of Groups. Called recursive.

get_users(group_id)

self.get_users

Gets Users in specified Group.

return:Users in specified Group.

Public Instance methods

count_users(recursive)

count_users

Gets count of Users.

recursive:Specify true if recursive search is required.
return:Count of users.
delete()

delete

Overrides ActionRecord::Base.delete().

destroy()

destroy

Overrides ActionRecord::Base.destroy().

get_childs(recursive, ret_obj)

get_childs

Gets childs array of this Group.

recursive:Specify true if recursive search is required.
ret_obj:Flag to require Group instances by return.
return:Array of child Group-IDs, or Groups if ret_obj is true.
get_parents(ret_obj)

get_parents

Gets parents array of this object.

ret_obj:Flag to require Group instances by return.
return:Array of parent Groups or Group-IDs.
get_path()

get_path

Gets path-string which represents the position of this Group in the organization.

return:Group path like "/parent_name1/parent_name2/this_name".
rename(new_name)

rename

Renames Group.

new_name:New name.

[Validate]