LTI Integration Library 5.2.0
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
ceLTIc\LTI\Profile\Message Class Reference

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

Public Member Functions

 __construct (string $type, string $path, array $capabilities=[], array $variables=[], array $constants=[])
 Class constructor.
 

Public Attributes

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

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
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

◆ __construct()

ceLTIc\LTI\Profile\Message::__construct ( string $type,
string $path,
array $capabilities = [],
array $variables = [],
array $constants = [] )

Class constructor.

Parameters
string$typeLTI message type
string$pathPath to send message request to
array$capabilitiesArray of capabilities required by message
array$variablesArray of variable parameters to accompany message request
array$constantsArray of fixed parameters to accompany message request

Member Data Documentation

◆ $capabilities

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

Capabilities required by message.

◆ $constants

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

Fixed parameters to accompany message request.

◆ $path

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

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

◆ $type

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

LTI message type.

◆ $variables

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

Variable parameters to accompany message request.