Tripal v1.0 (6.x-1.0)
Organism 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)

Function Documentation

tripal_library_delete_property ( library_id,
property 
)

Delete a given property

Parameters:
$library_idThe library_id of the property to delete
$propertyThe 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 87 of file tripal_library.api.inc.

                                                                {
  return tripal_core_delete_property('library', $library_id, $property, 'tripal');
}
tripal_library_get_property ( library_id,
property 
)

Retrieve properties of a given type for a given library

Parameters:
$library_idThe library_id of the properties you would like to retrieve
$propertyThe cvterm name of the properties to retrieve
Returns:
An library chado variable with the specified properties expanded

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

                                                             {
  return tripal_core_get_property('library', $library_id, $property, 'tripal');
}
tripal_library_insert_property ( library_id,
property,
value,
update_if_present = 0 
)

Insert a given property

Parameters:
$library_idThe library_id of the property to insert
$propertyThe cvterm name of the property to insert
$valueThe value of the property to insert
$update_if_presentA boolean indicated whether to update the record if it's already present
Returns:
True of success, False otherwise

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

                                                                                                {
  return tripal_core_insert_property('library', $library_id, $property, 'tripal', $value, $update_if_present);
}
tripal_library_update_property ( library_id,
property,
value,
insert_if_missing = 0 
)

Update a given property

Parameters:
$library_idThe library_id of the property to update
$propertyThe cvterm name of the property to update
$valueThe value of the property to update
$insert_if_missingA 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 68 of file tripal_library.api.inc.

                                                                                                {
  return tripal_core_update_property('library', $library_id, $property, 'tripal', $value, $insert_if_missing);
}
 All Classes Files Functions Variables