Inheritance diagram for TripalDocService_v0_1:

Collaboration diagram for TripalDocService_v0_1:

Public Member Functions
	__construct ($base_path)

	handleRequest ()

Public Member Functions inherited from TripalWebService
	setPath ($path)

	setParams ($params)

	getVersion ($sanitize=FALSE)

	getContext ()

	getResponse ()

	getServicePath ()

	getData ()

	setResource ($resource)

	setError ($message)

	getDocumentation ()

	addResourceProperty ($resource, $term, $value, $sanitize=[])

	setResourceType ($resource, $term, $sanitize=['spacing'])

Static Public Attributes
static	$label = 'API Documentation'

static	$description = 'Provides Hydra style documenation to make this RESTful webservice discoverable.'

static	$type = 'doc'

Static Public Attributes inherited from TripalWebService
static	$label = 'Base WebService'

static	$description = 'This is the base class for Tripal web services as is not meant to be used on it\'s own'

static	$type = 'services'

Additional Inherited Members
Protected Member Functions inherited from TripalWebService
	addDocClass ($details=[], $ops=[], $props=[])

	getContextTerm ($term, $sanitize=[])

	addContextTerm ($resource, $term, $sanitize=[])

	addContextVocab ($resource, $vocab)

Protected Attributes inherited from TripalWebService
	$resource

	$path

	$params

	$base_path

	$documentation

Constructor & Destructor Documentation

◆ __construct()

TripalDocService_v0_1::__construct ( $base_path )

Constructor for the TripalDocService_v0_1 class.

Reimplemented from TripalWebService.

TripalDocService_v0_1::handleRequest ( )

Reimplemented from TripalWebService.

TripalDocService_v0_1::$description = 'Provides Hydra style documenation to make this RESTful webservice discoverable.'

static

A bit of text to describe what this service provides.

TripalDocService_v0_1::$label = 'API Documentation'

static

The human-readable label for this web service.

TripalDocService_v0_1::$type = 'doc'

static

A machine-readable type for this service. This name must be unique among all Tripal web services and is used to form the URL to access this service.

The documentation for this class was generated from the following file: