GalaxyGroups Class Reference

Public Member Functions
	__construct (GalaxyInstance $galaxy)
	index ()
	create ($params)
	show ($params)
	update ($params)

Constructor & Destructor Documentation

GalaxyGroups::__construct

(

GalaxyInstance

$galaxy

)

The Groups constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Groups object.

Member Function Documentation

GalaxyGroups::create

(

$params

)

Create a new group.

Corresponds to the Galaxy API method and path: POST /api/groups.

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available:

• name: Name of the group.
• user_ids: An array of user_ids, if any, to associate user id's to the group. Use the Users class to retrieve a list of users.
• role_ids: An array of role_ids to associate any new roles to the group. Use the Roles class to retreive a list of existing role IDs.

Returns

An array of the group that contains the users and roles.

GalaxyGroups::index

(

)

Displays a collection (list) of groups.

Corresponds to the Galaxy API method and path: GET /api/groups.

Returns

An array of all groups.

GalaxyGroups::show

(

$params

)

Retreive information about a group.

Corresponds to the Galaxy API method and path: GET /api/groups/{encoded_group_id}

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available:

• group_id: The id of the specific group to show. Group IDs can be found using the index() function of this class.

Returns

An array containing details about the group.

GalaxyGroups::update

(

$params

)

Supports changes to a group including the name, users and roles.

Corresponds to the Galaxy API method and path: PUT /api/groups/{encoded_group_id}.

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available: group_id: The id of the group to modify. Group IDs can be found using the index() function of this class. name: A new name, if any, to call the group. user_ids: An array of user_ids, if any, to associate user id's to the group. Use the Users class to retrieve a list of users. role_ids: An array of role_ids to associate any new roles to the group. Use the Roles class to retreive a list of existing role IDs.

Returns

An array of the group that contains the users and roles.

---

The documentation for this class was generated from the following file:

• Groups.inc