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

Inheritance diagram for ilWebLinkParameter:

Collaboration diagram for ilWebLinkParameter:

Public Member Functions
	__construct (ilObjUser $user, int $webr_id, int $link_id, int $param_id, int $value, string $name)

	appendToLink (string $link)

	getInfo ()

	toXML (ilXmlWriter $writer)

	getWebrId ()

	getLinkId ()

	getParamId ()

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

	getValue ()

	getName ()

Private Attributes
int	$webr_id

int	$link_id

int	$param_id

ilObjUser	$user

Additional Inherited Members
Data Fields inherited from ilWebLinkBaseParameter
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 inherited from ilWebLinkBaseParameter
int	$value

string	$name

Detailed Description

Immutable 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.ilWebLinkParameter.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebLinkParameter::__construct	(	ilObjUser	$user,
		int	$webr_id,
		int	$link_id,
		int	$param_id,
		int	$value,
		string	$name
	)

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

References $link_id, $param_id, $user, $webr_id, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

       {
         $this->user = $user;
         $this->webr_id = $webr_id;
         $this->link_id = $link_id;
         $this->param_id = $param_id;
         parent::__construct($value, $name);
     }

Here is the call graph for this function:

Member Function Documentation

◆ appendToLink()

ilWebLinkParameter::appendToLink ( string $link )

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

References ilWebLinkBaseParameter\getName(), ilWebLinkBaseParameter\getValue(), and ILIAS\Repository\user().

                                               : string
     {
         if (!strpos($link, '?')) {
             $link .= "?";
         } else {
             $link .= "&";
         }
         $link .= ($this->getName() . "=");
         switch ($this->getValue()) {
             case self::VALUES['login']:
                 $link .= (urlencode(
                     $this->user->getLogin()
                 ));
                 break;
 
             case self::VALUES['user_id']:
                 $link .= ($this->user->getId());
                 break;
 
             case self::VALUES['matriculation']:
                 $link .= ($this->user->getMatriculation());
                 break;
 
             default:
                 throw new ilWebLinkParameterException(
                     'Invalid parameter value'
                 );
         }
 
         return $link;
     }

Here is the call graph for this function:

◆ getInfo()

ilWebLinkParameter::getInfo ( )

Definition at line 81 of file class.ilWebLinkParameter.php.

References $info, ilWebLinkBaseParameter\getName(), and ilWebLinkBaseParameter\getValue().

                              : string
     {
         $info = $this->getName();
 
         switch ($this->getValue()) {
             case self::VALUES['user_id']:
                 return $info . '=USER_ID';
 
             case self::VALUES['login']:
                 return $info . '=LOGIN';
 
             case self::VALUES['matriculation']:
                 return $info . '=MATRICULATION';
 
             default:
                 throw new ilWebLinkParameterException(
                     'Invalid parameter value'
                 );
         }
     }

Here is the call graph for this function:

◆ getLinkId()

ilWebLinkParameter::getLinkId ( )

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

References $link_id.

                                : int
     {
         return $this->link_id;
     }

◆ getParamId()

ilWebLinkParameter::getParamId ( )

Definition at line 141 of file class.ilWebLinkParameter.php.

References $param_id.

Referenced by toXML().

                                 : int
     {
         return $this->param_id;
     }

Here is the caller graph for this function:

◆ getWebrId()

ilWebLinkParameter::getWebrId ( )

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

References $webr_id.

                                : int
     {
         return $this->webr_id;
     }

◆ toXML()

ilWebLinkParameter::toXML ( ilXmlWriter $writer )

Definition at line 102 of file class.ilWebLinkParameter.php.

References ilWebLinkBaseParameter\$value, ilWebLinkBaseParameter\getName(), getParamId(), ilWebLinkBaseParameter\getValue(), and ilXmlWriter\xmlElement().

                                               : void
     {
         switch ($this->getValue()) {
             case self::VALUES['user_id']:
                 $value = 'userId';
                 break;
 
             case self::VALUES['login']:
                 $value = 'userName';
                 break;
 
             case self::VALUES['matriculation']:
                 $value = 'matriculation';
                 break;
 
             default:
                 return;
         }
 
         $writer->xmlElement(
             'DynamicParameter',
             [
                 'id' => $this->getParamId(),
                 'name' => $this->getName(),
                 'type' => $value
             ]
         );
     }