Caches and supplies the paths to the learning progress status images. More...

Inheritance diagram for ilLPStatusIcons:

Collaboration diagram for ilLPStatusIcons:

Public Member Functions
	getImagePathInProgress ()

	getImagePathCompleted ()

	getImagePathNotAttempted ()

	getImagePathFailed ()

	getImagePathAsset ()
	A long variant of this icon is not available. More...

	getImagePathRunning ()
	A long variant of this icon is not available. More...

	renderIcon (string $path, string $alt)

	getIconComponent (string $path, string $alt)

	getImagePathForStatus (int $a_status)

	renderIconForStatus (int $a_status, ?ilLanguage $a_lng=null)
	Returns the rendered icon with alt text. More...

	lookupNumStatus (string $a_status)
	Transforms the string constants for the status to their interger equivalent. More...

Static Public Member Functions
static	getInstance (int $variant=ilLPStatusIcons::ICON_VARIANT_DEFAULT, ?\ILIAS\UI\Renderer $renderer=null, ?\ILIAS\UI\Factory $factory=null)

Data Fields
const	ICON_VARIANT_LONG = 0

const	ICON_VARIANT_SHORT = 1

const	ICON_VARIANT_SCORM = 2

const	ICON_VARIANT_DEFAULT = ilLPStatusIcons::ICON_VARIANT_LONG

Protected Member Functions
	buildImagePath (string $image_name)

Private Member Functions
	__construct (int $variant, \ILIAS\UI\Renderer $renderer, \ILIAS\UI\Factory $factory)

Private Attributes
string	$image_path_in_progress = ''

string	$image_path_completed = ''

string	$image_path_not_attempted = ''

string	$image_path_failed = ''

string	$image_path_asset = ''

string	$image_path_running = ''

ILIAS UI Factory	$factory

ILIAS UI Renderer	$renderer

Static Private Attributes
static self	$instance_variant_long = null

static self	$instance_variant_short = null

static self	$instance_variant_scorm = null

Detailed Description

Caches and supplies the paths to the learning progress status images.

Author: Tim Schmitz schmi.nosp@m.tz@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilLPStatusIcons.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPStatusIcons::__construct	(	int	$variant,
		\ILIAS\UI\Renderer	$renderer,
		\ILIAS\UI\Factory	$factory
	)

private

Definition at line 80 of file class.ilLPStatusIcons.php.

    {
        $this->factory = $factory;
        $this->renderer = $renderer;
 
        switch ($variant) {
            case ilLPStatusIcons::ICON_VARIANT_SCORM:
                $this->image_path_in_progress = $this->buildImagePath('scorm/incomplete.svg');
                $this->image_path_completed = $this->buildImagePath('scorm/complete.svg');
                $this->image_path_not_attempted = $this->buildImagePath('scorm/not_attempted.svg');
                $this->image_path_failed = $this->buildImagePath('scorm/failed.svg');
                $this->image_path_asset = $this->buildImagePath('scorm/asset.svg');
                $this->image_path_running = $this->buildImagePath('scorm/running.svg');
                break;
 
            case ilLPStatusIcons::ICON_VARIANT_SHORT:
                $this->image_path_in_progress = $this->buildImagePath('learning_progress/short/in_progress.svg');
                $this->image_path_completed = $this->buildImagePath('learning_progress/short/completed.svg');
                $this->image_path_not_attempted = $this->buildImagePath('learning_progress/short/not_attempted.svg');
                $this->image_path_failed = $this->buildImagePath('learning_progress/short/failed.svg');
                $this->image_path_asset = $this->buildImagePath('learning_progress/short/asset.svg');
                $this->image_path_running = $this->buildImagePath('learning_progress/short/running.svg');
                break;
 
            case ilLPStatusIcons::ICON_VARIANT_LONG:
                $this->image_path_in_progress = $this->buildImagePath('learning_progress/in_progress.svg');
                $this->image_path_completed = $this->buildImagePath('learning_progress/completed.svg');
                $this->image_path_not_attempted = $this->buildImagePath('learning_progress/not_attempted.svg');
                $this->image_path_failed = $this->buildImagePath('learning_progress/failed.svg');
                break;
 
            default:
                throw new ilLPException("No such variant of the LP icons exists.");
        }
    }

References $factory, $renderer, buildImagePath(), factory(), ICON_VARIANT_LONG, ICON_VARIANT_SCORM, ICON_VARIANT_SHORT, and renderer().

Here is the call graph for this function:

Member Function Documentation

◆ buildImagePath()

ilLPStatusIcons::buildImagePath ( string $image_name )

protected

Reimplemented in ilLPStatusIconsMock.

Definition at line 116 of file class.ilLPStatusIcons.php.

                                                         : string
    {
        return ilUtil::getImagePath($image_name);
    }

References ilUtil\getImagePath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIconComponent()

ilLPStatusIcons::getIconComponent	(	string	$path,
		string	$alt
	)

Definition at line 172 of file class.ilLPStatusIcons.php.

                                                               : \ILIAS\UI\Component\Symbol\Icon\Custom
    {
        return $this->factory->symbol()->icon()->custom($path, $alt, \ILIAS\UI\Component\Symbol\Icon\Icon::SMALL);
    }

References factory().

Referenced by renderIcon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePathAsset()

ilLPStatusIcons::getImagePathAsset ( )

A long variant of this icon is not available.

Definition at line 144 of file class.ilLPStatusIcons.php.

                                       : string
    {
        if ($this->image_path_asset) {
            return $this->image_path_asset;
        }
        throw new ilLPException("A long variant of the 'asset' LP icon does not exist.");
    }

References $image_path_asset.

◆ getImagePathCompleted()

ilLPStatusIcons::getImagePathCompleted ( )

Definition at line 126 of file class.ilLPStatusIcons.php.

                                           : string
    {
        return $this->image_path_completed;
    }

References $image_path_completed.

Referenced by getImagePathForStatus().

Here is the caller graph for this function:

◆ getImagePathFailed()

ilLPStatusIcons::getImagePathFailed ( )

Definition at line 136 of file class.ilLPStatusIcons.php.

                                        : string
    {
        return $this->image_path_failed;
    }

References $image_path_failed.

Referenced by getImagePathForStatus().

Here is the caller graph for this function:

◆ getImagePathForStatus()

ilLPStatusIcons::getImagePathForStatus ( int $a_status )

Todo:: Check whether the default can be replaced by an exception.

Definition at line 180 of file class.ilLPStatusIcons.php.

                                                        : string
    {
        switch ($a_status) {
            case ilLPStatus::LP_STATUS_IN_PROGRESS_NUM:
                return $this->getImagePathInProgress();
 
            case ilLPStatus::LP_STATUS_COMPLETED_NUM:
                return $this->getImagePathCompleted();
 
            case ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM:
                return $this->getImagePathNotAttempted();
 
            case ilLPStatus::LP_STATUS_FAILED_NUM:
                return $this->getImagePathFailed();
 
            default:
                return $this->getImagePathNotAttempted();
        }
    }

References getImagePathCompleted(), getImagePathFailed(), getImagePathInProgress(), getImagePathNotAttempted(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by renderIconForStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePathInProgress()

ilLPStatusIcons::getImagePathInProgress ( )

Definition at line 121 of file class.ilLPStatusIcons.php.

                                            : string
    {
        return $this->image_path_in_progress;
    }

References $image_path_in_progress.

Referenced by getImagePathForStatus().

Here is the caller graph for this function:

◆ getImagePathNotAttempted()

ilLPStatusIcons::getImagePathNotAttempted ( )

Definition at line 131 of file class.ilLPStatusIcons.php.

                                              : string
    {
        return $this->image_path_not_attempted;
    }

References $image_path_not_attempted.

Referenced by getImagePathForStatus().

Here is the caller graph for this function:

◆ getImagePathRunning()

ilLPStatusIcons::getImagePathRunning ( )

A long variant of this icon is not available.

Definition at line 155 of file class.ilLPStatusIcons.php.

                                         : string
    {
        if ($this->image_path_running) {
            return $this->image_path_running;
        }
        throw new ilLPException("A long variant of the 'running' LP icon does not exist.");
    }

References $image_path_running.

◆ getInstance()

static ilLPStatusIcons::getInstance	(	int	$variant = `ilLPStatusIcons::ICON_VARIANT_DEFAULT`,
		?\ILIAS\UI\Renderer	$renderer = `null`,
		?\ILIAS\UI\Factory	$factory = `null`
	)

static

Definition at line 48 of file class.ilLPStatusIcons.php.

                                                                                                                                                                    : ilLPStatusIcons
    {
        if (!$renderer || !$factory) {
            global $DIC;
            $renderer = $DIC->ui()->renderer();
            $factory = $DIC->ui()->factory();
        }
 
        switch ($variant) {
            case ilLPStatusIcons::ICON_VARIANT_SCORM:
                if (self::$instance_variant_scorm) {
                    return self::$instance_variant_scorm;
                }
                return self::$instance_variant_scorm = new self(ilLPStatusIcons::ICON_VARIANT_SCORM, $renderer, $factory);
 
            case ilLPStatusIcons::ICON_VARIANT_SHORT:
                if (self::$instance_variant_short) {
                    return self::$instance_variant_short;
                }
                return self::$instance_variant_short = new self(ilLPStatusIcons::ICON_VARIANT_SHORT, $renderer, $factory);
 
            case ilLPStatusIcons::ICON_VARIANT_LONG:
                if (self::$instance_variant_long) {
                    return self::$instance_variant_long;
                }
                return self::$instance_variant_long = new self(ilLPStatusIcons::ICON_VARIANT_LONG, $renderer, $factory);
 
            default:
                throw new ilLPException("No such variant of the LP icons exists.");
        }
    }

References $DIC, $factory, $instance_variant_long, $instance_variant_scorm, $instance_variant_short, $renderer, ICON_VARIANT_LONG, ICON_VARIANT_SCORM, and ICON_VARIANT_SHORT.

Referenced by ilLSTOCGUI\__construct(), ILIAS\Forum\Statistics\ForumStatisticsTable\__construct(), ilLearningProgressBaseGUI\__getLegendHTML(), ilLMExplorerGUI\checkLPIcon(), ilCourseParticipantsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilExGradesTableGUI\getIconForStatus(), ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\getIconForStatus(), ilTrSummaryTableGUI\getItems(), ilDclRecordListTableGUI\getStatus(), ilMyStaffGUI\getUserLpStatusAsHtml(), ilLPObjectStatisticsLPTableGUI\init(), ilLearningProgressGUI\initCollectionManualForm(), ilCourseObjectiveListGUI\insertProgressInfo(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilSCORMTrackingItemsTableGUI\parseValue(), ilLPStatus\preloadListGUIData(), ilLearningProgressGUI\showtlt(), ilLPStatusIconsTest\testGetInstanceForInvalidVariant(), and ilLPStatusIconsTest\testTripleton().

Here is the caller graph for this function:

◆ lookupNumStatus()

ilLPStatusIcons::lookupNumStatus ( string $a_status )

Transforms the string constants for the status to their interger equivalent.

Definition at line 214 of file class.ilLPStatusIcons.php.

                                                     : int
    {
        switch ($a_status) {
            case ilLPStatus::LP_STATUS_IN_PROGRESS:
                return ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
 
            case ilLPStatus::LP_STATUS_COMPLETED:
                return ilLPStatus::LP_STATUS_COMPLETED_NUM;
 
            case ilLPStatus::LP_STATUS_NOT_ATTEMPTED:
                return ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
 
            case ilLPStatus::LP_STATUS_FAILED:
                return ilLPStatus::LP_STATUS_FAILED_NUM;
 
            default:
                throw new ilLPException("Not a valid status");
        }
    }

References ilLPStatus\LP_STATUS_COMPLETED, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

◆ renderIcon()

ilLPStatusIcons::renderIcon	(	string	$path,
		string	$alt
	)

Definition at line 163 of file class.ilLPStatusIcons.php.

                                                         : string
    {
        if ($this === self::$instance_variant_scorm) {
            throw new ilLPException("SCORM variants of the LP icons cannot be rendered.");
        }
 
        return $this->renderer->render($this->getIconComponent($path, $alt));
    }

References getIconComponent(), and renderer().

Referenced by renderIconForStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderIconForStatus()

ilLPStatusIcons::renderIconForStatus	(	int	$a_status,
		?ilLanguage	$a_lng = `null`
	)

Returns the rendered icon with alt text.

Definition at line 203 of file class.ilLPStatusIcons.php.

                                                                                 : string
    {
        return $this->renderIcon(
            $this->getImagePathForStatus($a_status),
            ilLearningProgressBaseGUI::_getStatusText($a_status, $a_lng)
        );
    }

References ilLearningProgressBaseGUI\_getStatusText(), getImagePathForStatus(), and renderIcon().

Here is the call graph for this function:

Field Documentation

◆ $factory

ILIAS UI Factory ilLPStatusIcons::$factory

private

Definition at line 45 of file class.ilLPStatusIcons.php.

Referenced by __construct(), and getInstance().

◆ $image_path_asset

string ilLPStatusIcons::$image_path_asset = ''

private

Definition at line 42 of file class.ilLPStatusIcons.php.

Referenced by getImagePathAsset().

◆ $image_path_completed

string ilLPStatusIcons::$image_path_completed = ''

private

Definition at line 37 of file class.ilLPStatusIcons.php.

Referenced by getImagePathCompleted().

◆ $image_path_failed

string ilLPStatusIcons::$image_path_failed = ''

private

Definition at line 39 of file class.ilLPStatusIcons.php.

Referenced by getImagePathFailed().

◆ $image_path_in_progress

string ilLPStatusIcons::$image_path_in_progress = ''

private

Definition at line 36 of file class.ilLPStatusIcons.php.

Referenced by getImagePathInProgress().

◆ $image_path_not_attempted

string ilLPStatusIcons::$image_path_not_attempted = ''

private

Definition at line 38 of file class.ilLPStatusIcons.php.

Referenced by getImagePathNotAttempted().

◆ $image_path_running

string ilLPStatusIcons::$image_path_running = ''

private

Definition at line 43 of file class.ilLPStatusIcons.php.

Referenced by getImagePathRunning().

◆ $instance_variant_long

self ilLPStatusIcons::$instance_variant_long = null

staticprivate

Definition at line 32 of file class.ilLPStatusIcons.php.

Referenced by getInstance().

◆ $instance_variant_scorm

self ilLPStatusIcons::$instance_variant_scorm = null

staticprivate

Definition at line 34 of file class.ilLPStatusIcons.php.

Referenced by getInstance().

◆ $instance_variant_short

self ilLPStatusIcons::$instance_variant_short = null

staticprivate

Definition at line 33 of file class.ilLPStatusIcons.php.

Referenced by getInstance().

◆ $renderer

ILIAS UI Renderer ilLPStatusIcons::$renderer

private

Definition at line 46 of file class.ilLPStatusIcons.php.

Referenced by __construct(), and getInstance().

◆ ICON_VARIANT_DEFAULT

const ilLPStatusIcons::ICON_VARIANT_DEFAULT = ilLPStatusIcons::ICON_VARIANT_LONG

Definition at line 30 of file class.ilLPStatusIcons.php.

◆ ICON_VARIANT_LONG

const ilLPStatusIcons::ICON_VARIANT_LONG = 0

Definition at line 27 of file class.ilLPStatusIcons.php.

Referenced by __construct(), ILIAS\Forum\Statistics\ForumStatisticsTable\__construct(), ilCourseParticipantsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilExGradesTableGUI\getIconForStatus(), getInstance(), ilDclRecordListTableGUI\getStatus(), ilMyStaffGUI\getUserLpStatusAsHtml(), ilLearningProgressGUI\initCollectionManualForm(), ilCourseObjectiveListGUI\insertProgressInfo(), ilLPStatus\preloadListGUIData(), ilLearningProgressGUI\showtlt(), and ilLPStatusIconsTest\testTripleton().

◆ ICON_VARIANT_SCORM

const ilLPStatusIcons::ICON_VARIANT_SCORM = 2

Definition at line 29 of file class.ilLPStatusIcons.php.

Referenced by __construct(), getInstance(), ilSCORM2004TrackingItemsTableGUI\parseValue(), ilSCORMTrackingItemsTableGUI\parseValue(), and ilLPStatusIconsTest\testTripleton().

◆ ICON_VARIANT_SHORT

const ilLPStatusIcons::ICON_VARIANT_SHORT = 1

Definition at line 28 of file class.ilLPStatusIcons.php.

Referenced by __construct(), ilLSTOCGUI\__construct(), ilLPListOfObjectsGUI\__listObjects(), ilLMExplorerGUI\checkLPIcon(), getInstance(), ilTrSummaryTableGUI\getItems(), ilLPObjectStatisticsLPTableGUI\init(), ilLPListOfObjectsGUI\showObjectSummary(), and ilLPStatusIconsTest\testTripleton().

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

components/ILIAS/Tracking/classes/status/class.ilLPStatusIcons.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildImagePath()

◆ getIconComponent()

◆ getImagePathAsset()

◆ getImagePathCompleted()

◆ getImagePathFailed()

◆ getImagePathForStatus()

◆ getImagePathInProgress()

◆ getImagePathNotAttempted()

◆ getImagePathRunning()

◆ getInstance()

◆ lookupNumStatus()

◆ renderIcon()

◆ renderIconForStatus()

Field Documentation

◆ $factory

◆ $image_path_asset

◆ $image_path_completed

◆ $image_path_failed

◆ $image_path_in_progress

◆ $image_path_not_attempted

◆ $image_path_running

◆ $instance_variant_long

◆ $instance_variant_scorm

◆ $instance_variant_short

◆ $renderer

◆ ICON_VARIANT_DEFAULT

◆ ICON_VARIANT_LONG

◆ ICON_VARIANT_SCORM

◆ ICON_VARIANT_SHORT