Message Class Reference

Class to represent a resource handler message object. More...

Public Member Functions
	__construct ($type, $path, $capabilities=array(), $variables=array(), $constants=array())
	Class constructor. More...

Data Fields
	$type = null
	LTI message type. More...
	$path = null
	Path to send message request to (used in conjunction with a base URL for the Tool Provider). More...
	$capabilities = null
	Capabilities required by message. More...
	$variables = null
	Variable parameters to accompany message request. More...
	$constants = null
	Fixed parameters to accompany message request. More...

Detailed Description

Class to represent a resource handler message object.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Version

3.1.0

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 14 of file Profile/Message.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$type,
			$path,
			$capabilities = array(),
			$variables = array(),
			$constants = array()
	)

Class constructor.

Parameters

string	$type	LTI message type
string	$path	Path to send message request to
array	$capabilities	Array of capabilities required by message
array	$variables	Array of variable parameters to accompany message request
array	$constants	Array of fixed parameters to accompany message request

Definition at line 61 of file Profile/Message.php.

References Message\$capabilities, Message\$constants, Message\$path, Message\$type, and Message\$variables.

Field Documentation

$capabilities

array null $capabilities = null

Capabilities required by message.

Definition at line 36 of file Profile/Message.php.

Referenced by Message\__construct().

$constants

array null $constants = null

Fixed parameters to accompany message request.

Definition at line 50 of file Profile/Message.php.

Referenced by Message\__construct().

$path

string null $path = null

Path to send message request to (used in conjunction with a base URL for the Tool Provider).

Definition at line 29 of file Profile/Message.php.

Referenced by Message\__construct().

$type

string null $type = null

LTI message type.

Definition at line 22 of file Profile/Message.php.

Referenced by Message\__construct().

$variables

array null $variables = null

Variable parameters to accompany message request.

Definition at line 43 of file Profile/Message.php.

Referenced by Message\__construct().

---

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

• Profile/Message.php