Base class for parameters attached to Web Link items. More...

Inheritance diagram for ilWebLinkBaseParameter:

Collaboration diagram for ilWebLinkBaseParameter:

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

	getValue ()

	getName ()

Data Fields
const string	UNDEFINED_NAME = 'undefined'

const string	USER_ID_NAME = 'user_id'

const string	LOGIN_NAME = 'login'

const string	MATRICULATION_NAME = 'matriculation'

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

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

Protected Attributes
int	$value

string	$name

Detailed Description

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 25 of file class.ilWebLinkBaseParameter.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

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

References $name, and $value.

Member Function Documentation

◆ getName()

ilWebLinkBaseParameter::getName ( )

Definition at line 67 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 62 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 54 of file class.ilWebLinkBaseParameter.php.

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

◆ $value

int ilWebLinkBaseParameter::$value

protected

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

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

◆ LOGIN_NAME

const string ilWebLinkBaseParameter::LOGIN_NAME = 'login'

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

◆ MATRICULATION_NAME

const string ilWebLinkBaseParameter::MATRICULATION_NAME = 'matriculation'

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

◆ UNDEFINED_NAME

const string ilWebLinkBaseParameter::UNDEFINED_NAME = 'undefined'

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

◆ USER_ID_NAME

const string ilWebLinkBaseParameter::USER_ID_NAME = 'user_id'

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

◆ VALUES

const array ilWebLinkBaseParameter::VALUES

Initial value:

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

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

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

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

◆ VALUES_TEXT

const array 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::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 46 of file class.ilWebLinkBaseParameter.php.

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

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

components/ILIAS/WebResource/classes/Parameter/class.ilWebLinkBaseParameter.php

Public Member Functions

Data Fields

Protected Attributes