blend4php  v0.1
A PHP API for interacting with Galaxy
 All Classes Functions Variables Pages
GalaxyVisualizations Class Reference

Public Member Functions

 __construct (GalaxyInstance $galaxy)
 
 index ()
 
 show ($viz_id)
 
 create ($type, $title, $dbkey, $import_id=NULL)
 
 update ($viz_id, $title=NULL, $dbkey=NULL, $config=NULL)
 

Constructor & Destructor Documentation

GalaxyVisualizations::__construct ( GalaxyInstance  $galaxy)

The visualizations constructor.

Parameters
GalaxyInstance$galaxyA GalaxyInstance object
Returns
An instance of a Visualizations object

Member Function Documentation

GalaxyVisualizations::create (   $type,
  $title,
  $dbkey,
  $import_id = NULL 
)

Imports copy of existing visualizatiion into the workplace.

Corresponds to the Galaxy API/paths at POST /api/visualizations or POST /api/visualizations?import_id={encoded_visualization_id}

Parameters
$typeThe visualization type for the new visualization.
$titleThe title for the visualization.
$dbkeyThe db key.
$import_id(optional) The id of the visualization to import, if the user desires to import a visualization.
Returns
An array containing the created visualization.
GalaxyVisualizations::index ( )

Retreive a list of all visualizations.

Corresponds to the Galaxy API/path GET /api/visualizations

Returns
An array containing all of galaxy's visualizations.
GalaxyVisualizations::show (   $viz_id)

Retreive detailed information about a specific visualization.

Corresponds to the Galaxy API/path GET /api/visualizations/{viz_id}

Parameters
$viz_idThe visualization id whos details to display.
GalaxyVisualizations::update (   $viz_id,
  $title = NULL,
  $dbkey = NULL,
  $config = NULL 
)

Update a specific visualization

Corresponds to the Galaxy API/path at PUT /api/visualizations/{visualizations id}

Parameters
$viz_idvisualization id of the visualization to update. To obtain this id please use this class's index method.
$titleIf the user is changing the title, include the new title.
$dbkeyIf the user is changing the new db key, include the new dbkey.
$configThe configuration of the visualization.
Returns
An array containing the updated visualizaiton.

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