Tripal
All Classes Files Functions Variables Modules Pages
Functions
Variables

Functions

 tripal_insert_variable ($name, $description)
 
 tripal_get_variable ($name)
 

Detailed Description

Provides an application programming interface (API) for managing variables associated with Tripal managed content. The Tripal Variables API supports storing any type of variable such as a property or setting that should be associated with a Tripal managed content. Variables are meant to store non-biological information only because biological data should be stored together in the primary data store (e.g. Chado). Be aware that any data stored as a Tripal Variable will not be made visible through services such as Tripal Web Services and therefore can be a good place to hide application specific settings.

Function Documentation

◆ tripal_get_variable()

tripal_get_variable (   $name)

Retrieves the variable name record.

Parameters
$nameThe name of the variable to retrieve
Returns
A record object containing the variable.

◆ tripal_insert_variable()

tripal_insert_variable (   $name,
  $description 
)

Adds a new variable name.

Parameters
$nameThe name of the variable
$descriptionThe description for the variable
Returns
A record object containing the variable that was added if successful.