Outcome Class Reference

Class to represent an outcome. More...

Public Member Functions
	__construct ($value=null, $pointsPossible=1, $activityProgress='Completed', $gradingProgress='FullyGraded')
	Class constructor.
	getValue ()
	Get the outcome value.
	setValue ($value)
	Set the outcome value.
	getPointsPossible ()
	Get the points possible value.
	setPointsPossible ($pointsPossible)
	Set the points possible value.

Data Fields
const	ALLOWED_ACTIVITY_PROGRESS
	Allowed values for Activity Progress.
const	ALLOWED_GRADING_PROGRESS
	Allowed values for Grading Progress.
	$language = null
	Language value.
	$status = null
	Outcome status value.
	$date = null
	Outcome date value.
	$type = null
	Outcome type value.
	$activityProgress = null
	Activity progress.
	$gradingProgress = null
	Grading progress.
	$comment = null
	Comment.
	$dataSource = null
	Outcome data source value.

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

Definition at line 12 of file Outcome.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$value = null,
			$pointsPossible = 1,
			$activityProgress = 'Completed',
			$gradingProgress = 'FullyGraded'
	)

Class constructor.

Parameters

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

Definition at line 115 of file Outcome.php.

References Outcome\$activityProgress, and Outcome\$gradingProgress.

Member Function Documentation

getPointsPossible()

getPointsPossible

(

)

Get the points possible value.

Returns

int|null Points possible value

Definition at line 161 of file Outcome.php.

getValue()

getValue

(

)

Get the outcome value.

Returns

string|null Outcome value

Definition at line 141 of file Outcome.php.

setPointsPossible()

setPointsPossible

(

$pointsPossible

)

Set the points possible value.

Parameters

int | null

$pointsPossible

Points possible value

Definition at line 171 of file Outcome.php.

setValue()

setValue

(

$value

)

Set the outcome value.

Parameters

string | null

$value

Outcome value

Definition at line 151 of file Outcome.php.

Field Documentation

$activityProgress

string null $activityProgress = null

Activity progress.

Definition at line 70 of file Outcome.php.

Referenced by Outcome\__construct().

$comment

string null $comment = null

Comment.

Definition at line 84 of file Outcome.php.

$dataSource

string null $dataSource = null

Outcome data source value.

Definition at line 91 of file Outcome.php.

$date

string null $date = null

Outcome date value.

Definition at line 56 of file Outcome.php.

$gradingProgress

string null $gradingProgress = null

Grading progress.

Definition at line 77 of file Outcome.php.

Referenced by Outcome\__construct().

$language

string null $language = null

Language value.

Definition at line 42 of file Outcome.php.

$status

string null $status = null

Outcome status value.

Definition at line 49 of file Outcome.php.

$type

string null $type = null

Outcome type value.

Definition at line 63 of file Outcome.php.

ALLOWED_ACTIVITY_PROGRESS

const ALLOWED_ACTIVITY_PROGRESS

Initial value:

= array(
        'Initialized',
        'Started',
        'InProgress',
        'Submitted',
        'Completed'
    )

Allowed values for Activity Progress.

Definition at line 18 of file Outcome.php.

ALLOWED_GRADING_PROGRESS

const ALLOWED_GRADING_PROGRESS

Initial value:

= array(
        'FullyGraded',
        'Pending',
        'PendingManual',
        'Failed',
        'NotReady'
    )

Allowed values for Grading Progress.

Definition at line 29 of file Outcome.php.

---

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

• Outcome.php