function hook_vocab_storage_info
3.x tripal.terms.api.inc | hook_vocab_storage_info() |
A hook for specifying information about the data store for vocabularies.
The storage backend for controlled vocabularies has traditionally been the Chado CV term tables. However, Tripal v3.0 introduces APIs for supporting other backends. Therefore, this function indicates to Tripal which data stores are capable of providing support for terms.
Return value
An array describing the storage backends implemented by the module. The keys are storage backend names. To avoid name clashes, storage backend names should be prefixed with the name of the module that exposes them. The values are arrays describing the storage backend, with the following key/value pairs:
label: The human-readable name of the storage backend. module: The name of the module providing the support for this backend. description: A short description for the storage backend. settings: An array whose keys are the names of the settings available for the storage backend, and whose values are the default values for those settings.
Related topics
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- tripal_chado_vocab_storage_info in tripal_chado/
includes/ tripal_chado.vocab_storage.inc - Implements hook_vocab_storage_info().
- tripal_add_term in tripal/
api/ tripal.terms.api.inc - Adds a term to the vocabulary storage backend.
- tripal_admin_add_type_form in tripal/
includes/ TripalBundleUIController.inc - Form for creating tripal data types.
- tripal_admin_add_type_form_submit in tripal/
includes/ TripalBundleUIController.inc - Implements hook_submit() for the tripal_admin_add_type_form.
- tripal_admin_add_type_form_validate in tripal/
includes/ TripalBundleUIController.inc - Implements hook_validate() for the tripal_admin_add_type_form.
- tripal_get_term_children in tripal/
api/ tripal.terms.api.inc - Retrieves the immediate children of the given term.
File
- tripal/
api/ tripal.terms.api.inc, line 54 - Provides an application programming interface (API) for working with controlled vocaublary terms.
Code
function hook_vocab_storage_info() {
return array(
'term_chado_storage' => array(
'label' => t('Chado'),
'description' => t('Integrates terms stored in the local Chado database with Tripal entities.'),
'settings' => array(),
),
);
}