function tripal_get_organism

2.x tripal_organism.api.inc tripal_get_organism($identifiers, $options = array())
3.x tripal_chado.module.DEPRECATED.api.inc tripal_get_organism($identifiers, $options = array())

Retrieves a chado organism variable.

Parameters

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

  • organism_id: the chado organism.organism_id primary key.
  • genus & species: the chado organism.genus field & organism.species field.

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 organism record to be returned.

Return value

If unique values were passed in as an identifier then an object describing the organism will be returned (will be a chado variable from chado_generate_var()). Otherwise, FALSE will be returned.

2 calls to tripal_get_organism()
2 string references to 'tripal_get_organism'

File

tripal_chado/api/modules/tripal_chado.module.DEPRECATED.api.inc, line 878
These api functions are deprecated, if your site is currently using them please update your code with the newer tripal_chado functions.

Code

function tripal_get_organism($identifiers, $options = array()) {
  chado_get_organism($identifiers, $options);
}