Adds a new variable name.

Parameters

$name: The name of the variable

$description: The description for the variable

Return value

A record object containg the variable that was added if successful.

Related topics

File

tripal/api/tripal.variables.api.inc, line 36

Provides an application programming interface (API) for managing variables associated with Tripal managed content.

Code

function tripal_insert_variable($name, $description) {
  $name = trim($name);
  if (!$name) {
    tripal_report_error('tripal', TRIPAL_ERROR, 
    'Must have a variable name when adding a new Tripal Variable.', array());
    return NULL;
  }
  if (!$description) {
    tripal_report_error('tripal', TRIPAL_ERROR, 
    'Must have a description when adding a new Tripal Variable.', array());
    return NULL;
  }

  // Make sure the variable is not a duplicate. If so, then just select
  // it and return the variable_id
  $variable = tripal_get_variable($name);
  if ($variable) {
    return $variable;
  }
  else {
    db_insert('tripal_variables')
      ->fields(array(
        'name' => $name,
        'description' => $description,
      ))
      ->execute();
    return tripal_get_variable($name);
  }
}