Adds a controlled vocabulary to the CV table of Chado.

Parameters

$name: The name of the controlled vocabulary. These are typically all lower case with no special characters other than an undrescore (for spaces).

$comment: A description or definition of the vocabulary.

Return value

An object populated with fields from the newly added database.

Related topics

File

tripal_chado/api/modules/tripal_chado.cv.api.inc, line 844

Provides API functions specificially for managing controlled vocabulary records in Chado.

Code

function chado_insert_cv($name, $definition) {

  // Insert/update values.
  $ins_values = array(
    'name' => $name,
    'definition' => $definition
  );

  // See if the CV default exists already in the database.
  $sel_values = array('name' => $name);
  $results = chado_select_record('cv', array('*'), $sel_values);

  // If it does not exists then add it.
  if (count($results) == 0) {
    $success = chado_insert_record('cv', $ins_values);
    if (!$success) {
      tripal_report_error('tripal_chado', TRIPAL_WARNING, "Failed to create the CV record", NULL);
      return FALSE;
    }
    $results = chado_select_record('cv', array('*'), $sel_values);
  }
  // If it already exists then do an update.
  else {
    $success = chado_update_record('cv', $sel_values, $ins_values);
    if (!$success) {
      tripal_report_error('tripal_chado', TRIPAL_WARNING, "Failed to update the CV record", NULL);
      return FALSE;
    }
    $results = chado_select_record('cv', array('*'), $sel_values);
  }

  // Return the cv object.
  return $results[0];
}