function tripal_get_analysis

2.x tripal_analysis.api.inc tripal_get_analysis($identifier, $options)

Retrieves an chado analysis variable

Parameters

$itentifier: an array with the key stating what the identifier is. Supported keys (only on of the following unique keys is required):

  • analysis_id: the chado analysis.analysis_id primary key
  • nid: the drupal node.nid primary key

There are also some specially handled keys. They are:

  • property: An array/object describing the property to select records for. It should at least have either a type_name (if unique across cvs) or type_id. Other supported keys include: cv_id/cv_name (of the type), value and rank

$options: An array of options. Supported keys include:

  • Any keys supported by chado_generate_var(). See that function definition for additional details.

NOTE: the $identifier parameter can really be any array similar to $values passed into chado_select_record(). It should fully specify the stock record to be returned.

Return value

the analysis node matching the passed in identifier

Related topics

1 call to tripal_get_analysis()
1 string reference to 'tripal_get_analysis'

File

tripal_analysis/api/tripal_analysis.api.inc, line 73
Provides functions for managing analysis'.

Code

function tripal_get_analysis($identifier, $options) {

  // Set Defaults
  if (!isset($options['include_fk'])) {
    // Tells chado_generate_var not to follow any foreign keys
    $options['include_fk'] = array();
  }

  // Error Checking of parameters
  if (!is_array($identifiers)) {
    tripal_report_error(
    'tripal_stock_api', 
    TRIPAL_ERROR, 
    "chado_get_stock: The identifier passed in is expected to be an array with the key
        matching a column name in the analysis table (ie: analysis_id or name). You passed in %identifier.", 
    array(
      '%identifier' => print_r($identifiers, TRUE)
    )
    );
  }
  elseif (empty($identifiers)) {
    tripal_report_error(
    'tripal_stock_api', 
    TRIPAL_ERROR, 
    "chado_get_stock: You did not pass in anything to identify the analysis you want. The identifier
        is expected to be an array with the key matching a column name in the analysis table
        (ie: stock_id or name). You passed in %identifier.", 
    array(
      '%identifier' => print_r($identifiers, TRUE)
    )
    );
  }

  // If one of the identifiers is property then use chado_get_record_with_property()
  if (isset($identifiers['property'])) {
    $property = $identifiers['property'];
    unset($identifiers['property']);
    $analysis = chado_get_record_with_property(
    array('table' => 'analysis', 'base_records' => $identifiers), 
    array('type_name' => $property)
    );
  }

  // Else we have a simple case and we can just use chado_generate_var to get the analysis
  else {

    // Try to get the analysis
    $analysis = chado_generate_var(
    'analysis', 
    $identifiers, 
    $options
    );
  }

  // Ensure the analysis is singular. If it's an array then it is not singular
  if (is_array($analysis)) {
    tripal_report_error(
    'tripal_analysis_api', 
    TRIPAL_ERROR, 
    "tripal_get_analysis: The identifiers you passed in were not unique. You passed in %identifier.", 
    array(
      '%identifier' => print_r($identifiers, TRUE)
    )
    );
  }

  // Report an error if $analysis is FALSE since then chado_generate_var has failed
  elseif ($analysis === FALSE) {
    tripal_report_error(
    'tripal_analysis_api', 
    TRIPAL_ERROR, 
    "tripal_get_analysis: chado_generate_var() failed to return a analysis based on the identifiers
        you passed in. You should check that your identifiers are correct, as well as, look
        for a chado_generate_var error for additional clues. You passed in %identifier.", 
    array(
      '%identifier' => print_r($identifiers, TRUE)
    )
    );
  }

  // Else, as far we know, everything is fine so give them their analysis :)
  else {
    return $analysis;
  }
}