Library Module API

Functions
	tripal_library_get_property ($library_id, $property)
	tripal_library_insert_property ($library_id, $property, $value, $update_if_present=0)
	tripal_library_update_property ($library_id, $property, $value, $insert_if_missing=0)
	tripal_library_delete_property ($library_id, $property)
	get_chado_libraries ()

---

Function Documentation

get_chado_libraries

(

)

This function uses library_id's of all drupal library nodes as input and pull the library information (name, uniquename, type, genus, species, common_name, description) from chado database. The return type is an object array that stores sorted $library objects

This function is DEPRECATED Please use tripal_core_chado_generate_vars

Definition at line 1561 of file tripal_library.module.

References tripal_db_set_active().

Referenced by tripal_library_show_libraries().

tripal_library_delete_property	(	$	library_id,
		$	property
	)

Delete a given property

Parameters:

$library_id	The library_id of the property to delete
$property	The cvterm name of the property to delete

Note: The property will be identified using the unique combination of the $library_id and $property and then it will be deleted

Returns:

True of success, False otherwise

Definition at line 190 of file tripal_library.api.inc.

References tripal_core_delete_property().

tripal_library_get_property	(	$	library_id,
		$	property
	)

Retrieve properties of a given type for a given library

Parameters:

$library_id	The library_id of the properties you would like to retrieve
$property	The cvterm name of the properties to retrieve

Returns:

An library chado variable with the specified properties expanded

Definition at line 126 of file tripal_library.api.inc.

References tripal_core_get_property().

Referenced by chado_library_form().

tripal_library_insert_property	(	$	library_id,
		$	property,
		$	value,
		$	update_if_present = 0
	)

Insert a given property

Parameters:

$library_id	The library_id of the property to insert
$property	The cvterm name of the property to insert
$value	The value of the property to insert
$update_if_present	A boolean indicated whether to update the record if it's already present

Returns:

True of success, False otherwise

Definition at line 147 of file tripal_library.api.inc.

References tripal_core_insert_property().

Referenced by chado_library_insert().

tripal_library_update_property	(	$	library_id,
		$	property,
		$	value,
		$	insert_if_missing = 0
	)

Update a given property

Parameters:

$library_id	The library_id of the property to update
$property	The cvterm name of the property to update
$value	The value of the property to update
$insert_if_missing	A boolean indicated whether to insert the record if it's absent

Note: The property will be identified using the unique combination of the $library_id and $property and then it will be updated with the supplied value

Returns:

True of success, False otherwise

Definition at line 171 of file tripal_library.api.inc.

References tripal_core_update_property().

Referenced by chado_library_update().