Retrieve a property for a given base table record

Parameters

$basetable: The base table for which the property should be retrieved. Thus to retrieve a property for a feature the basetable=feature and property is retrieved from featureprop

$record_id: The foriegn key field of the base table. This should be in integer.

$property: The cvterm name describing the type of properties to be retrieved

$cv_name: The name of the cv that the above cvterm is part of

Return value

An array in the same format as that generated by the function tripal_core_generate_chado_var(). If only one record is returned it is a single object. If more than one record is returned then it is an array of objects

Related topics

File

tripal_core/api/tripal_core_chado.api.inc, line 2570

The Tripal Core API

Code

function tripal_core_get_property($basetable, $record_id, $property, $cv_name) {
  // get the foreign key for this property table
  $table_desc = tripal_core_get_chado_table_schema($basetable . 'prop');
  $fkcol = key($table_desc['foreign keys'][$basetable]['columns']);

  // construct the array of values to be selected
  $values = array(
    $fkcol => $record_id,
    'type_id' => array(
      'cv_id' => array(
        'name' => $cv_name,
      ),
      'name' => $property,
      'is_obsolete' => 0
    ),
  );
  $results = tripal_core_generate_chado_var($basetable . 'prop', $values);
  if ($results) {
    $results = tripal_core_expand_chado_vars($results, 'field', $basetable . 'prop.value');
  }

  return $results;
}