GalaxyFolderContents Class Reference

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

Constructor & Destructor Documentation

GalaxyFolderContents::__construct

(

GalaxyInstance

$galaxy

)

The FolderContents constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a FolderContents object.

Member Function Documentation

GalaxyFolderContents::create

(

$params

)

Create a new content for specified folder

Corresponds to the Galaxy API/path at: POST /api/folders/{folder_id}/contents

Parameters

$params

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

• parent_folder_id: The parent folder of the new item. To obtain id, see the index() function in the Folder class.
• from_hda_id (Optional): The id of an accessible HDA to into the library. To obtain this id, see index() in HistoryContents class.
• ldda_messge (Optional): Any message to send along with the LibraryDatasetAssociation.
• extented_metadata (Optional): Sub-dictionary containing any extended metadata to associate with the item.

Returns

An array containing the newly created folder content.

GalaxyFolderContents::index

(

$params

)

Displays all the contents of a folder.

Corresponds to the Galaxy API/path: GET /api/folders/F{folder_id}/contents.

Parameters

$params

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

• folder_id: Id of the folder's contents to display. To obtain an id see the index() function in the Folder class.

Returns

An array of The specified folder's contents

GalaxyFolderContents::show

(

$params

)

Retreive details of for a specified folder.

Corresponds to the Galaxy API/path: GET /api/folders/{folder_id}/

Parameters

$params

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

Returns

False.

GalaxyFolderContents::update

(

$params

)

Update the contents to a specific folder

Corresponds to the Galaxy API/PATH PUT /api/folders/{folder_id}/

Returns

False.

---

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

• FolderContents.inc