LTI Integration Library 4.10.3
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
ServiceDefinition Class Reference

Class to represent an LTI service object. More...

Public Member Functions

 __construct ($formats, $actions, $id=null, $endpoint=null)
 Class constructor.
 
 setId ($id)
 Set ID.
 

Data Fields

 $formats = null
 Media types supported by service.
 
 $actions = null
 HTTP actions accepted by service.
 
 $id = null
 ID of service.
 
 $endpoint = null
 URL for service requests.
 

Detailed Description

Class to represent an LTI service 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

Definition at line 12 of file ServiceDefinition.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $formats,
  $actions,
  $id = null,
  $endpoint = null 
)

Class constructor.

Parameters
array$formatsArray of media types supported by service
array$actionsArray of HTTP actions accepted by service
string | null$idID of service (optional)
string | null$endpointURL for service requests (optional)

Definition at line 51 of file ServiceDefinition.php.

References ServiceDefinition\$actions, ServiceDefinition\$endpoint, ServiceDefinition\$formats, and ServiceDefinition\$id.

Member Function Documentation

◆ setId()

setId (   $id)

Set ID.

Parameters
string$idID of service

Definition at line 64 of file ServiceDefinition.php.

References ServiceDefinition\$id.

Field Documentation

◆ $actions

array null $actions = null

HTTP actions accepted by service.

Definition at line 27 of file ServiceDefinition.php.

Referenced by ServiceDefinition\__construct().

◆ $endpoint

string null $endpoint = null

URL for service requests.

Definition at line 41 of file ServiceDefinition.php.

Referenced by ServiceDefinition\__construct().

◆ $formats

array null $formats = null

Media types supported by service.

Definition at line 20 of file ServiceDefinition.php.

Referenced by ServiceDefinition\__construct().

◆ $id

string null $id = null

ID of service.

Definition at line 34 of file ServiceDefinition.php.

Referenced by ServiceDefinition\__construct(), and ServiceDefinition\setId().


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