Inheritance diagram for ilObjTestSettingsGamification:

Collaboration diagram for ilObjTestSettingsGamification:

Public Member Functions
	__construct (int $test_id)

	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)

	toStorage ()

	getHighscoreEnabled ()

	withHighscoreEnabled (bool $highscore_enabled)

	getHighscoreOwnTable ()

	withHighscoreOwnTable (bool $highscore_own_table)

	getHighscoreTopTable ()

	withHighscoreTopTable (bool $highscore_top_table)

	getHighScoreMode ()

	getHighscoreTopNum ()

	withHighscoreTopNum (int $highscore_top_num)

	getHighscoreAnon ()

	withHighscoreAnon (bool $highscore_anon)

	getHighscoreAchievedTS ()

	withHighscoreAchievedTS (bool $highscore_achieved_ts)

	getHighscoreScore ()

	withHighscoreScore (bool $highscore_score)

	getHighscorePercentage ()

	withHighscorePercentage (bool $highscore_percentage)

	getHighscoreHints ()

	withHighscoreHints (bool $highscore_hints)

	getHighscoreWTime ()

	withHighscoreWTime (bool $highscore_wtime)

Public Member Functions inherited from TestSettings
	__construct (int $test_id)

	getTestId ()

	withTestId (int $test_id)

	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)

	toStorage ()

Data Fields
const	HIGHSCORE_SHOW_OWN_TABLE = 1

const	HIGHSCORE_SHOW_TOP_TABLE = 2

const	HIGHSCORE_SHOW_ALL_TABLES = 3

Protected Attributes
bool	$highscore_enabled = false

bool	$highscore_anon = true

bool	$highscore_achieved_ts = true

bool	$highscore_score = true

bool	$highscore_percentage = true

bool	$highscore_hints = true

bool	$highscore_wtime = true

bool	$highscore_own_table = true

bool	$highscore_top_table = true

int	$highscore_top_num = 10

Protected Attributes inherited from TestSettings
int	$test_id

Detailed Description

Definition at line 25 of file ilObjTestSettingsGamification.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjTestSettingsGamification::__construct ( int $test_id )

Reimplemented from TestSettings.

Definition at line 43 of file ilObjTestSettingsGamification.php.

    {
        parent::__construct($test_id);
    }

References TestSettings\$test_id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ getHighscoreAchievedTS()

ilObjTestSettingsGamification::getHighscoreAchievedTS ( )

Definition at line 220 of file ilObjTestSettingsGamification.php.

                                            : bool
    {
        return $this->highscore_achieved_ts;
    }

◆ getHighscoreAnon()

ilObjTestSettingsGamification::getHighscoreAnon ( )

Definition at line 209 of file ilObjTestSettingsGamification.php.

                                      : bool
    {
        return $this->highscore_anon;
    }

◆ getHighscoreEnabled()

ilObjTestSettingsGamification::getHighscoreEnabled ( )

Definition at line 149 of file ilObjTestSettingsGamification.php.

                                         : bool
    {
        return $this->highscore_enabled;
    }

◆ getHighscoreHints()

ilObjTestSettingsGamification::getHighscoreHints ( )

Definition at line 253 of file ilObjTestSettingsGamification.php.

                                       : bool
    {
        return $this->highscore_hints;
    }

◆ getHighScoreMode()

ilObjTestSettingsGamification::getHighScoreMode ( )

Definition at line 181 of file ilObjTestSettingsGamification.php.

                                      : int
    {
        if ($this->getHighscoreTopTable() && $this->getHighscoreOwnTable()) {
            return self::HIGHSCORE_SHOW_ALL_TABLES;
        }
 
        if ($this->getHighscoreTopTable()) {
            return self::HIGHSCORE_SHOW_TOP_TABLE;
        }
 
        if ($this->getHighscoreOwnTable()) {
            return self::HIGHSCORE_SHOW_OWN_TABLE;
        }
 
        return 0;
    }

◆ getHighscoreOwnTable()

ilObjTestSettingsGamification::getHighscoreOwnTable ( )

Definition at line 160 of file ilObjTestSettingsGamification.php.

                                          : bool
    {
        return $this->highscore_own_table;
    }

◆ getHighscorePercentage()

ilObjTestSettingsGamification::getHighscorePercentage ( )

Definition at line 242 of file ilObjTestSettingsGamification.php.

                                            : bool
    {
        return $this->highscore_percentage;
    }

◆ getHighscoreScore()

ilObjTestSettingsGamification::getHighscoreScore ( )

Definition at line 231 of file ilObjTestSettingsGamification.php.

                                       : bool
    {
        return $this->highscore_score;
    }

◆ getHighscoreTopNum()

ilObjTestSettingsGamification::getHighscoreTopNum ( )

Definition at line 198 of file ilObjTestSettingsGamification.php.

                                        : int
    {
        return $this->highscore_top_num;
    }

◆ getHighscoreTopTable()

ilObjTestSettingsGamification::getHighscoreTopTable ( )

Definition at line 170 of file ilObjTestSettingsGamification.php.

                                          : bool
    {
        return $this->highscore_top_table;
    }

◆ getHighscoreWTime()

ilObjTestSettingsGamification::getHighscoreWTime ( )

Definition at line 264 of file ilObjTestSettingsGamification.php.

                                       : bool
    {
        return $this->highscore_wtime;
    }

◆ toForm()

ilObjTestSettingsGamification::toForm	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery,
		array	$environment = `null`
	)

Reimplemented from TestSettings.

Definition at line 48 of file ilObjTestSettingsGamification.php.

     : FormInput {
        $optional_group = $f->optionalGroup(
            [
                'highscore_mode' => $f->radio($lng->txt('tst_highscore_mode'), "")
                    ->withOption((string) self::HIGHSCORE_SHOW_OWN_TABLE, $lng->txt('tst_highscore_own_table'), $lng->txt('tst_highscore_own_table_description'))
                    ->withOption((string) self::HIGHSCORE_SHOW_TOP_TABLE, $lng->txt('tst_highscore_top_table'), $lng->txt('tst_highscore_top_table_description'))
                    ->withOption((string) self::HIGHSCORE_SHOW_ALL_TABLES, $lng->txt('tst_highscore_all_tables'), $lng->txt('tst_highscore_all_tables_description'))
                    ->withValue($this->getHighScoreMode() > 0 ? (string) $this->getHighScoreMode() : '')
                    ->withRequired(true)
                    ,
                'highscore_top_num' => $f->numeric($lng->txt('tst_highscore_top_num'), $lng->txt('tst_highscore_top_num_description'))
                    ->withRequired(true)
                    ->withValue($this->getHighscoreTopNum()),
                'highscore_anon' => $f->checkbox(
                    $lng->txt('tst_highscore_anon'),
                    $lng->txt('tst_highscore_anon_description')
                )->withValue($this->getHighscoreAnon()),
                'highscore_achieved_ts' => $f->checkbox(
                    $lng->txt('tst_highscore_achieved_ts'),
                    $lng->txt('tst_highscore_achieved_ts_description')
                )->withValue($this->getHighscoreAchievedTS()),
                'highscore_score' => $f->checkbox(
                    $lng->txt('tst_highscore_score'),
                    $lng->txt('tst_highscore_score_description')
                )->withValue($this->getHighscoreScore()),
                'highscore_percentage' => $f->checkbox(
                    $lng->txt('tst_highscore_percentage'),
                    $lng->txt('tst_highscore_percentage_description')
                )->withValue($this->getHighscorePercentage()),
                'highscore_hints' => $f->checkbox(
                    $lng->txt('tst_highscore_hints'),
                    $lng->txt('tst_highscore_hints_description')
                )->withValue($this->getHighscoreHints()),
                'highscore_wtime' => $f->checkbox(
                    $lng->txt('tst_highscore_wtime'),
                    $lng->txt('tst_highscore_wtime_description')
                )->withValue($this->getHighscoreWTime())
 
            ],
            $lng->txt('tst_highscore_enabled'),
            $lng->txt('tst_highscore_description')
        );
 
        if (!$this->getHighscoreEnabled()) {
            $optional_group = $optional_group->withValue(null);
        }
 
        $fields = ['highscore' => $optional_group];
        return $f->section($fields, $lng->txt('tst_results_gamification'))
            ->withAdditionalTransformation(
                $refinery->custom()->transformation(
                    function ($v) {
                        $settings = clone $this;
 
                        if (! $v['highscore']) {
                            return $settings->withHighscoreEnabled(false);
                        }
 
                        return $settings
                            ->withHighscoreEnabled(true)
                            ->withHighscoreOwnTable(
                                (int) $v['highscore']['highscore_mode'] == self::HIGHSCORE_SHOW_OWN_TABLE ||
                                (int) $v['highscore']['highscore_mode'] == self::HIGHSCORE_SHOW_ALL_TABLES
                            )
                            ->withHighscoreTopTable(
                                (int) $v['highscore']['highscore_mode'] == self::HIGHSCORE_SHOW_TOP_TABLE ||
                                (int) $v['highscore']['highscore_mode'] == self::HIGHSCORE_SHOW_ALL_TABLES
                            )
                            ->withHighscoreTopNum($v['highscore']['highscore_top_num'])
                            ->withHighscoreAnon($v['highscore']['highscore_anon'])
                            ->withHighscoreAchievedTS($v['highscore']['highscore_achieved_ts'])
                            ->withHighscoreScore($v['highscore']['highscore_score'])
                            ->withHighscorePercentage($v['highscore']['highscore_percentage'])
                            ->withHighscoreHints($v['highscore']['highscore_hints'])
                            ->withHighscoreWTime($v['highscore']['highscore_wtime']);
                    }
                )
            );
    }

◆ toStorage()

ilObjTestSettingsGamification::toStorage ( )

Reimplemented from TestSettings.

Definition at line 133 of file ilObjTestSettingsGamification.php.

                               : array
    {
        return [
            'highscore_enabled' => ['integer', (int) $this->getHighscoreEnabled()],
            'highscore_anon' => ['integer', (int) $this->getHighscoreAnon()],
            'highscore_achieved_ts' => ['integer', (int) $this->getHighscoreAchievedTS()],
            'highscore_score' => ['integer', (int) $this->getHighscoreScore()],
            'highscore_percentage' => ['integer', (int) $this->getHighscorePercentage()],
            'highscore_hints' => ['integer', (int) $this->getHighscoreHints()],
            'highscore_wtime' => ['integer', (int) $this->getHighscoreWTime()],
            'highscore_own_table' => ['integer', (int) $this->getHighscoreOwnTable()],
            'highscore_top_table' => ['integer', (int) $this->getHighscoreTopTable()],
            'highscore_top_num' => ['integer', $this->getHighscoreTopNum()]
        ];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ withHighscoreAchievedTS()

ilObjTestSettingsGamification::withHighscoreAchievedTS ( bool $highscore_achieved_ts )

Definition at line 224 of file ilObjTestSettingsGamification.php.

                                                                        : self
    {
        $clone = clone $this;
        $clone->highscore_achieved_ts = $highscore_achieved_ts;
        return $clone;
    }

◆ withHighscoreAnon()

ilObjTestSettingsGamification::withHighscoreAnon ( bool $highscore_anon )

Definition at line 213 of file ilObjTestSettingsGamification.php.

                                                           : self
    {
        $clone = clone $this;
        $clone->highscore_anon = $highscore_anon;
        return $clone;
    }

◆ withHighscoreEnabled()

ilObjTestSettingsGamification::withHighscoreEnabled ( bool $highscore_enabled )

Definition at line 153 of file ilObjTestSettingsGamification.php.

                                                                 : self
    {
        $clone = clone $this;
        $clone->highscore_enabled = $highscore_enabled;
        return $clone;
    }

◆ withHighscoreHints()

ilObjTestSettingsGamification::withHighscoreHints ( bool $highscore_hints )

Definition at line 257 of file ilObjTestSettingsGamification.php.

                                                             : self
    {
        $clone = clone $this;
        $clone->highscore_hints = $highscore_hints;
        return $clone;
    }

◆ withHighscoreOwnTable()

ilObjTestSettingsGamification::withHighscoreOwnTable ( bool $highscore_own_table )

Definition at line 164 of file ilObjTestSettingsGamification.php.

                                                                    : self
    {
        $clone = clone $this;
        $clone->highscore_own_table = $highscore_own_table;
        return $clone;
    }

◆ withHighscorePercentage()

ilObjTestSettingsGamification::withHighscorePercentage ( bool $highscore_percentage )

Definition at line 246 of file ilObjTestSettingsGamification.php.

                                                                       : self
    {
        $clone = clone $this;
        $clone->highscore_percentage = $highscore_percentage;
        return $clone;
    }

◆ withHighscoreScore()

ilObjTestSettingsGamification::withHighscoreScore ( bool $highscore_score )

Definition at line 235 of file ilObjTestSettingsGamification.php.

                                                             : self
    {
        $clone = clone $this;
        $clone->highscore_score = $highscore_score;
        return $clone;
    }

◆ withHighscoreTopNum()

ilObjTestSettingsGamification::withHighscoreTopNum ( int $highscore_top_num )

Definition at line 202 of file ilObjTestSettingsGamification.php.

                                                               : self
    {
        $clone = clone $this;
        $clone->highscore_top_num = $highscore_top_num;
        return $clone;
    }

◆ withHighscoreTopTable()

ilObjTestSettingsGamification::withHighscoreTopTable ( bool $highscore_top_table )

Definition at line 174 of file ilObjTestSettingsGamification.php.

                                                                    : self
    {
        $clone = clone $this;
        $clone->highscore_top_table = $highscore_top_table;
        return $clone;
    }

◆ withHighscoreWTime()

ilObjTestSettingsGamification::withHighscoreWTime ( bool $highscore_wtime )

Definition at line 268 of file ilObjTestSettingsGamification.php.

                                                             : self
    {
        $clone = clone $this;
        $clone->highscore_wtime = $highscore_wtime;
        return $clone;
    }

Field Documentation

◆ $highscore_achieved_ts

bool ilObjTestSettingsGamification::$highscore_achieved_ts = true

protected

Definition at line 33 of file ilObjTestSettingsGamification.php.

◆ $highscore_anon

bool ilObjTestSettingsGamification::$highscore_anon = true

protected

Definition at line 32 of file ilObjTestSettingsGamification.php.

◆ $highscore_enabled

bool ilObjTestSettingsGamification::$highscore_enabled = false

protected

Definition at line 31 of file ilObjTestSettingsGamification.php.

◆ $highscore_hints

bool ilObjTestSettingsGamification::$highscore_hints = true

protected

Definition at line 36 of file ilObjTestSettingsGamification.php.

◆ $highscore_own_table

bool ilObjTestSettingsGamification::$highscore_own_table = true

protected

Definition at line 38 of file ilObjTestSettingsGamification.php.

◆ $highscore_percentage

bool ilObjTestSettingsGamification::$highscore_percentage = true

protected

Definition at line 35 of file ilObjTestSettingsGamification.php.

◆ $highscore_score

bool ilObjTestSettingsGamification::$highscore_score = true

protected

Definition at line 34 of file ilObjTestSettingsGamification.php.

◆ $highscore_top_num

int ilObjTestSettingsGamification::$highscore_top_num = 10

protected

Definition at line 40 of file ilObjTestSettingsGamification.php.

◆ $highscore_top_table

bool ilObjTestSettingsGamification::$highscore_top_table = true

protected

Definition at line 39 of file ilObjTestSettingsGamification.php.

◆ $highscore_wtime

bool ilObjTestSettingsGamification::$highscore_wtime = true

protected

Definition at line 37 of file ilObjTestSettingsGamification.php.

◆ HIGHSCORE_SHOW_ALL_TABLES

const ilObjTestSettingsGamification::HIGHSCORE_SHOW_ALL_TABLES = 3

Definition at line 29 of file ilObjTestSettingsGamification.php.

◆ HIGHSCORE_SHOW_OWN_TABLE

const ilObjTestSettingsGamification::HIGHSCORE_SHOW_OWN_TABLE = 1

Definition at line 27 of file ilObjTestSettingsGamification.php.

◆ HIGHSCORE_SHOW_TOP_TABLE

const ilObjTestSettingsGamification::HIGHSCORE_SHOW_TOP_TABLE = 2

Definition at line 28 of file ilObjTestSettingsGamification.php.

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

Modules/Test/classes/ScoreReporting/ilObjTestSettingsGamification.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHighscoreAchievedTS()

◆ getHighscoreAnon()

◆ getHighscoreEnabled()

◆ getHighscoreHints()

◆ getHighScoreMode()

◆ getHighscoreOwnTable()

◆ getHighscorePercentage()

◆ getHighscoreScore()

◆ getHighscoreTopNum()

◆ getHighscoreTopTable()

◆ getHighscoreWTime()

◆ toForm()

◆ toStorage()

◆ withHighscoreAchievedTS()

◆ withHighscoreAnon()

◆ withHighscoreEnabled()

◆ withHighscoreHints()

◆ withHighscoreOwnTable()

◆ withHighscorePercentage()

◆ withHighscoreScore()

◆ withHighscoreTopNum()

◆ withHighscoreTopTable()

◆ withHighscoreWTime()

Field Documentation

◆ $highscore_achieved_ts

◆ $highscore_anon

◆ $highscore_enabled

◆ $highscore_hints

◆ $highscore_own_table

◆ $highscore_percentage

◆ $highscore_score

◆ $highscore_top_num

◆ $highscore_top_table

◆ $highscore_wtime

◆ HIGHSCORE_SHOW_ALL_TABLES

◆ HIGHSCORE_SHOW_OWN_TABLE

◆ HIGHSCORE_SHOW_TOP_TABLE