CV Terms

Tripal provides an application programming interface (API) for working with controlled vocaublary terms. Tripal v3 is highly dependent on controlled vocabularies for identifying all content types and fields attached to those content types. However, Tripal v3 is also database agnostic. Therefore, controlled vocabularies can be stored in any database back-end. By default the tripal_chado module is used for storing controlled vocabularies. However, if someone wanted to store controlled vocabularies in a database other than Chado they can do so. These API functions provide a convenient wrapper for accession controlled vocabularies no matter where they are stored.

Parent topics

Tripal API
Tripal provides an application programming interface (API) to support customizations and creation of new extensions. @

File

tripal/api/tripal.terms.api.inc, line 8
Provides an application programming interface (API) for working with controlled vocaublary terms.

Functions

Namesort descending Location Description
hook_vocab_add_term tripal/api/tripal.terms.api.inc Hook used by the default term storage backend to add new terms.
hook_vocab_get_root_terms tripal/api/tripal.terms.api.inc Hook used by the default term storage backend to provide root terms.
hook_vocab_get_term tripal/api/tripal.terms.api.inc Hook used by the default term storage backend to provide details for a term.
hook_vocab_get_terms tripal/api/tripal.terms.api.inc Retrieves a paged list of terms from a vocabulary.
hook_vocab_get_term_children tripal/api/tripal.terms.api.inc Hook used by the default term storage backend to provide children for a term.
hook_vocab_get_vocabularies tripal/api/tripal.terms.api.inc Retrieves the list of vocabularies that are available on the site.
hook_vocab_get_vocabulary tripal/api/tripal.terms.api.inc Hook used by the default term storage backend to provide details for a vocab.
hook_vocab_import_form tripal/api/tripal.terms.api.inc Provides a form for importing vocabularies and their terms.
hook_vocab_import_form_submit tripal/api/tripal.terms.api.inc Submits the hook_vocab_import_form().
hook_vocab_import_form_validate tripal/api/tripal.terms.api.inc Validates the hook_vocab_import_form().
hook_vocab_select_term_form tripal/api/tripal.terms.api.inc Creates a form for specifying a term for TripalEntity creation.
hook_vocab_select_term_form_validate tripal/api/tripal.terms.api.inc Validates the hook_vocab_select_term_form().
hook_vocab_storage_info tripal/api/tripal.terms.api.inc A hook for specifying information about the data store for vocabularies.
tripal_add_term tripal/api/tripal.terms.api.inc Adds a term to the vocabulary storage backend.
tripal_get_term_children tripal/api/tripal.terms.api.inc Retrieves the immediate children of the given term.
tripal_get_term_details tripal/api/tripal.terms.api.inc Retrieves full information about a vocabulary term.
tripal_get_term_lookup_form tripal/api/tripal.terms.api.inc Provides a term lookup form.
tripal_get_term_lookup_form_ajax_callback tripal/api/tripal.terms.api.inc Implements an AJAX callback for the tripal_chado_vocab_select_term_form.
tripal_get_term_lookup_form_result tripal/api/tripal.terms.api.inc Returns the terms selected from the tripal_get_term_lookup_form.
tripal_get_vocabularies tripal/api/tripal.terms.api.inc Retrieves the list of vocabularies that are available on the site.
tripal_get_vocabulary_details tripal/api/tripal.terms.api.inc Retrieves full information about a vocabulary.
tripal_get_vocabulary_root_terms tripal/api/tripal.terms.api.inc Retrieves the immediate children of the given term.
tripal_get_vocabulary_terms tripal/api/tripal.terms.api.inc Retrieves a paged list of terms from a vocabulary.