IMSGlobal\LTI\Profile\Message Class Reference

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

Collaboration diagram for IMSGlobal\LTI\Profile\Message:

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 svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright

IMS Global Learning Consortium Inc

Date

2016

Version

3.0.0 http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 16 of file Message.php.

Constructor & Destructor Documentation

__construct()

IMSGlobal\LTI\Profile\Message::__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 60 of file Message.php.

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

    {

        $this->type = $type;
        $this->path = $path;
        $this->capabilities = $capabilities;
        $this->variables = $variables;
        $this->constants = $constants;

    }

Field Documentation

$capabilities

array IMSGlobal\LTI\Profile\Message::$capabilities = null

Capabilities required by message.

Definition at line 36 of file Message.php.

Referenced by IMSGlobal\LTI\Profile\Message\__construct().

$constants

array IMSGlobal\LTI\Profile\Message::$constants = null

Fixed parameters to accompany message request.

Definition at line 48 of file Message.php.

Referenced by IMSGlobal\LTI\Profile\Message\__construct().

$path

string IMSGlobal\LTI\Profile\Message::$path = null

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

Definition at line 30 of file Message.php.

Referenced by IMSGlobal\LTI\Profile\Message\__construct().

$type

string IMSGlobal\LTI\Profile\Message::$type = null

LTI message type.

Definition at line 24 of file Message.php.

Referenced by IMSGlobal\LTI\Profile\Message\__construct().

$variables

array IMSGlobal\LTI\Profile\Message::$variables = null

Variable parameters to accompany message request.

Definition at line 42 of file Message.php.

Referenced by IMSGlobal\LTI\Profile\Message\__construct().

---

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

• libs/composer/vendor/imsglobal/lti/src/Profile/Message.php