ceLTIc\LTI\Outcome Class Reference

Class to represent an outcome. More...

Public Member Functions
	__construct (int|float|string|null $value=null, int|float|null $pointsPossible=1, string $activityProgress='Completed', string $gradingProgress='FullyGraded')
	Class constructor.
int float string null	getValue ()
	Get the outcome value.
void	setValue (int|float|string|null $value)
	Set the outcome value.
int float null	getPointsPossible ()
	Get the points possible value.
void	setPointsPossible (int|float|null $pointsPossible)
	Set the points possible value.
void	assign ($outcome)
	Assign property values from another outcome instance.

Public Attributes
const	ALLOWED_ACTIVITY_PROGRESS
	Allowed values for Activity Progress.
const	ALLOWED_GRADING_PROGRESS
	Allowed values for Grading Progress.
string	$language = null
	Language value.
string	$status = null
	Outcome status value.
string	$date = null
	Outcome date value.
OutcomeType	$type = null
	Outcome type value.
string	$activityProgress = null
	Activity progress.
string	$gradingProgress = null
	Grading progress.
string	$comment = null
	Comment.
DateTime	$submissionStarted = null
	Date submission started.
DateTime	$submissionCompleted = null
	Date submission completed.
string	$dataSource = null
	Outcome data source value.
string	$ltiUserId = null
	LTI user ID.

Detailed Description

Class to represent an outcome.

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

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

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\Outcome::__construct	(	int|float|string|null	$value = null,
		int|float|null	$pointsPossible = 1,
		string	$activityProgress = 'Completed',
		string	$gradingProgress = 'FullyGraded' )

Class constructor.

Parameters

int | float | string | null	$value	Outcome value (optional, default is none)
int | float | null	$pointsPossible	Points possible value (optional, default is 1)
string	$activityProgress	Activity progress (optional, default is 'Completed')
string	$gradingProgress	Grading progress (optional, default is 'FullyGraded')

Member Function Documentation

assign()

void ceLTIc\LTI\Outcome::assign

(

$outcome

)

Assign property values from another outcome instance.

Parameters

Outcome

$outcome

Outcome instance

getPointsPossible()

int float null ceLTIc\LTI\Outcome::getPointsPossible

(

)

Get the points possible value.

Returns

int|float|null Points possible value

getValue()

int float string null ceLTIc\LTI\Outcome::getValue

(

)

Get the outcome value.

Returns

int|float|string|null Outcome value

setPointsPossible()

void ceLTIc\LTI\Outcome::setPointsPossible

(

int|float|null

$pointsPossible

)

Set the points possible value.

Parameters

int | float | null

$pointsPossible

Points possible value

setValue()

void ceLTIc\LTI\Outcome::setValue

(

int|float|string|null

$value

)

Set the outcome value.

Parameters

int | float | string | null

$value

Outcome value

Referenced by ceLTIc\LTI\ResourceLink\hasResultService().

Member Data Documentation

$activityProgress

string ceLTIc\LTI\Outcome::$activityProgress = null

Activity progress.

$comment

string ceLTIc\LTI\Outcome::$comment = null

Comment.

$dataSource

string ceLTIc\LTI\Outcome::$dataSource = null

Outcome data source value.

$date

string ceLTIc\LTI\Outcome::$date = null

Outcome date value.

$gradingProgress

string ceLTIc\LTI\Outcome::$gradingProgress = null

Grading progress.

$language

string ceLTIc\LTI\Outcome::$language = null

Language value.

$ltiUserId

string ceLTIc\LTI\Outcome::$ltiUserId = null

LTI user ID.

$status

string ceLTIc\LTI\Outcome::$status = null

Outcome status value.

$submissionCompleted

DateTime ceLTIc\LTI\Outcome::$submissionCompleted = null

Date submission completed.

$submissionStarted

DateTime ceLTIc\LTI\Outcome::$submissionStarted = null

Date submission started.

$type

OutcomeType ceLTIc\LTI\Outcome::$type = null

Outcome type value.

ALLOWED_ACTIVITY_PROGRESS

const ceLTIc\LTI\Outcome::ALLOWED_ACTIVITY_PROGRESS

Initial value:

= [
        'Initialized',
        'Started',
        'InProgress',
        'Submitted',
        'Completed'
    ]

Allowed values for Activity Progress.

ALLOWED_GRADING_PROGRESS

const ceLTIc\LTI\Outcome::ALLOWED_GRADING_PROGRESS

Initial value:

= [
        'FullyGraded',
        'Pending',
        'PendingManual',
        'Failed',
        'NotReady'
    ]

Allowed values for Grading Progress.