GalaxyRoles Class Reference

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

Constructor & Destructor Documentation

GalaxyRoles::__construct

(

GalaxyInstance

$galaxy

)

The Roles constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a roles object.

Member Function Documentation

GalaxyRoles::create

(

$params

)

Creates a new role.

Corresponds to the Galaxy Api/path: POST /api/roles

NOTE: only type admin can be applied for new roles

Parameters

$params

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

• name: The name of the new role.
• description: The description of the new role.
• user_ids: An array of user ids to associate the new role with. To obtain a user id, please use the index() function of the users class.
• group_ids: An array of group id's to associate the new role with. To obtain a group id, please use the index() function of the groups class.

Returns

An array containing informaiton about the new role.

GalaxyRoles::index

(

)

Retreive a list of all of Galaxy's roles.

Corresponds to the Galaxy API/path: GET /api/roles

Returns

An array containing details of all the roles in Galaxy.

GalaxyRoles::show

(

$params

)

Retreive details about a specific Galaxy role.

Corresponds to the Galaxy API/path: GET /api/roles/{encoded_id}

Parameters

$params

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

• role_id: The id of the role whos informaiton to retreive. Please use this class's index function to retreive a list of role id's.

Returns

An array containing details about the specified role.

---

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

• Roles.inc