GalaxyGroupUsers Class Reference

Public Member Functions
	__construct (GalaxyInstance $galaxy)
	index ($group_id)
	show ($group_id, $user_id)
	update ($group_id, $user_id)
	delete ($group_id, $user_id)

Constructor & Destructor Documentation

GalaxyGroupUsers::__construct

(

GalaxyInstance

$galaxy

)

The GroupUsers constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Groups Users object.

Member Function Documentation

GalaxyGroupUsers::delete	(		$group_id,
			$user_id
	)

Deletes a user from a given group.

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

Parameters

$group_id	The id of the group to modify. Group IDs can be found using the index() function of this class.
$user_id	A user id to deassociate any users from the group. Use the Users class to retreive a list of user IDs.

Returns

An array of the user that has been removed from the group.

GalaxyGroupUsers::index

(

$group_id

)

Displays a collection (list) of users corresponding to a group..

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

Parameters

$group_id

The id of the group whose users to list. Group IDs can be found using the index() function of the Groups class.

Returns

An array of all users of a given group.

GalaxyGroupUsers::show	(		$group_id,
			$user_id
	)

Retreive information about a specific group user.

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

Parameters

$group_id	The id of the group whose users to list. Group IDs can be found using the index() function of the Groups class.
$user_id	The id of the specific user to show. User IDS can be found using the index() function of the Users class

Returns

An array containing details about the user of a given group.

GalaxyGroupUsers::update	(		$group_id,
			$user_id
	)

Adds a user to a given group.

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

Parameters

$group_id	The id of the group to modify. Group IDs can be found using the index() function of this class.
$user_id	A user id to associate any new users to the group. Use the Users class to retreive a list of existing user IDs.

Returns

An array of the user that has added to the group

---

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

• GroupUsers.inc