GalaxyHistories Class Reference

Public Member Functions
	__construct (GalaxyInstance $galaxy)
	create ($params)
	index ($params=array())
	show ($params)
	archiveDownload ($params)
	archiveExport ($params)
	deleteHistory ($params)
	undelete ($params)
	citations ($params)
	published ()
	sharedWithMe ()

Constructor & Destructor Documentation

GalaxyHistories::__construct

(

GalaxyInstance

$galaxy

)

The Histories constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Histories object.

Member Function Documentation

GalaxyHistories::archiveDownload

(

$params

)

Download a given history with indicated history id.

Corresponds to the Galaxy API method and path:

PUT /api/histories/{id}/exports' and: GET /api/histories/{id}/exports/{jeha_id}

Parameters

$params

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

• history_id: The id of the history to download To obtain history_id's, use this classes' index() function.
• file_path: The full path (including the file name) on the file system where the file should be written. Ideally, the file name should have a .tar.gz extension as the downloaded file will be gzip compressed.

Returns

TRUE if the download was successful and FALSE otherwise.

GalaxyHistories::archiveExport

(

$params

)

Start Job to create history export for corresponding history.

Corresponds to the Galaxy API method and path: PUT /api/histories/{id}/exports:

Parameters

$params

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

• history_id: The encoded id of the history to export.

Returns

A URL of where to download the export.

GalaxyHistories::citations

(

$params

)

Retreive information of the citations of a specified history.

Corresponds to the Galaxy API method and path: GET /api/histories/{encoded_history_id}/citations

Parameters

$params

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

• history_id: The encoded id of the history to undelete. To obtain history_id's, please use this classes' index() function.

Returns

An array of citations.

GalaxyHistories::create

(

$params

)

Create a new History component in Galaxy.

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

Creates a new history in a galaxy instance Note the option to pass 'keys' and 'views' is currently not supported

Parameters

$params

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

• name: The new history's name
• history_id: The id of the history to copy (will copy contents to new history). To obtain history_id's, please use this classes' index() function.
• archive_source: The url that will generate the archive to import.
• archive_type: 'url' (default).
• bool all_datasets: Copy deleted hdas/hdcas 'True' or 'False', defaults to True.

Returns

An array containing information about the new History component.

GalaxyHistories::deleteHistory

(

$params

)

Delete a specified history.

Corresponds to the Galaxy API method and path: DELETE /api/histories/{encoded_history_id}

Parameters

$params

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

• history_id: The encoded id of the history to delete. To obtain history_id's, please use this classes' index() function.

Returns

An array of deleted histories.

GalaxyHistories::index

(

$params = array()

)

Displays a collection of history components in Galaxy.

GET /api/histories and GET /api/histories/deleted

This function combines the list of active and deleted histories and therefore, corresponds to both of the Galaxy API methods and paths:

Parameters

$params

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

• deleted: If set true this will show deleted histories only.

Returns

An array containing list of histories in galaxy instance.

GalaxyHistories::published

(

)

Retreive all histories that have been published.

Corresponds to the Galaxy API method and path: GET /api/histories/published:

Returns

An array of published histories.

GalaxyHistories::sharedWithMe

(

)

Retreive all histories that are shared with the current user.

Corresponds to the Galaxy API method and path: GET /api/histories/shared_with_me:

Returns

An array histories shared with the current user.

GalaxyHistories::show

(

$params

)

Retreive detailed information about a particular history component.

Corresponds to the Galaxy API method and path: POST /api/histories/{encoded_history_id}:

Parameters

$params

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

• history_id: The id of the history to retreive. To obtain history_id's, please use this classes' index() function.

Returns

An array containing information about the specified history

GalaxyHistories::undelete

(

$params

)

Undelete a specified history.

Corresponds to the Galaxy API method and path: POST /api/histories/deleted/{encoded_history_id}

Parameters

$params

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

• history_id: The encoded id of the history to undelete. To obtain history_id's, please use this classes' index() function.

Returns

An array of undeleted histories.

---

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

• Histories.inc