Class to represent an outcome. More...

Collaboration diagram for ILIAS\LTI\ToolProvider\Outcome:

Public Member Functions
	__construct ( $value=null, int $pointsPossible=1, string $activityProgress='Completed', string $gradingProgress='FullyGraded')
	Class constructor. More...

	getValue ()
	Get the outcome value. More...

	setValue (string $value)
	Set the outcome value. More...

	getPointsPossible ()
	Get the points possible value. More...

	setPointsPossible (?int $pointsPossible)
	Set the points possible value. More...

Data Fields
const	ALLOWED_ACTIVITY_PROGRESS
	Allowed values for Activity Progress. More...

const	ALLOWED_GRADING_PROGRESS
	Allowed values for Grading Progress. More...

string	$language = null
	Language value. More...

string	$status = null
	Outcome status value. More...

string	$date = null
	Outcome date value. More...

string	$type = null
	Outcome type value. More...

string	$activityProgress = null
	Activity progress. More...

string	$gradingProgress = null
	Grading progress. More...

string	$comment = null
	Comment. More...

string	$dataSource = null
	Outcome data source value. More...

Private Attributes
	$value = null
	Outcome value. More...

int	$pointsPossible = 1
	Points possible value. More...

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 @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 28 of file Outcome.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LTI\ToolProvider\Outcome::__construct	(		$value = `null`,
		int	$pointsPossible = `1`,
		string	$activityProgress = `'Completed'`,
		string	$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 129 of file Outcome.php.

      {
        $this->value = $value;
        $this->pointsPossible = $pointsPossible;
        $this->language = 'en-US';
        $this->date = gmdate('Y-m-d\TH:i:s\Z', time());
        $this->type = 'decimal';
        if (in_array($activityProgress, self::ALLOWED_ACTIVITY_PROGRESS)) {
            $this->activityProgress = $activityProgress;
        } else {
            $this->activityProgress = 'Completed';
        }
        if (in_array($gradingProgress, self::ALLOWED_GRADING_PROGRESS)) {
            $this->gradingProgress = $gradingProgress;
        } else {
            $this->gradingProgress = 'FullyGraded';
        }
        $this->comment = '';
    }

References ILIAS\LTI\ToolProvider\Outcome\$activityProgress, ILIAS\LTI\ToolProvider\Outcome\$gradingProgress, ILIAS\LTI\ToolProvider\Outcome\$pointsPossible, ILIAS\LTI\ToolProvider\Outcome\$value, ILIAS\UI\examples\Symbol\Glyph\Comment\comment(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

Member Function Documentation

◆ getPointsPossible()

ILIAS\LTI\ToolProvider\Outcome::getPointsPossible ( )

Get the points possible value.

Returns: int|null Points possible value

Definition at line 177 of file Outcome.php.

                                       : ?int
    {
        return $this->pointsPossible;
    }

References ILIAS\LTI\ToolProvider\Outcome\$pointsPossible.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService().

Here is the caller graph for this function:

◆ getValue()

ILIAS\LTI\ToolProvider\Outcome::getValue ( )

Get the outcome value.

Returns: string Outcome value

Definition at line 158 of file Outcome.php.

                              : ?string
    {
        return $this->value;
    }

References ILIAS\LTI\ToolProvider\Outcome\$value.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\checkValueType(), and ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService().

Here is the caller graph for this function:

◆ setPointsPossible()

ILIAS\LTI\ToolProvider\Outcome::setPointsPossible ( ?int $pointsPossible )

Set the points possible value.

Parameters

int | null $pointsPossible Points possible value

Definition at line 186 of file Outcome.php.

    {
        $this->pointsPossible = $pointsPossible;
    }

References ILIAS\LTI\ToolProvider\Outcome\$pointsPossible.

◆ setValue()

ILIAS\LTI\ToolProvider\Outcome::setValue ( string $value )

Set the outcome value.

Parameters

string $value Outcome value

Definition at line 167 of file Outcome.php.

    {
        $this->value = $value;
    }

References ILIAS\LTI\ToolProvider\Outcome\$value.

Referenced by ILIAS\LTI\ToolProvider\ResourceLink\checkValueType(), and ILIAS\LTI\ToolProvider\ResourceLink\doOutcomesService().

Here is the caller graph for this function:

Field Documentation

◆ $activityProgress

string null ILIAS\LTI\ToolProvider\Outcome::$activityProgress = null

Activity progress.

Definition at line 85 of file Outcome.php.

Referenced by ILIAS\LTI\ToolProvider\Outcome\__construct().

◆ $comment

string null ILIAS\LTI\ToolProvider\Outcome::$comment = null

Comment.

Definition at line 99 of file Outcome.php.

◆ $dataSource

string null ILIAS\LTI\ToolProvider\Outcome::$dataSource = null

Outcome data source value.

Definition at line 106 of file Outcome.php.

◆ $date

string null ILIAS\LTI\ToolProvider\Outcome::$date = null

Outcome date value.

Definition at line 71 of file Outcome.php.

◆ $gradingProgress

string null ILIAS\LTI\ToolProvider\Outcome::$gradingProgress = null

Grading progress.

Definition at line 92 of file Outcome.php.

Referenced by ILIAS\LTI\ToolProvider\Outcome\__construct().

◆ $language

string null ILIAS\LTI\ToolProvider\Outcome::$language = null

Language value.

Definition at line 57 of file Outcome.php.

◆ $pointsPossible

int ILIAS\LTI\ToolProvider\Outcome::$pointsPossible = 1

private

Points possible value.

Definition at line 120 of file Outcome.php.

Referenced by ILIAS\LTI\ToolProvider\Outcome\__construct(), ILIAS\LTI\ToolProvider\Outcome\getPointsPossible(), and ILIAS\LTI\ToolProvider\Outcome\setPointsPossible().

◆ $status

string null ILIAS\LTI\ToolProvider\Outcome::$status = null

Outcome status value.

Definition at line 64 of file Outcome.php.

◆ $type

string null ILIAS\LTI\ToolProvider\Outcome::$type = null

Outcome type value.

Definition at line 78 of file Outcome.php.

◆ $value

mixed string null ILIAS\LTI\ToolProvider\Outcome::$value = null

private

Outcome value.

Definition at line 113 of file Outcome.php.

Referenced by ILIAS\LTI\ToolProvider\Outcome\__construct(), ILIAS\LTI\ToolProvider\Outcome\getValue(), and ILIAS\LTI\ToolProvider\Outcome\setValue().

◆ ALLOWED_ACTIVITY_PROGRESS

const ILIAS\LTI\ToolProvider\Outcome::ALLOWED_ACTIVITY_PROGRESS

Initial value:

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

Allowed values for Activity Progress.

Definition at line 33 of file Outcome.php.

◆ ALLOWED_GRADING_PROGRESS

const ILIAS\LTI\ToolProvider\Outcome::ALLOWED_GRADING_PROGRESS

Initial value:

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

Allowed values for Grading Progress.

Definition at line 44 of file Outcome.php.

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

Services/LTI/src/ToolProvider/Outcome.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getPointsPossible()

◆ getValue()

◆ setPointsPossible()

◆ setValue()

Field Documentation

◆ $activityProgress

◆ $comment

◆ $dataSource

◆ $date

◆ $gradingProgress

◆ $language

◆ $pointsPossible

◆ $status

◆ $type

◆ $value

◆ ALLOWED_ACTIVITY_PROGRESS

◆ ALLOWED_GRADING_PROGRESS