LTI Integration Library 5.1.4
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
ceLTIc\LTI\Enum Namespace Reference

Enumerations for LTI properties. More...

Enumerations

enum  IdScope : int {
  IdOnly = 0 , Platform = 1 , Context = 2 , Resource = 3 ,
  SEPARATOR = ':'
}
 Enumeration to define alternative scopes to use when generating a user ID. More...
 
enum  LogLevel : int {
  None = 0 , Error = 1 , Info = 2 , Debug = 3 ,
  logNone
}
 Enumeration to define alternative levels of logging. More...
 
enum  LtiVersion : string { V1 = 'LTI-1p0' , V1P3 = '1.3.0' , V2 = 'LTI-2p0' }
 Enumeration to define alternative LTI version strings. More...
 
enum  OutcomeType : string {
  Decimal = 'decimal' , Percentage = 'percentage' , Ratio = 'ratio' , LetterAF = 'letteraf' ,
  LetterAFPlus = 'letterafplus' , PassFail = 'passfail' , Text = 'freetext'
}
 Enumeration to define alternative outcome types. More...
 
enum  ServiceAction : int {
  Read = 1 , Write = 2 , Delete = 3 , Create = 4 ,
  Update = 5
}
 Enumeration to define alternative service actions. More...
 
enum  ToolSettingsMode : string { All = 'all' , Distinct = 'distinct' }
 Enumeration to define alternative modes when requesting tool settings. More...
 

Detailed Description

Enumerations for LTI properties.

Enumeration Type Documentation

◆ IdScope

enum IdScope : int

Enumeration to define alternative scopes to use when generating a user ID.

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
Enumerator
IdOnly 

Use ID value only.

Platform 

Prefix an ID with the consumer key.

Context 

Prefix the ID with the consumer key and context ID.

Resource 

Prefix the ID with the consumer key and resource ID.

SEPARATOR 

Character used to separate each element of an ID.

◆ LogLevel

enum LogLevel : int

Enumeration to define alternative levels of logging.

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
Enumerator
None 

No logging.

Error 

Log errors only.

Info 

Log error and information messages.

Debug 

Log all messages.

logNone 

Check whether no messages are logged.

Returns
bool

◆ LtiVersion

enum LtiVersion : string

Enumeration to define alternative LTI version strings.

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
Enumerator
V1 

LTI version 1 for messages.

V1P3 

LTI version 1.3 for messages.

V2 

LTI version 2 for messages.

◆ OutcomeType

enum OutcomeType : string

Enumeration to define alternative outcome types.

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
Enumerator
Decimal 

Decimal outcome type.

Percentage 

Percentage outcome type.

Ratio 

Ratio outcome type.

LetterAF 

Letter (A-F) outcome type.

LetterAFPlus 

Letter (A-F) with optional +/- outcome type.

PassFail 

Pass/fail outcome type.

Text 

Free text outcome type.

◆ ServiceAction

enum ServiceAction : int

Enumeration to define alternative service actions.

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
Enumerator
Read 

Read action.

Write 

Write (create/update) action.

Delete 

Delete action.

Create 

Create action.

Update 

Update action.

◆ ToolSettingsMode

enum ToolSettingsMode : string

Enumeration to define alternative modes when requesting tool settings.

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
Enumerator
All 

Settings at all levels mode.

Distinct 

Settings with distinct names at all levels mode.