Tripal Entities

Functions
	tripal_get_default_title_format ($bundle)
	tripal_replace_entity_tokens ($string, &$entity, $bundle_entity=NULL)
	tripal_tripal_cron_notification ()

Detailed Description

Provides an application programming interface (API) for working with TripalEntity content types (bundles) and their entities.

Bundles (Content Types): Bundles are types of content in a Drupal site. By default, Drupal provides the Basic Page and Article content types, and Drupal allows a site developer to create new content types on-the-fly using the administrative interface–no programming required. Tripal also provides several Content Type by default. During installation of Tripal the Organism, Gene, Project, Analysis and other content types are created automatically. The site developer can then create new content types for different biological data–again, without any programming required.

In order to to assist with data exchange and use of common data formats, Tripal Bundles are defined using a controlled vocabulary term (cvterm). For example, a "Gene" Bundle is defined using the Sequence Ontology term for gene whose term accession is: SO:0000704. This mapping allows Tripal to compare content across Tripal sites, and expose data to computational tools that understand these vocabularies. By default, Tripal uses Chado as its primary data storage back-end.

Entity: An entity is a discrete data record. Entities are most commonly seen as "pages" on a Drupal web site and are instances of a Bundle (i.e content type). When data is published on a Tripal site such as organisms, genes, germplasm, maps, etc., each record is represented by a single entity with an entity ID as its only attribute. All other information that the entity provides is made available via Fields.

For more information please see: http://tripal.info/tutorials/v3.x/developers-handbook/structure

Function Documentation

tripal_get_default_title_format()

tripal_get_default_title_format

(

$bundle

)

Determine the default title format to use for an entity.

Parameters

TripalBundle

$bundle

The Entity object for the Tripal Bundle that the title format is for.

Returns

string A default title format.

tripal_replace_entity_tokens()

tripal_replace_entity_tokens	(		$string,
		&	$entity,
			$bundle_entity = NULL
	)

Replace all Tripal Tokens in a given string.

NOTE: If there is no value for a token then the token is removed.

Parameters

string	$string	The string containing tokens.
TripalEntity	$entity	The entity with field values used to find values of tokens.
TripalBundle	$bundle_entity	The bundle entity containing special values sometimes needed for token replacement.

Returns

The string will all tokens replaced with values.

tripal_tripal_cron_notification()

tripal_tripal_cron_notification

(

)

Refreshes the bundle such that new fields added by modules will be found during cron.