This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilWebLinkBaseParameter:

Collaboration diagram for ilWebLinkBaseParameter:

Public Member Functions
	__construct (int $value, string $name)

	getValue ()

	getName ()

Data Fields
const	UNDEFINED_NAME = 'undefined'

const	USER_ID_NAME = 'user_id'

const	SESSION_ID_NAME = 'session_id'

const	LOGIN_NAME = 'login'

const	MATRICULATION_NAME = 'matriculation'

const	VALUES
	TODO Once the GUI is updated, undefined can be dropped. More...

const	VALUES_TEXT
	Keys of the language variables to the possible values, e.g. More...

Protected Attributes
int	$value

string	$name

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Base class for parameters attached to Web Link items

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

Definition at line 26 of file class.ilWebLinkBaseParameter.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkBaseParameter::__construct	(	int	$value,
		string	$name
	)

Definition at line 60 of file class.ilWebLinkBaseParameter.php.

    {
        $this->value = $value;
        $this->name = $name;
    }

References $name, and $value.

Member Function Documentation

◆ getName()

ilWebLinkBaseParameter::getName ( )

Definition at line 71 of file class.ilWebLinkBaseParameter.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by ilWebLinkParameter\appendToLink(), ilWebLinkParameter\getInfo(), ilWebLinkParameter\toXML(), and ilWebLinkDraftParameter\validate().

Here is the caller graph for this function:

◆ getValue()

ilWebLinkBaseParameter::getValue ( )

Definition at line 66 of file class.ilWebLinkBaseParameter.php.

                              : int
    {
        return $this->value;
    }

References $value.

Referenced by ilWebLinkParameter\appendToLink(), ilWebLinkParameter\getInfo(), ilWebLinkParameter\toXML(), ilWebLinkDraftParameter\validate(), and ilWebLinkDatabaseRepository\validateParameter().

Here is the caller graph for this function:

Field Documentation

◆ $name

string ilWebLinkBaseParameter::$name

protected

Definition at line 58 of file class.ilWebLinkBaseParameter.php.

Referenced by ilWebLinkParameter\__construct(), __construct(), and getName().

◆ $value

int ilWebLinkBaseParameter::$value

protected

Definition at line 57 of file class.ilWebLinkBaseParameter.php.

Referenced by ilWebLinkParameter\__construct(), __construct(), getValue(), and ilWebLinkParameter\toXML().

◆ LOGIN_NAME

const ilWebLinkBaseParameter::LOGIN_NAME = 'login'

Definition at line 31 of file class.ilWebLinkBaseParameter.php.

◆ MATRICULATION_NAME

const ilWebLinkBaseParameter::MATRICULATION_NAME = 'matriculation'

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

◆ SESSION_ID_NAME

const ilWebLinkBaseParameter::SESSION_ID_NAME = 'session_id'

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

Referenced by ilWebResourceEditableLinkTableGUI\fillRow(), ilWebLinkItemExternal\getResolvedLink(), and ilObjLinkResourceGUI\initFormLink().

◆ UNDEFINED_NAME

const ilWebLinkBaseParameter::UNDEFINED_NAME = 'undefined'

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

◆ USER_ID_NAME

const ilWebLinkBaseParameter::USER_ID_NAME = 'user_id'

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

◆ VALUES

const ilWebLinkBaseParameter::VALUES

Initial value:

= [
        self::UNDEFINED_NAME => 0,
        self::USER_ID_NAME => 1,
        self::SESSION_ID_NAME => 2,
        self::LOGIN_NAME => 3,
        self::MATRICULATION_NAME => 4
    ]

TODO Once the GUI is updated, undefined can be dropped.

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

Referenced by ilWebResourceEditableLinkTableGUI\fillRow(), ilWebLinkItemExternal\getResolvedLink(), ilObjLinkResourceGUI\initFormLink(), ilWebResourceParameterTest\testAppendToLink(), ilWebResourceDatabaseRepositoryTest\testCreateAllItemsInDraftContainer(), ilWebResourceDatabaseRepositoryTest\testCreateExternalItem(), ilWebResourceDatabaseRepositoryTest\testCreateInternalItemWithBrokenParameter(), ilWebResourceDatabaseRepositoryTest\testCreateItemBrokenInternalLinkException(), ilWebResourceParameterTest\testGetInfo(), ilWebResourceParameterTest\testToXML(), and ilWebLinkDatabaseRepository\validateParameter().

◆ VALUES_TEXT

const ilWebLinkBaseParameter::VALUES_TEXT

Initial value:

= [
        self::VALUES[self::UNDEFINED_NAME] => 'links_select_one',
        self::VALUES[self::USER_ID_NAME] => 'links_user_id',
        self::VALUES[self::SESSION_ID_NAME] => 'links_session_id',
        self::VALUES[self::LOGIN_NAME] => 'links_user_name',
        self::VALUES[self::MATRICULATION_NAME] => 'matriculation',
    ]

Keys of the language variables to the possible values, e.g.

to fill a select input.

Definition at line 49 of file class.ilWebLinkBaseParameter.php.

Referenced by ilWebResourceEditableLinkTableGUI\fillRow(), and ilObjLinkResourceGUI\initFormLink().

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

Modules/WebResource/classes/Parameter/class.ilWebLinkBaseParameter.php

Public Member Functions

Data Fields

Protected Attributes