GalaxyGroupRoles Class Reference

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

Constructor & Destructor Documentation

GalaxyGroupRoles::__construct

(

GalaxyInstance

$galaxy

)

The Group Roles constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Group Roles object.

Member Function Documentation

GalaxyGroupRoles::delete

(

$params

)

Supports deleting a role from a given group.

Corresponds to the Galaxy API method and path: DELETE /api/groups/{encoded_group_id}/roles/{encoded_role_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 whose roles to list. Group IDs can be found using the index() function of the Groups class.
• role_id: The id of the specific role to show. Role IDS can be found using the index() function of the Roles class.

Returns

An array of the role that was removed from the group.

GalaxyGroupRoles::index

(

$params

)

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

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

Parameters

$params

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

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

Returns

An array of all group roles for a given group.

GalaxyGroupRoles::show

(

$params

)

Retreive information about a specific group role.

Corresponds to the Galaxy API method and path: GET /api/groups/{encoded_group_id}/roles/{encoded_role_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 whose roles to list. Group IDs can be found using the index() function of the Groups class.
• role_id: The id of the specific role to show. Role IDS can be found using the index() function of the Roles class

Returns

An array containing details about the role of a given gorup.

GalaxyGroupRoles::update

(

$params

)

Supports adding a role to a given group.

Corresponds to the Galaxy API method and path: PUT /api/groups/{encoded_group_id}/roles/{encoded_role_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 whose roles to list. Group IDs can be found using the index() function of the Groups class.
• role_id: The id of the specific role to show. Role IDS can be found using the index() function of the Roles class.

Returns

An array of the role that was added to the group

---

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

• GroupRoles.inc