Outcome Class Reference

Class to represent an outcome. More...

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

Public Attributes
const	ALLOWED_ACTIVITY_PROGRESS
	Allowed values for Activity Progress.
const	ALLOWED_GRADING_PROGRESS
	Allowed values for Grading Progress.
string null	$language = null
	Language value.
string null	$status = null
	Outcome status value.
string null	$date = null
	Outcome date value.
string null	$type = null
	Outcome type value.
string null	$activityProgress = null
	Activity progress.
string null	$gradingProgress = null
	Grading progress.
string null	$comment = null
	Comment.
string null	$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

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')

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

Member Function Documentation

getPointsPossible()

int null getPointsPossible

(

)

Get the points possible value.

Returns

int|null Points possible value

getValue()

string getValue

(

)

Get the outcome value.

Returns

string Outcome value

setPointsPossible()

setPointsPossible

(

$pointsPossible

)

Set the points possible value.

Parameters

int | null

$pointsPossible

Points possible value

setValue()

setValue

(

$value

)

Set the outcome value.

Parameters

string

$value

Outcome value

Member Data Documentation

$activityProgress

string null $activityProgress = null

Activity progress.

$activityProgress

Referenced by Outcome\__construct().

$comment

string null $comment = null

Comment.

$comment

$dataSource

string null $dataSource = null

Outcome data source value.

$dataSource

$date

string null $date = null

Outcome date value.

$date

$gradingProgress

string null $gradingProgress = null

Grading progress.

$gradingProgress

Referenced by Outcome\__construct().

$language

string null $language = null

Language value.

$language

$status

string null $status = null

Outcome status value.

$status

$type

string null $type = null

Outcome type value.

$type

ALLOWED_ACTIVITY_PROGRESS

const ALLOWED_ACTIVITY_PROGRESS

Initial value:

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

Allowed values for Activity Progress.

ALLOWED_GRADING_PROGRESS

const ALLOWED_GRADING_PROGRESS

Initial value:

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

Allowed values for Grading Progress.

---

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

• Outcome.php