Tripal
Functions
tripal_ws.api.inc File Reference

Functions

 hook_tripal_ws_value (&$items, $field, $instance)
 
 tripal_get_web_services ()
 
 tripal_load_include_web_service_class ($class)
 
 tripal_add_site ($name, $url, $version, $description)
 
 tripal_remove_site ($record_id)
 
 tripal_build_remote_content_url ($remote_site, $path='', $query='')
 
 tripal_get_remote_content ($site_id, $path='', $query='')
 
 _tripal_report_ws_error ($data)
 
 tripal_get_remote_context ($context_url, $cache_id)
 
 tripal_get_remote_content_context ($site_id, $context_url, $bundle_accession, $field_accession='')
 
 tripal_clear_remote_cache ($site_id)
 
 tripal_get_remote_API_doc ($site_id)
 
 tripal_load_remote_entities ($remote_entity_ids, $site_id, $bundle_accession, $field_ids)
 
 tripal_load_remote_entity ($remote_entity_id, $site_id, $bundle_accession, $field_ids)
 
 _tripal_update_remote_entity_field ($field_data, $context, $depth=0)
 
 tripal_get_remote_field_info ($site_id, $bundle_accession, $field_accession)
 
 tripal_get_remote_field_instance_info ($site_id, $bundle_accession, $field_accession)
 
 tripal_get_remote_content_doc ($site_id, $bundle_accession)
 
 tripal_get_remote_field_doc ($site_id, $bundle_accession, $field_accession)
 
 tripal_get_remote_field_formatters ($site_id, $bundle_accession, $field_accession)
 

Detailed Description

This file provides the Tripal Web Services API: a set of functions for interacting with the Tripal Web Services.

Function Documentation

◆ _tripal_report_ws_error()

_tripal_report_ws_error (   $data)

A helper function for reporting an error when retrieving remote content.

Parameters
$dataA data array containing at a minimum the 'error' key containing the error message.

◆ tripal_build_remote_content_url()

tripal_build_remote_content_url (   $remote_site,
  $path = '',
  $query = '' 
)

Constructs a URL for a remote Tripal web service.

Parameters
$remote_siteA remote Tripal site object.
$pathThe web service path for the content (excluding 'web-services/vX.x/content'). To retrieve the full content listing leave this paramter empty.
$queryAn query string to appear after the ? in a URL.
Returns
The full URL within the content service.