Collaboration diagram for Chado Analysis:
Functions | |
| chado_autocomplete_analysis ($string='') | |
| chado_get_analysis ($identifier, $options) | |
| chado_get_analysis_select_options ($syncd_only=TRUE) | |
Detailed Description
Provides API functions for working with analysis records in Chado that go beyond the generic Chado API functions.
Function Documentation
◆ chado_autocomplete_analysis()
| chado_autocomplete_analysis | ( | $string = '' | ) |
Used for autocomplete in forms for identifying analyses
- Parameters
-
$string The string to search for.
- Returns
- A json array of terms that begin with the provided string.
◆ chado_get_analysis()
| chado_get_analysis | ( | $identifier, | |
| $options | |||
| ) |
Retrieves a chado analysis variable.
- Parameters
-
$identifier 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. NOTE: the $identifier parameter can be any array similar to $values passed into chado_select_record(). It should fully specify the stock record to be returned.
$options An array of options. Supported keys include: - Any keys supported by chado_generate_var(). See that function definition for additional details.
- Returns
- the analysis node matching the passed in identifier
◆ chado_get_analysis_select_options()
| chado_get_analysis_select_options | ( | $syncd_only = TRUE | ) |
Returns a list of analyses that are currently synced with Drupal to use in select lists.
- Parameters
-
$syncd_only Whether or not to return all chado analyses or just those sync'd with drupal. Defaults to TRUE (only sync'd analyses).
- Returns
- An array of analyses sync'd with Drupal where each value is the analysis scientific name and the keys are analysis_id's.
