GalaxyUsers Class Reference

Public Member Functions
	__construct (GalaxyInstance $galaxy)
	index ($params)
	show ($params)
	apiKey ($params)
	create ($params)
	update ()
	undelete ()
	delete ($params)
	getUserID ($params)

Constructor & Destructor Documentation

GalaxyUsers::__construct

(

GalaxyInstance

$galaxy

)

The Users constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Users object.

Member Function Documentation

GalaxyUsers::apiKey

(

$params

)

Creates a new API key for specified user.

Corresponds to the Galaxy API/path POST /api/users/{encoded_user_id}/api_key

Parameters

$params

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

• user_id: The id of the specified user. To obtain a user id, please use this class's index function.

Returns

The API key of the user.

GalaxyUsers::create

(

$params

)

Creates new galaxy user.

Corresponds to the Galaxy API/path POST /api/users For this method to work, the Galaxy instance must have the allow_user_creation option set to True and use_remote_user option set to False in the config/galaxy.ini configuration file.

Parameters

$params

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

• username: The username of the new user.
• user_email: The email of the new user.
• password: The password of the new user.

Returns

An array containing details of the new user. On failure FALSE is returned.

GalaxyUsers::delete

(

$params

)

Mark a given user as deleted

Corresponds to the Galaxy API/path DELETE /api/users/{id}

Parameters

$params

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

• user_id: The id of the user to delete. To obtain a user id, please use this class's index function.
• purge (Optional): If true, the user will be completely erased from Galaxy.

Returns

An array containing details of the deleted user, or FALSE on failure.

GalaxyUsers::getUserID

(

$params

)

Retrieves the ID of a Galaxy user.

Parameters

$params

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

• username: The name of the user.

Returns

A string containing the user ID or FALSE if the user could not be found.

GalaxyUsers::index

(

$params

)

Displays a collection of Galaxy users.

Corresponds to the Galaxy API/paths at GET /api/users and GET /api/users/deleted

Parameters

$params

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

• deleted (Optional): If true, show deleted users.
• f_email (Optional): An email address to filter results based on.
• f_name (Optional): A username to filter results based on.
• f_any (Optional): If true, Filter on username OR email.

Returns

An array containing information on the the users.

GalaxyUsers::show

(

$params

)

Retreive detailed information on a specific user.

Corresponds to the Galaxy API path GET /api/users/{encoded_user_id} GET /api/users/current GET /api/users/deleted/{encoded_user_id}

Parameters

$params

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

• user_id (Optional): The id of the user whos details to retreive. To obtain a user id please use this class's index() function.
• deleted (Optional): If set to TRUE, will show deleted users.
• current (Default): If neither of the above parameters are set then present details of current user.

  Returns

  An array containing the details of the user.

GalaxyUsers::undelete

(

)

The actual python implementation is not complete

GalaxyUsers::update

(

)

The actual python implementation is not complete

---

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

• Users.inc