TinCanPHP by Rustici Software and Community
\
TinCan

\TinCanRemoteLRS

Summary

Methods
Properties
Constants
__construct()
about()
saveStatement()
saveStatements()
retrieveStatement()
retrieveVoidedStatement()
queryStatements()
moreStatements()
retrieveStateIds()
retrieveState()
saveState()
deleteState()
clearState()
retrieveActivityProfileIds()
retrieveActivityProfile()
saveActivityProfile()
deleteActivityProfile()
retrieveActivity()
retrieveAgentProfileIds()
retrieveAgentProfile()
saveAgentProfile()
deleteAgentProfile()
retrievePerson()
setEndpoint()
getEndpoint()
getEndpointServerRoot()
setVersion()
getVersion()
setAuth()
getAuth()
setProxy()
getProxy()
setHeaders()
getHeaders()
No public properties found
No constants found
sendRequest()
$endpoint
$version
$auth
$proxy
$headers
$extended
N/A
_fromArray()
_parseMetadata()
_parseMultipart()
_parseHeaders()
_buildAttachmentContent()
_queryStatementsRequestParams()
_queryStatementsResult()
_deleteState()
$whitelistedHeaders
N/A

Properties

$endpoint

$endpoint :

Type

$version

$version :

Type

$auth

$auth :

Type

$proxy

$proxy :

Type

$headers

$headers :

Type

$extended

$extended :

Type

$whitelistedHeaders

$whitelistedHeaders :

Type

Methods

__construct()

__construct()

about()

about()

saveStatement()

saveStatement(  $statement)

Parameters

$statement

saveStatements()

saveStatements(  $statements)

Parameters

$statements

retrieveStatement()

retrieveStatement(  $id,   $options = array())

Parameters

$id
$options

retrieveVoidedStatement()

retrieveVoidedStatement(  $id,   $options = array())

Parameters

$id
$options

queryStatements()

queryStatements(  $query)

Parameters

$query

moreStatements()

moreStatements(  $moreUrl)

Parameters

$moreUrl

retrieveStateIds()

retrieveStateIds(  $activity,   $agent)

Parameters

$activity
$agent

retrieveState()

retrieveState(  $activity,   $agent,   $id)

Parameters

$activity
$agent
$id

saveState()

saveState(  $activity,   $agent,   $id,   $content)

Parameters

$activity
$agent
$id
$content

deleteState()

deleteState(  $activity,   $agent,   $id)

Parameters

$activity
$agent
$id

clearState()

clearState(  $activity,   $agent)

Parameters

$activity
$agent

retrieveActivityProfileIds()

retrieveActivityProfileIds(  $activity)

Parameters

$activity

retrieveActivityProfile()

retrieveActivityProfile(  $activity,   $id)

Parameters

$activity
$id

saveActivityProfile()

saveActivityProfile(  $activity,   $id,   $content)

Parameters

$activity
$id
$content

deleteActivityProfile()

deleteActivityProfile(  $activity,   $id)

Parameters

$activity
$id

retrieveActivity()

retrieveActivity(  $activityid)

Parameters

$activityid

retrieveAgentProfileIds()

retrieveAgentProfileIds(  $agent)

Parameters

$agent

retrieveAgentProfile()

retrieveAgentProfile(  $agent,   $id)

Parameters

$agent
$id

saveAgentProfile()

saveAgentProfile(  $agent,   $id,   $content)

Parameters

$agent
$id
$content

deleteAgentProfile()

deleteAgentProfile(  $agent,   $id)

Parameters

$agent
$id

retrievePerson()

retrievePerson(  $agent)

Parameters

$agent

setEndpoint()

setEndpoint(  $value)

Parameters

$value

getEndpoint()

getEndpoint()

getEndpointServerRoot()

getEndpointServerRoot()

setVersion()

setVersion(  $value)

Parameters

$value

getVersion()

getVersion()

setAuth()

setAuth()

getAuth()

getAuth()

setProxy()

setProxy(  $value)

Parameters

$value

getProxy()

getProxy()

setHeaders()

setHeaders(  $value)

Parameters

$value

getHeaders()

getHeaders()

sendRequest()

sendRequest(  $method,   $resource)

Parameters

$method
$resource

_fromArray()

_fromArray(  $options)

Parameters

$options

_parseMetadata()

_parseMetadata(  $metadata)

Parameters

$metadata

_parseMultipart()

_parseMultipart(  $boundary,   $content)

Parameters

$boundary
$content

_parseHeaders()

_parseHeaders(  $raw_headers)

Parameters

$raw_headers

_buildAttachmentContent()

_buildAttachmentContent(  $requestCfg,   $attachments)

Parameters

$requestCfg
$attachments

_queryStatementsRequestParams()

_queryStatementsRequestParams(  $query)

Parameters

$query

_queryStatementsResult()

_queryStatementsResult(  $response)

Parameters

$response

_deleteState()

_deleteState(  $activity,   $agent,   $id)

Parameters

$activity
$agent
$id