[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/mod/lti/classes/local/ltiservice/ -> service_base.php (summary)

This file contains an abstract definition of an LTI service

Author: Stephen Vickers
Copyright: 2014 Vital Source Technologies http://vitalsource.com
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 234 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  __construct()
  get_id()
  get_name()
  is_unsigned()
  get_tool_proxy()
  set_tool_proxy()
  get_service_path()
  parse_value()
  check_tool_proxy()
  check_signature()

Functions
Functions that are not part of a class:

__construct()   X-Ref
Class constructor.


get_id()   X-Ref
Get the service ID.

return: string

get_name()   X-Ref
Get the service name.

return: string

is_unsigned()   X-Ref
Get whether the service requests need to be signed.

return: boolean

get_tool_proxy()   X-Ref
Get the tool proxy object.

return: stdClass

set_tool_proxy($toolproxy)   X-Ref
Set the tool proxy object.

param: object $toolproxy The tool proxy for this service request

get_service_path()   X-Ref
Get the path for service requests.

return: string

parse_value($value)   X-Ref
Parse a string for custom substitution parameter variables supported by this service's resources.

param: string $value  Value to be parsed
return: string

check_tool_proxy($toolproxyguid, $body = null)   X-Ref
Check that the request has been properly signed.

param: string $toolproxyguid  Tool Proxy GUID
param: string $body           Request body (null if none)
return: boolean

check_signature($consumerkey, $secret, $body)   X-Ref
Check the request signature.

param: string $consumerkey    Consumer key
param: string $secret         Shared secret
param: string $body           Request body
return: boolean



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1