Tripal 0.3b
Feature

Classes

class  views_handler_field_computed_feature_nid
class  views_handler_field_residues

Modules

 Feature Views Integration

Functions

if(isset($arguments['i'])) tripal_features_reindex ($max_sync, $job_id=NULL)
 tripal_feature_index_feature ($feature_id, $nid)
 tripal_feature_sync_features ($max_sync=0, $job_id=NULL)
 tripal_feature_sync_feature ($feature_id)
 organism_get_synced ()
 tripal_feature_add_ALL_dbreferences_page ($node)
 tripal_feature_add_ONE_dbreference_form ($form_state, $node)
 tripal_feature_add_ONE_dbreference_form_validate ($form, &$form_state)
 tripal_feature_add_ONE_dbreference_form_submit ($form, &$form_state)
 tripal_feature_edit_ALL_dbreferences_page ($node)
 tripal_feature_edit_ALL_db_references_form ($form_state, $node)
 tripal_feature_edit_ALL_db_references_form_submit ($form, &$form_state)
 tripal_feature_update_db_reference ($dbxref_id, $db_id, $accession)
 tripal_feature_delete_db_reference ($dbxref_id)
 theme_tripal_feature_edit_ALL_db_references_form ($form)
 list_dbreferences_for_node ($db_references)
 tripal_getfeature_add_ALL_property_page ($node)
 tripal_feature_add_ONE_property_form ($form_state, $node)
 tripal_feature_add_ONE_property_form_validate ($form, &$form_state)
 tripal_feature_add_ONE_property_form_submit ($form, &$form_state)
 tripal_feature_edit_ALL_properties_page ($node)
 tripal_feature_edit_ALL_properties_form ($form_state, $node)
 tripal_feature_edit_ALL_properties_form_submit ($form, &$form_state)
 tripal_feature_update_property ($featureprop_id, $cvterm_id, $value, $preferred, $nid)
 tripal_feature_delete_property ($featureprop_id)
 theme_tripal_feature_edit_ALL_properties_form ($form)
 list_properties_for_node ($properties)
 tripal_feature_add_ALL_relationships_page ($node)
 tripal_feature_add_ONE_relationship_form ($form_state, $node)
 tripal_feature_add_ONE_relationship_form_validate ($form, &$form_state)
 tripal_feature_add_ONE_relationship_form_submit ($form, &$form_state)
 tripal_feature_edit_ALL_relationships_page ($node)
 tripal_feature_edit_ALL_relationships_form ($form_state, $node)
 tripal_feature_edit_ALL_relationships_form_validate ($form, &$form_state)
 tripal_feature_edit_ALL_relationships_form_submit ($form, &$form_state)
 tripal_feature_update_relationship ($stock_relationship_id, $subject_id, $cvterm_id, $object_id)
 tripal_feature_delete_relationship ($stock_relationship_id)
 theme_tripal_feature_edit_ALL_relationships_form ($form)
 tripal_feature_list_relationships_for_node ($feature_name, $subject_relationships, $object_relationships)
 tripal_feature_implement_back_to_feature_button ($form_state, $nid)
 tripal_feature_implement_back_to_feature_button_submit ($form, $form_state)
 tripal_feature_implement_add_chado_properties_progress ($current)
 tripal_feature_implement_add_chado_properties_navigate ($form_state, $step, $nid)
 tripal_feature_implement_add_chado_properties_navigate_submit ($form, $form_state)
 tripal_feature_is_obsolete_form ($node, $stock_id)
 tripal_feature_is_obsolete_form_submit ($form, &$form_state)
 tripal_feature_module_description_page ()
 tripal_feature_admin ()
 tripal_feature_admin_validate ($form, &$form_state)
 get_tripal_feature_admin_form_cleanup_set (&$form)
 get_tripal_feature_admin_form_reindex_set (&$form)
 get_tripal_feature_admin_form_taxonomy_set (&$form)
 get_tripal_feature_admin_form_sync_set (&$form)
 tripal_feature_aggregator_page ()
 tripal_feature_aggregator_select_form ()
 tripal_feature_aggregator_form (&$form_state=NULL, $type_id=NULL)
 tripal_feature_aggregator_form_validate ($form, &$form_state)
 tripal_feature_aggregator_form_submit ($form, &$form_state)
 tripal_feature_aggregator_ajax_edit ()
 tripal_feature_install ()
 tripal_feature_update_6000 ()
 tripal_feature_update_6300 ()
 tripal_feature_add_organism_count_mview ()
 tripal_feature_schema ()
 tripal_feature_uninstall ()
 tripal_feature_get_schemas ($table=NULL)
 tripal_feature_requirements ($phase)
 tripal_feature_init ()
 tripal_feature_views_api ()
 tripal_feature_help ($path, $arg)
 tripal_feature_node_info ()
 tripal_feature_perm ()
 chado_feature_access ($op, $node, $account)
 tripal_feature_menu ()
 tf_node_load ($nid)
 tripal_feature_block ($op= 'list', $delta=0, $edit=array())
 chado_feature_insert ($node)
 chado_feature_update ($node)
 chado_feature_delete ($node)
 chado_feature_add_synonyms ($synonyms, $feature_id)
 chado_feature_add_gbaccession ($accession, $feature_id)
 chado_feature_form ($node, $param)
 chado_feature_validate ($node)
 chado_feature_load ($node)
 tripal_feature_load_organism ($organism_id)
 tripal_feature_load_synonyms ($feature_id)
 tripal_feature_load_properties ($feature_id)
 tripal_feature_load_references ($feature_id)
 tripal_feature_load_featurelocs ($feature_id, $side= 'as_parent', $aggregate=1)
 tripal_feature_sort_locations ($a, $b)
 tripal_feature_load_relationships ($feature_id, $side= 'as_subject')
 tripal_feature_get_aggregate_types ($feature_id)
 tripal_feature_get_aggregate_relationships ($feature_id, $substitute=1, $levels=0, $base_type_id=NULL, $depth=0)
 tripal_feature_load_featureloc_sequences ($feature_id, $featurelocs)
 tripal_feature_load_organism_feature_counts ($organism)
 tripal_feature_load_organism_feature_browser ($organism)
 tripal_feature_sort_rel_objects ($a, $b)
 tripal_feature_sort_rel_parts ($a, $b)
 tripal_feature_color_sequence ($sequence, $parts)
 chado_feature_view ($node, $teaser=FALSE, $page=FALSE)
 tripal_feature_nodeapi (&$node, $op, $teaser, $page)
 tripal_feature_theme ()
 tripal_feature_preprocess_tripal_organism_feature_counts (&$variables)
 tripal_feature_preprocess_tripal_organism_feature_browser (&$variables)
 tripal_feature_cv_chart ($chart_id)
 tripal_feature_cv_tree ($tree_id)
 theme_tripal_feature_search_index ($node)
 theme_tripal_feature_search_results ($node)
 tripal_feature_set_vocabulary ()
 tripal_feature_del_vocabulary ()
 tripal_features_set_taxonomy ($max_sync=0, $job_id=NULL)
 tripal_feature_set_taxonomy ($node, $feature_id)
 tripal_features_cleanup ($dummy=NULL, $job_id=NULL)
 tripal_feature_return_fasta ($feature, $desc)
 tripal_feature_job_describe_args ($callback, $args)

Detailed Description

Provides functions for managing chado features including creating details pages for each feature


Function Documentation

chado_feature_access ( op,
node,
account 
)

Set the permission types that the module uses.

Definition at line 121 of file tripal_feature.module.

chado_feature_add_gbaccession ( accession,
feature_id 
)

Definition at line 608 of file tripal_feature.module.

References tripal_db_set_active().

chado_feature_add_synonyms ( synonyms,
feature_id 
)

Definition at line 541 of file tripal_feature.module.

References tripal_db_set_active().

Referenced by chado_feature_insert(), and chado_feature_update().

chado_feature_delete ( node)

Definition at line 506 of file tripal_feature.module.

References chado_get_id_for_node(), and tripal_db_set_active().

chado_feature_form ( node,
param 
)
chado_feature_insert ( node)

When a new chado_feature node is created we also need to add information to our chado_feature table. This function is called on insert of a new node of type 'chado_feature' and inserts the necessary information.

Definition at line 391 of file tripal_feature.module.

References chado_feature_add_synonyms(), tripal_core_chado_insert(), and tripal_core_chado_select().

chado_feature_load ( node)

When a node is requested by the user this function is called to allow us to add auxiliary data to the node object.

Definition at line 902 of file tripal_feature.module.

References chado_get_id_for_node(), and tripal_core_generate_chado_var().

chado_feature_update ( node)
chado_feature_validate ( node)

Definition at line 844 of file tripal_feature.module.

References tripal_db_set_active().

chado_feature_view ( node,
teaser = FALSE,
page = FALSE 
)

This function customizes the view of the chado_feature node. It allows us to generate the markup.

Definition at line 1471 of file tripal_feature.module.

get_tripal_feature_admin_form_cleanup_set ( &$  form)

Definition at line 364 of file tripal_feature.admin.inc.

Referenced by tripal_feature_admin().

get_tripal_feature_admin_form_reindex_set ( &$  form)

Definition at line 394 of file tripal_feature.admin.inc.

Referenced by tripal_feature_admin().

get_tripal_feature_admin_form_sync_set ( &$  form)

Definition at line 466 of file tripal_feature.admin.inc.

References tripal_db_set_active(), and tripal_organism_get_synced().

Referenced by tripal_feature_admin().

get_tripal_feature_admin_form_taxonomy_set ( &$  form)

Definition at line 420 of file tripal_feature.admin.inc.

Referenced by tripal_feature_admin().

list_dbreferences_for_node ( db_references)
list_properties_for_node ( properties)

Definition at line 338 of file tripal_feature-properties.inc.

organism_get_synced ( )

Returns a list of organisms that are currently synced with Drupal

Definition at line 325 of file syncFeatures.php.

References tripal_db_set_active().

Referenced by tripal_feature_sync_features().

tf_node_load ( nid)

Implements Menu wildcard_load hook Purpose: Allows the node ID of a chado feature to be dynamically pulled from the path. The node is loaded from this node ID and supplied to the page as an arguement

Definition at line 281 of file tripal_feature.module.

theme_tripal_feature_edit_ALL_db_references_form ( form)

Definition at line 316 of file tripal_feature-db_references.inc.

theme_tripal_feature_edit_ALL_properties_form ( form)

Definition at line 312 of file tripal_feature-properties.inc.

theme_tripal_feature_edit_ALL_relationships_form ( form)

Definition at line 472 of file tripal_feature-relationships.inc.

theme_tripal_feature_search_index ( node)

This function is an extension of the chado_feature_view by providing the markup for the feature object THAT WILL BE INDEXED.

Definition at line 1667 of file tripal_feature.module.

theme_tripal_feature_search_results ( node)

This function is an extension of the chado_feature_view by providing the markup for the feature object THAT WILL BE INDEXED.

Definition at line 1696 of file tripal_feature.module.

tripal_feature_add_ALL_dbreferences_page ( node)
tripal_feature_add_ALL_relationships_page ( node)
tripal_feature_add_ONE_dbreference_form ( form_state,
node 
)

Implements Hook_form() Handles adding of Database References to features

Definition at line 28 of file tripal_feature-db_references.inc.

References tripal_db_get_db_options().

tripal_feature_add_ONE_dbreference_form_submit ( form,
&$  form_state 
)
tripal_feature_add_ONE_dbreference_form_validate ( form,
&$  form_state 
)

Definition at line 80 of file tripal_feature-db_references.inc.

References tripal_db_set_active().

tripal_feature_add_ONE_property_form ( form_state,
node 
)

Definition at line 27 of file tripal_feature-properties.inc.

References tripal_cv_get_cvterm_options().

tripal_feature_add_ONE_property_form_submit ( form,
&$  form_state 
)

Definition at line 108 of file tripal_feature-properties.inc.

References get_max_chado_rank(), and tripal_db_set_active().

tripal_feature_add_ONE_property_form_validate ( form,
&$  form_state 
)

Definition at line 74 of file tripal_feature-properties.inc.

References tripal_db_set_active().

tripal_feature_add_ONE_relationship_form ( form_state,
node 
)

Implements Hook_form() Handles adding of Relationships to Features

Definition at line 29 of file tripal_feature-relationships.inc.

References tripal_cv_get_cv_by_name(), and tripal_cv_get_cvterm_options().

tripal_feature_add_ONE_relationship_form_submit ( form,
&$  form_state 
)

Definition at line 174 of file tripal_feature-relationships.inc.

tripal_feature_add_ONE_relationship_form_validate ( form,
&$  form_state 
)

Definition at line 106 of file tripal_feature-relationships.inc.

References tripal_db_set_active().

tripal_feature_add_organism_count_mview ( )
tripal_feature_admin_validate ( form,
&$  form_state 
)

Definition at line 316 of file tripal_feature.admin.inc.

References $user, and tripal_add_job().

tripal_feature_aggregator_ajax_edit ( )

Definition at line 790 of file tripal_feature.admin.inc.

tripal_feature_aggregator_form ( &$  form_state = NULL,
type_id = NULL 
)

Definition at line 596 of file tripal_feature.admin.inc.

References tripal_db_set_active().

tripal_feature_aggregator_form_submit ( form,
&$  form_state 
)

Definition at line 720 of file tripal_feature.admin.inc.

References tripal_db_set_active().

tripal_feature_aggregator_form_validate ( form,
&$  form_state 
)

Definition at line 670 of file tripal_feature.admin.inc.

References tripal_db_set_active().

tripal_feature_aggregator_page ( )

Definition at line 546 of file tripal_feature.admin.inc.

tripal_feature_aggregator_select_form ( )

Definition at line 559 of file tripal_feature.admin.inc.

References tripal_db_set_active().

tripal_feature_block ( op = 'list',
delta = 0,
edit = array() 
)

Definition at line 295 of file tripal_feature.module.

tripal_feature_color_sequence ( sequence,
parts 
)

Definition at line 1409 of file tripal_feature.module.

Referenced by tripal_feature_load_featureloc_sequences().

tripal_feature_cv_chart ( chart_id)

Definition at line 1619 of file tripal_feature.module.

tripal_feature_cv_tree ( tree_id)

Definition at line 1642 of file tripal_feature.module.

References tripal_cv_get_cv_id().

tripal_feature_del_vocabulary ( )

Definition at line 1836 of file tripal_feature.module.

Referenced by tripal_features_set_taxonomy().

tripal_feature_delete_db_reference ( dbxref_id)
tripal_feature_delete_property ( featureprop_id)
tripal_feature_delete_relationship ( stock_relationship_id)
tripal_feature_edit_ALL_db_references_form ( form_state,
node 
)

Implements Hook_form() Handles adding of DB References to Features

Definition at line 168 of file tripal_feature-db_references.inc.

References tripal_db_get_db_options(), and tripal_feature_load_references().

tripal_feature_edit_ALL_db_references_form_submit ( form,
&$  form_state 
)
tripal_feature_edit_ALL_dbreferences_page ( node)

Definition at line 150 of file tripal_feature-db_references.inc.

tripal_feature_edit_ALL_properties_form ( form_state,
node 
)

Implements Hook_form() Handles adding of Properties for features

Definition at line 157 of file tripal_feature-properties.inc.

References tripal_cv_get_cvterm_options(), and tripal_feature_load_properties().

tripal_feature_edit_ALL_properties_form_submit ( form,
&$  form_state 
)
tripal_feature_edit_ALL_properties_page ( node)

Definition at line 139 of file tripal_feature-properties.inc.

tripal_feature_edit_ALL_relationships_form ( form_state,
node 
)

Implements Hook_form() Handles adding of Properties & Synonyms to Stocks

Definition at line 215 of file tripal_feature-relationships.inc.

References tripal_cv_get_cv_by_name(), tripal_cv_get_cvterm_options(), and tripal_feature_load_relationships().

tripal_feature_edit_ALL_relationships_form_submit ( form,
&$  form_state 
)
tripal_feature_edit_ALL_relationships_form_validate ( form,
&$  form_state 
)

Definition at line 328 of file tripal_feature-relationships.inc.

References tripal_db_set_active().

tripal_feature_edit_ALL_relationships_page ( node)

Definition at line 197 of file tripal_feature-relationships.inc.

tripal_feature_get_aggregate_relationships ( feature_id,
substitute = 1,
levels = 0,
base_type_id = NULL,
depth = 0 
)
tripal_feature_get_aggregate_types ( feature_id)

Definition at line 1140 of file tripal_feature.module.

References tripal_db_set_active().

tripal_feature_get_schemas ( table = NULL)

This function simply defines all tables needed for the module to work correctly. By putting the table definitions in a separate function we can easily provide the entire list for hook_install or individual tables for an update.

Definition at line 139 of file tripal_feature.install.

Referenced by tripal_feature_schema(), and tripal_feature_update_6300().

tripal_feature_help ( path,
arg 
)

Display help and module information

Parameters:
pathwhich path of the site we're displaying help
argarray that holds the current path as would be returned from arg() function
Returns:
help text for the path

Definition at line 67 of file tripal_feature.module.

tripal_feature_implement_add_chado_properties_navigate ( form_state,
step,
nid 
)

Definition at line 72 of file tripal_feature-secondary_tables.inc.

tripal_feature_implement_add_chado_properties_navigate_submit ( form,
form_state 
)

Definition at line 138 of file tripal_feature-secondary_tables.inc.

tripal_feature_implement_add_chado_properties_progress ( current)
tripal_feature_implement_back_to_feature_button ( form_state,
nid 
)

Definition at line 9 of file tripal_feature-secondary_tables.inc.

tripal_feature_implement_back_to_feature_button_submit ( form,
form_state 
)

Definition at line 30 of file tripal_feature-secondary_tables.inc.

tripal_feature_index_feature ( feature_id,
nid 
)

Definition at line 130 of file indexFeatures.php.

tripal_feature_init ( )

Definition at line 29 of file tripal_feature.module.

tripal_feature_install ( )

Implementation of hook_install();

Definition at line 8 of file tripal_feature.install.

References tripal_create_moddir(), and tripal_feature_add_organism_count_mview().

tripal_feature_is_obsolete_form ( node,
stock_id 
)

Implements Hook_form() Handles setting the is_obsolete property of stocks

Definition at line 191 of file tripal_feature-secondary_tables.inc.

tripal_feature_is_obsolete_form_submit ( form,
&$  form_state 
)

Definition at line 212 of file tripal_feature-secondary_tables.inc.

tripal_feature_job_describe_args ( callback,
args 
)

Definition at line 2122 of file tripal_feature.module.

References $args, and tripal_core_chado_select().

tripal_feature_list_relationships_for_node ( feature_name,
subject_relationships,
object_relationships 
)

Definition at line 503 of file tripal_feature-relationships.inc.

tripal_feature_load_featureloc_sequences ( feature_id,
featurelocs 
)
tripal_feature_load_featurelocs ( feature_id,
side = 'as_parent',
aggregate = 1 
)
tripal_feature_load_organism ( organism_id)

Definition at line 917 of file tripal_feature.module.

References tripal_db_set_active().

tripal_feature_load_organism_feature_browser ( organism)
tripal_feature_load_organism_feature_counts ( organism)
tripal_feature_load_properties ( feature_id)

Definition at line 953 of file tripal_feature.module.

References tripal_db_set_active().

Referenced by tripal_feature_edit_ALL_properties_form().

tripal_feature_load_references ( feature_id)

Definition at line 980 of file tripal_feature.module.

References tripal_db_set_active().

Referenced by tripal_feature_edit_ALL_db_references_form().

tripal_feature_load_relationships ( feature_id,
side = 'as_subject' 
)
tripal_feature_load_synonyms ( feature_id)

Definition at line 930 of file tripal_feature.module.

References tripal_db_set_active().

tripal_feature_menu ( )

Menu items are automatically added for the new node types created by this module to the 'Create Content' Navigation menu item. This function adds more menu items needed for this module.

$items['node/tf_node/tf_edit_properties'] = array( 'title' => t('Edit Properties'), 'description' => t('Settings for Features'), 'page callback' => 'tripal_feature_edit_ALL_properties_page', 'page arguments' => array(1), 'access arguments' => array('edit chado_feature content'), 'type' => MENU_LOCAL_TASK, 'weight' => 8, );

$items['node/tf_node/tf_edit_relationships'] = array( 'title' => t('Edit Relationships'), 'description' => t('Settings for Feature'), 'page callback' => 'tripal_feature_edit_ALL_relationships_page', 'page arguments' => array(1), 'access arguments' => array('edit chado_feature content'), 'type' => MENU_LOCAL_TASK, 'weight' => 9, );

Definition at line 150 of file tripal_feature.module.

tripal_feature_module_description_page ( )

Purpose: Provide Guidance to new Tripal Admin

Returns:
HTML Formatted text

Definition at line 11 of file tripal_feature.admin.inc.

tripal_feature_node_info ( )

Provide information to drupal about the node types that we're creating in this module

Definition at line 83 of file tripal_feature.module.

tripal_feature_nodeapi ( &$  node,
op,
teaser,
page 
)

Display feature information for associated organisms. This function also provides contents for indexing

Definition at line 1507 of file tripal_feature.module.

tripal_feature_perm ( )

Set the permission types that the chado module uses. Essentially we want permissionis that protect creation, editing and deleting of chado data objects

Definition at line 106 of file tripal_feature.module.

tripal_feature_preprocess_tripal_organism_feature_browser ( &$  variables)
tripal_feature_preprocess_tripal_organism_feature_counts ( &$  variables)
tripal_feature_requirements ( phase)

Implementation of hook_requirements(). Make sure 'Tripal Core' is enabled before installation

Definition at line 182 of file tripal_feature.install.

tripal_feature_return_fasta ( feature,
desc 
)

Definition at line 2110 of file tripal_feature.module.

Referenced by tripal_search_file().

tripal_feature_schema ( )

Implementation of hook_schema().

Definition at line 102 of file tripal_feature.install.

References tripal_feature_get_schemas().

tripal_feature_set_taxonomy ( node,
feature_id 
)
tripal_feature_sort_locations ( a,
b 
)

used to sort the feature locs by start position

Definition at line 1071 of file tripal_feature.module.

tripal_feature_sort_rel_objects ( a,
b 
)

used to sort the list of relationship objects by start position

Definition at line 1391 of file tripal_feature.module.

tripal_feature_sort_rel_parts ( a,
b 
)

used to sort the list of relationship parts by start position

Definition at line 1400 of file tripal_feature.module.

tripal_feature_sync_feature ( feature_id)
tripal_feature_sync_features ( max_sync = 0,
job_id = NULL 
)
tripal_feature_theme ( )

We need to let drupal know about our theme functions and their arguments. We create theme functions to allow users of the module to customize the look and feel of the output generated in this module

Definition at line 1541 of file tripal_feature.module.

tripal_feature_uninstall ( )

Implementation of hook_uninstall()

Definition at line 111 of file tripal_feature.install.

References tripal_mviews_action(), and tripal_mviews_get_mview_id().

tripal_feature_update_6000 ( )

Update for Drupal 6.x, Tripal 0.2b, Feature Module 0.2 This update adjusts the materialized view by adding a 'cvterm_id' column

Definition at line 26 of file tripal_feature.install.

References $ret, and tripal_feature_add_organism_count_mview().

tripal_feature_update_6300 ( )

Definition at line 40 of file tripal_feature.install.

References $ret, and tripal_feature_get_schemas().

tripal_feature_update_db_reference ( dbxref_id,
db_id,
accession 
)
tripal_feature_update_property ( featureprop_id,
cvterm_id,
value,
preferred,
nid 
)
tripal_feature_update_relationship ( stock_relationship_id,
subject_id,
cvterm_id,
object_id 
)
tripal_feature_views_api ( )

Implements hook_views_api()

Purpose: Essentially this hook tells drupal that there is views support for for this module which then includes tripal_db.views.inc where all the views integration code is

Definition at line 48 of file tripal_feature.module.

tripal_features_cleanup ( dummy = NULL,
job_id = NULL 
)

Definition at line 2018 of file tripal_feature.module.

References tripal_db_set_active(), and tripal_job_set_progress().

if (isset($arguments['i'])) tripal_features_reindex ( max_sync,
job_id = NULL 
)

Definition at line 56 of file indexFeatures.php.

References tripal_job_set_progress().

tripal_features_set_taxonomy ( max_sync = 0,
job_id = NULL 
)
tripal_getfeature_add_ALL_property_page ( node)

Implements Hook_form() Handles adding of Properties for features

Definition at line 9 of file tripal_feature-properties.inc.

References tripal_feature_implement_add_chado_properties_progress().

 All Classes Files Functions Variables