function tripal_get_stock
2.x tripal_stock.api.inc | tripal_get_stock($identifiers, $options = array()) |
3.x tripal_chado.module.DEPRECATED.api.inc | tripal_get_stock($identifiers, $options = array()) |
Retrieves a chado stock variable
Parameters
$identifier: An array with the key stating what the identifier is. Supported keys (only one of the following unique keys is required):
- stock_id: the chado stock.stock_id primary key
- nid: the drupal nid of the stock
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
If unique values were passed in as an identifier then an object describing the stock will be returned (will be a chado variable from chado_generate_var()). Otherwise, FALSE will be returned.
2 calls to tripal_get_stock()
- tripal_stock_get_stock_by_nid in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc - tripal_stock_get_stock_by_stock_id in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc
4 string references to 'tripal_get_stock'
- tripal_stock_get_stocks_by_stockprop in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc - tripal_stock_get_stock_by_name_identifier in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc - tripal_stock_get_stock_by_nid in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc - tripal_stock_get_stock_by_stock_id in legacy/
tripal_stock/ api/ tripal_stock.DEPRECATED.inc
File
- tripal_chado/
api/ modules/ tripal_chado.module.DEPRECATED.api.inc, line 1499 - 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_stock($identifiers, $options = array()) {
chado_get_stock($identifiers, $options);
}