GalaxyLibraries Class Reference

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

Constructor & Destructor Documentation

GalaxyLibraries::__construct

(

GalaxyInstance

$galaxy

)

The Folders constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a Libraries object.

Member Function Documentation

GalaxyLibraries::create

(

$params

)

Creates a new library.

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

Parameters

$params

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

• name: The library's name.
• description: Optional the new library's description.
• synopsis: Optional a string containing a synopsis.

Returns

An array containing the new library created.

GalaxyLibraries::delete

(

$params

)

Marks a specific library as deleted or a deleted library as not-deleted.

Corresponds to the Galaxy Api/path at DELETE /api/libraries/{encoded_id}

Parameters

$params

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

• library_id: The id of the library to delete or undelete, to obtain library id's. Please use this class's index() function.
• undelete: If TRUE, the library will be undeleted if it is already deleted.

Returns

An array containing details of the deleted or undeleted library.

GalaxyLibraries::getPermissions

(

$params

)

Retreives the permission details for a given library.

Corresponds to the Galaxy API/path GET /api/libraries/{encoded_library_id}/permissions

Parameters

$params

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

• library_id: The if of the library to receive permissions for. To obtain library id's please use this class's index function. . * - scope: The scope of the permission, either 'available' or 'current'. This parameter defaults to 'current'
• is_library_access: If FALSE, the function will not look for libraries with user access, defaults to TRUE.

Returns

An array containing details of the permissions of all libraries.

GalaxyLibraries::index

(

$params

)

Retreives a list of summary data for all libraries.

Corresponds to the Galaxy Api/path: GET /api/libraries

Parameters

$params

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

• deleted: if TRUE, show only deleted libraries, if FALSE show only non-deleted.

Returns

An array of all of libraries. And all of the deleted libraries if appropriate.

GalaxyLibraries::setPermissions

(

$params

)

Sets the permissions for a specified library.

Corresponds to the Galaxy API function at POST /api/libraries/{encoded_library_id}/permissions

Parameters

$params

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

• library_id: The id of the library to set permissions to. To obtain the library id. Refer to this class's index() function.
• action: Set to either: 'remove_restrictions' or 'set_permissions', to specify appropriate action for the function.
• access_ids: A list of role ids defining roles that should have access permissions on the library. To obtain role id's please refer to the roles class.
• add_ids: A list of role id defining roles that should have add item permissions on the library.
• manage_ids: A list of role id defining roles that should have manage permissions on the library.
• modify_ids: A list of role id defining roles that should have modify permissions on the library.

Returns

An array of librariy objects who's permissions have been modified.

GalaxyLibraries::show

(

$params

)

Retreives detailed infromation about a specific library.

Corresponds t the Galaxy Api functions at GET /api/libraries/{encoded_id} and GET /api/libraries/deleted/{encoded_id}

Parameters

$params

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

• library_id: The id of the library to show. To obtain library ids, please use this class's index() function.
• deleted: If TRUE, the function may return a deleted library.

Returns

An array containing details of the specified library.

GalaxyLibraries::update

(

$params

)

Updates library.

Corresponds to the Galaxy Api/path: PATCH /api/libraries/{encoded_id}

Parameters

$params

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

• name: New library's name.
• description: New library's description.
• synopsis: New string containing a synopsis.

Returns

An array containing the new library created.

---

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

• Libraries.inc