Tripal v1.0 (6.x-1.0)
Project Module API

Functions

 tripal_project_get_property ($project_id, $property)
 tripal_project_insert_property ($project_id, $property, $value, $update_if_present=0)
 tripal_project_update_property ($project_id, $property, $value, $insert_if_missing=0)
 tripal_project_delete_property ($project_id, $property)

Function Documentation

tripal_project_delete_property ( project_id,
property 
)

Delete a given property

Parameters:
$project_idThe project_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 $project_id and $property and then it will be deleted

Returns:
True of success, False otherwise

Definition at line 89 of file tripal_project.api.inc.

                                                                {
  return tripal_core_delete_property('project', $project_id, $property, 'tripal');
}
tripal_project_get_property ( project_id,
property 
)

Retrieve properties of a given type for a given project

Parameters:
$project_idThe project_id of the properties you would like to retrieve
$propertyThe cvterm name of the properties to retrieve
Returns:
An project chado variable with the specified properties expanded

Definition at line 25 of file tripal_project.api.inc.

                                                             {
  return tripal_core_get_property('project', $project_id, $property, 'tripal');
}
tripal_project_insert_property ( project_id,
property,
value,
update_if_present = 0 
)

Insert a given property

Parameters:
$project_idThe project_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 46 of file tripal_project.api.inc.

                                                                                                {
  return tripal_core_insert_property('project', $project_id, $property, 'tripal', $value, $update_if_present);
}
tripal_project_update_property ( project_id,
property,
value,
insert_if_missing = 0 
)

Update a given property

Parameters:
$project_idThe project_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 $project_id and $property and then it will be updated with the supplied value

Returns:
True of success, False otherwise

Definition at line 70 of file tripal_project.api.inc.

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