This class represents a external and/or internal link in a property form. More...

Inheritance diagram for ilLinkInputGUI:

Collaboration diagram for ilLinkInputGUI:

Public Member Functions
	__construct (string $a_title="", string $a_postvar="")

	setAllowedLinkTypes (string $a_val)
	Set allowed link types (LIST, BOTH, INT, EXT) More...

	getAllowedLinkTypes ()

	setInternalLinkDefault (string $a_type, int $a_obj=0)
	Set internal link default. More...

	setInternalLinkFilterTypes (array $a_val)
	Set internal link filter types. More...

	setFilterWhiteList (bool $a_val)
	Set filter white list. More...

	getFilterWhiteList ()

	setExternalLinkMaxLength (int $a_max)

	getExternalLinkMaxLength ()

	executeCommand ()

	setValue (string $a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValueByArray (array $a_values)

	checkInput ()
	Check input, strip slashes etc. More...

	getInput ()

	render ()

	getContentOutsideFormTag ()

	insert (ilTemplate $a_tpl)

	getIntLinkAttributes ()
	Get value as internal link attributes. More...

	setValueByIntLinkAttributes (string $a_type, string $a_target, string $a_target_frame="")

	getOnloadCode ()

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

	getItemByPostVar (string $a_post_var)
	Get item by post var. More...

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Static Public Member Functions
static	getTypeToAttrType ()
	Get internal types to xml attribute types map. More...

static	getAttrTypeToType ()
	Get internal types to xml attribute types map (reverse) More...

static	isInternalLink (string $a_value)

static	getTranslatedValue (string $a_value)

Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Data Fields
const	EXTERNAL_LINK_MAX_LENGTH = 200

const	LIST = "list"

const	BOTH = "both"

const	INT = "int"

const	EXT = "ext"

Protected Attributes
string	$allowed_link_types = self::BOTH

string	$int_link_default_type = "RepositoryItem"

int	$int_link_default_obj = 0

array	$int_link_filter_types = array("RepositoryItem")

bool	$filter_white_list = true

int	$external_link_max_length = self::EXTERNAL_LINK_MAX_LENGTH

ilObjectDefinition	$obj_definition

string	$requested_postvar

string	$value = ""

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Static Protected Attributes
static array	$iltypemap

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This class represents a external and/or internal link in a property form.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilLinkInputGUI: ilFormPropertyDispatchGUI ilLinkInputGUI: ilInternalLinkGUI

Deprecated:: 12 This component will be removed with ILIAS 12

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

Constructor & Destructor Documentation

◆ __construct()

ilLinkInputGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

Definition at line 55 of file class.ilLinkInputGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormPropertyGUI\setType(), and ilFormPropertyGUI\str().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
 
         parent::__construct($a_title, $a_postvar);
         $this->setType("link");
 
         $this->obj_definition = $DIC["objDefinition"];
 
         $this->requested_postvar = $this->str("postvar");
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilLinkInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: bool Input ok, true/false

Definition at line 239 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilFormPropertyGUI\str(), and ilLanguage\txt().

                                 : bool
     {
         $lng = $this->lng;
 
         // debugging
         // return false;
 
         $mode_type = $this->str($this->getPostVar() . "_mode_type");
         $ajax_type = $this->str($this->getPostVar() . "_ajax_type");
         $ajax_id = $this->str($this->getPostVar() . "_ajax_id");
         $mode = $this->str($this->getPostVar() . "_mode");
         $value = $this->str($this->getPostVar());
 
         if ($this->getRequired()) {
             if ($mode_type == "list") {
                 return true;
             }
 
             switch ($mode) {
                 case "ext":
                     if (!$value) {
                         $this->setAlert($lng->txt("msg_input_is_required"));
                         return false;
                     }
                     break;
 
                 case "int":
                     if (!$ajax_type || !$ajax_id) {
                         $this->setAlert($lng->txt("msg_input_is_required"));
                         return false;
                     }
                     break;
 
                 case "no":
                 default:
                     $this->setAlert($lng->txt("msg_input_is_required"));
                     return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ executeCommand()

ilLinkInputGUI::executeCommand ( )

Definition at line 159 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\$ctrl, ilFormPropertyGUI\$lng, getFilterWhiteList(), and ilLanguage\loadLanguageModule().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd();
 
         $ret = "";
         switch ($next_class) {
             case "ilinternallinkgui":
                 $lng->loadLanguageModule("content");
                 $link_gui = new ilInternalLinkGUI(
                     $this->int_link_default_type,
                     $this->int_link_default_obj
                 );
                 foreach ($this->int_link_filter_types as $t) {
                     $link_gui->filterLinkType($t);
                 }
                 $link_gui->setFilterWhiteList($this->getFilterWhiteList());
 
                 $ret = $ilCtrl->forwardCommand($link_gui);
                 break;
 
             default:
                 var_dump($cmd);
                 //exit();
         }
 
         return $ret;
     }

Here is the call graph for this function:

◆ getAllowedLinkTypes()

ilLinkInputGUI::getAllowedLinkTypes ( )

Definition at line 82 of file class.ilLinkInputGUI.php.

References $allowed_link_types.

Referenced by getContentOutsideFormTag(), and render().

                                          : string
     {
         return $this->allowed_link_types;
     }

Here is the caller graph for this function:

◆ getAttrTypeToType()

static ilLinkInputGUI::getAttrTypeToType ( )

static

Get internal types to xml attribute types map (reverse)

Returns: string[]

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

                                               : array
     {
         return array_flip(self::$iltypemap);
     }

◆ getContentOutsideFormTag()

ilLinkInputGUI::getContentOutsideFormTag ( )

Definition at line 498 of file class.ilLinkInputGUI.php.

References getAllowedLinkTypes(), and ilInternalLinkGUI\getInitHTML().

                                               : string
     {
         if ($this->getAllowedLinkTypes() == self::INT ||
             $this->getAllowedLinkTypes() == self::BOTH ||
             $this->getAllowedLinkTypes() == self::LIST) {
             // as the ajax-panel uses a form it has to be outside of the parent form!
             return ilInternalLinkGUI::getInitHTML("");
         }
         return "";
     }

Here is the call graph for this function:

◆ getExternalLinkMaxLength()

ilLinkInputGUI::getExternalLinkMaxLength ( )

Definition at line 154 of file class.ilLinkInputGUI.php.

References $external_link_max_length.

Referenced by render().

                                               : int
     {
         return $this->external_link_max_length;
     }

Here is the caller graph for this function:

◆ getFilterWhiteList()

ilLinkInputGUI::getFilterWhiteList ( )

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

References $filter_white_list.

Referenced by executeCommand().

                                         : bool
     {
         return $this->filter_white_list;
     }

Here is the caller graph for this function:

◆ getInput()

ilLinkInputGUI::getInput ( )

Definition at line 282 of file class.ilLinkInputGUI.php.

References $value, ilFormPropertyGUI\getPostVar(), and ilFormPropertyGUI\str().

Referenced by getIntLinkAttributes().

                               : string
     {
         $ajax_type = $this->str($this->getPostVar() . "_ajax_type");
         $ajax_id = $this->str($this->getPostVar() . "_ajax_id");
         $ajax_target = $this->str($this->getPostVar() . "_ajax_target");
         $mode = $this->str($this->getPostVar() . "_mode");
         $value = $this->str($this->getPostVar());
 
         if ($mode == "int") {
             // overwriting post-data so getInput() will work
             $val = $ajax_type . "|" . $ajax_id;
             if ($ajax_target != "") {
                 $val .= "|" . $ajax_target;
             }
             return $val;
         } elseif ($mode == "no") {
             return "";
         }
         return $value;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIntLinkAttributes()

ilLinkInputGUI::getIntLinkAttributes ( )

Get value as internal link attributes.

Returns: array (with keys "Type", "Target" and "TargetFrame")

Definition at line 584 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\$type, getInput(), and null.

                                           : ?array
     {
         $val = explode("|", $this->getInput());
         $ret = null;
         $type = "";
         $target = "";
         if (self::isInternalLink($this->getInput())) {
             $target_frame = $val[2] ?? "";
             $map = self::getTypeToAttrType();
             if (isset($map[$val[0]])) {
                 $type = $map[$val[0]];
                 $target_type = $val[0];
                 if ($val[0] == "chap") {
                     $target_type = "st";
                 }
                 if ($val[0] == "term") {
                     $target_type = "git";
                 }
                 if ($val[0] == "page") {
                     $target_type = "pg";
                 }
                 $target = "il__" . $target_type . "_" . $val[1];
             } elseif ($this->obj_definition->isRBACObject($val[0])) {
                 $type = "RepositoryItem";
                 $target = "il__obj_" . $val[1];
             }
             if ($type != "") {
                 $ret = array(
                     "Target" => $target,
                     "Type" => $type,
                     "TargetFrame" => $target_frame
                 );
             }
         }
         return $ret;
     }

Here is the call graph for this function:

◆ getOnloadCode()

ilLinkInputGUI::getOnloadCode ( )

Definition at line 644 of file class.ilLinkInputGUI.php.

References ilInternalLinkGUI\getOnloadCode().

                                    : array
     {
         return [
             ilInternalLinkGUI::getOnloadCode("")
         ];
     }

Here is the call graph for this function:

◆ getTranslatedValue()

static ilLinkInputGUI::getTranslatedValue ( string $a_value )

static

Definition at line 526 of file class.ilLinkInputGUI.php.

References $DIC, ilFormPropertyGUI\$lng, ilFormPropertyGUI\$type, ilGlossaryTerm\_lookGlossaryTerm(), ilObject\_lookupObjId(), ilLMObject\_lookupTitle(), ilObject\_lookupTitle(), ilWikiPage\lookupTitle(), and ilLanguage\txt().

Referenced by ilWebResourceEditableLinkTableGUI\fillRow().

                                                               : array
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $value = explode("|", $a_value);
         if ($value === false || $value === []) {
             return [];
         }
         switch ($value[0]) {
             case "media":
                 $type = $lng->txt("obj_mob");
                 $name = ilObject::_lookupTitle((int) $value[1]);
                 break;
 
             case "page":
                 $type = $lng->txt("obj_pg");
                 $name = ilLMPageObject::_lookupTitle((int) $value[1]);
                 break;
 
             case "chap":
                 $type = $lng->txt("obj_st");
                 $name = ilStructureObject::_lookupTitle((int) $value[1]);
                 break;
 
             case "term":
                 $type = $lng->txt("term");
                 $name = ilGlossaryTerm::_lookGlossaryTerm((int) $value[1]);
                 break;
 
             case "wpage":
                 $type = $lng->txt("cont_wiki_page");
                 $name = ilWikiPage::lookupTitle((int) $value[1]);
                 break;
 
             default:
                 $type = $lng->txt("obj_" . $value[0]);
                 $name = ilObject::_lookupTitle(ilObject::_lookupObjId((int) $value[1]));
                 break;
         }
         return array("type" => $type, "name" => $name);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTypeToAttrType()

static ilLinkInputGUI::getTypeToAttrType ( )

static

Get internal types to xml attribute types map.

Returns: string[]

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

                                               : array
     {
         return self::$iltypemap;
     }

◆ getValue()

ilLinkInputGUI::getValue ( )

Get Value.

Returns: string

Definition at line 204 of file class.ilLinkInputGUI.php.

References $value.

Referenced by render().

                               : string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ insert()

ilLinkInputGUI::insert ( ilTemplate $a_tpl )

Definition at line 570 of file class.ilLinkInputGUI.php.

References ilTemplate\parseCurrentBlock(), render(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

                                              : void
     {
         $html = $this->render();
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $html);
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ isInternalLink()

static ilLinkInputGUI::isInternalLink ( string $a_value )

static

Definition at line 509 of file class.ilLinkInputGUI.php.

References $parts.

Referenced by ilObjLinkResourceGUI\checkLinkInput(), ilObjLinkResourceListGUI\getCommandFrame(), ilWebLinkXmlParser\handlerEndTag(), ilWebLinkDatabaseRepository\isInternalLink(), and ilObjLinkResourceGUI\updateLinks().

                                                           : bool
     {
         if (strpos($a_value, "|")) {
             $parts = explode("|", $a_value);
             if (sizeof($parts) == 2 || sizeof($parts) == 3) {
                 // numeric id
                 if (is_numeric($parts[1])) {
                     // simple type
                     if (preg_match("/^[a-zA-Z_]+$/", $parts[0])) {
                         return true;
                     }
                 }
             }
         }
         return false;
     }

Here is the caller graph for this function:

◆ render()

ilLinkInputGUI::render ( )

Definition at line 303 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\$ctrl, ilFormPropertyGUI\$lng, ilFormPropertyGUI\$title, ilRadioOption\addSubItem(), getAllowedLinkTypes(), getExternalLinkMaxLength(), ilFormPropertyGUI\getParentForm(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getValue(), null, and ilLanguage\txt().

Referenced by insert().

                             : string
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $ti = null;
         $ne = null;
         $hidden_type = null;
         $hidden_id = null;
         $hidden_target = null;
 
         // parse settings
         $has_int = $has_ext = $has_radio = $has_list = false;
         switch ($this->getAllowedLinkTypes()) {
             case self::EXT:
                 $has_ext = true;
                 break;
 
             case self::INT:
                 $has_int = true;
                 break;
 
             case self::BOTH:
                 $has_int = true;
                 $has_ext = true;
                 $has_radio = true;
                 break;
 
             case self::LIST:
                 $has_int = true;
                 $has_ext = true;
                 $has_radio = true;
                 $has_list = true;
                 break;
         }
         if (!$this->getRequired()) {
             // see #0021274
             $has_radio = true;
         }
 
         // external
         if ($has_ext) {
             $title = $has_radio ? $lng->txt("url") : "";
 
             // external
             $ti = new ilTextInputGUI($title, $this->getPostVar());
             $ti->setMaxLength($this->getExternalLinkMaxLength());
         }
 
         $itpl = new ilTemplate('tpl.prop_link.html', true, true, 'components/ILIAS/Form');
 
         // internal
         if ($has_int) {
             $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->getPostVar());
             $link = array(get_class($this->getParentForm()), "ilformpropertydispatchgui", get_class($this), "ilinternallinkgui");
             $link = $ilCtrl->getLinkTargetByClass($link, "", '', true, false);
             $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->requested_postvar);
 
             $no_disp_class = (strpos($this->getValue(), "|"))
                 ? ""
                 : " ilNoDisplay";
 
             $itpl->setVariable("VAL_ID", $this->getPostVar());
             $itpl->setVariable("URL_EDIT", $link);
             $itpl->setVariable("TXT_EDIT", $lng->txt("form_get_link"));
             $itpl->setVariable("CSS_REMOVE", $no_disp_class);
             $itpl->setVariable("TXT_REMOVE", $lng->txt("remove"));
 
             $ne = new ilNonEditableValueGUI($lng->txt("object"), $this->getPostVar() . "_val", true);
 
             // hidden field for selected value
             $hidden_type = new ilHiddenInputGUI($this->getPostVar() . "_ajax_type");
             $hidden_id = new ilHiddenInputGUI($this->getPostVar() . "_ajax_id");
             $hidden_target = new ilHiddenInputGUI($this->getPostVar() . "_ajax_target");
         }
 
         // mode
         if ($has_radio) {
             // BT 35578: link input might be required (so $has_radio = true), but might only be internal
             if ($has_ext) {
                 $ext = new ilRadioOption($lng->txt("form_link_external"), "ext");
                 $ext->addSubItem($ti);
             }
 
             if ($has_int) {
                 $int = new ilRadioOption($lng->txt("form_link_internal"), "int");
                 $int->addSubItem($ne);
             }
             $mode = new ilRadioGroupInputGUI("", $this->getPostVar() . "_mode");
             $mode->setParentForm($this->getParentForm());
             if (!$this->getRequired()) {
                 $no = new ilRadioOption($lng->txt("form_no_link"), "no");
                 $mode->addOption($no);
             }
             // BT 35578: link input might be required (so $has_radio = true), but might only be internal
             if ($has_ext) {
                 $mode->addOption($ext);
             }
             if ($has_int) {
                 $mode->addOption($int);
             }
         } else {
             $mode = new ilHiddenInputGUI($this->getPostVar() . "_mode");
             if ($has_int) {
                 $mode->setValue("int");
             } else {
                 $mode->setValue("ext");
             }
         }
 
         // list mode
         if ($has_list) {
             $mode_type = new ilRadioGroupInputGUI("", $this->getPostVar() . "_mode_type");
             $mode_single = new ilRadioOption($lng->txt("webr_link_type_single"), "single");
             $mode_type->addOption($mode_single);
             $mode_list = new ilRadioOption($lng->txt("webr_link_type_list"), "list");
             $mode_type->addOption($mode_list);
             $mode = new ilRadioGroupInputGUI($lng->txt("webr_link_target"), $this->getPostVar() . "_mode");
             if (!$this->getRequired()) {
                 $no = new ilRadioOption($lng->txt("form_no_link"), "no");
                 $mode->addOption($no);
             }
             $ext = new ilRadioOption($lng->txt("form_link_external"), "ext");
             $ext->addSubItem($ti);
             $int = new ilRadioOption($lng->txt("form_link_internal"), "int");
             $int->addSubItem($ne);
             $mode->addOption($ext);
             $mode->addOption($int);
             $mode_single->addSubItem($mode);
         }
 
         // value
         $value = $this->getValue();
         if ($value) {
             // #15647
             if ($has_int && self::isInternalLink($value)) {
                 $mode->setValue("int");
 
                 $value_trans = self::getTranslatedValue($value);
 
                 $value = explode("|", $value);
                 $hidden_type->setValue($value[0]);
                 $hidden_id->setValue($value[1]);
                 $hidden_target->setValue($value[2] ?? "");
 
                 $itpl->setVariable("VAL_OBJECT_TYPE", $value_trans["type"]);
                 $itpl->setVariable("VAL_OBJECT_NAME", $value_trans["name"]);
                 if (($value[2] ?? "") != "") {
                     $itpl->setVariable("VAL_TARGET_FRAME", "(" . $value[2] . ")");
                 }
             } elseif ($has_ext) {
                 $mode->setValue("ext");
 
                 $ti->setValue($value);
             }
         } elseif (!$this->getRequired()) {
             $mode->setValue("no");
         }
 
         // #10185 - default for external urls
         if ($has_ext && !$ti->getValue()) {
             $ti->setValue("https://");
         }
 
         if ($has_int) {
             $ne->setValue($itpl->get());
         }
 
         // to html
         if ($has_radio) {
             $html = $mode->render();
         } else {
             $html = $mode->getToolbarHTML();
 
             if ($has_ext) {
                 $html .= $ti->getToolbarHTML();
             } elseif ($has_int) {
                 $html .= $ne->render() .
                     '<div class="help-block">' . $ne->getInfo() . '</div>';
             }
         }
         if ($has_list) {
             $html = $mode_type->render();
         }
 
         // js for internal link
         if ($has_int) {
             $html .= $hidden_type->getToolbarHTML() .
                 $hidden_id->getToolbarHTML() .
                 $hidden_target->getToolbarHTML();
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowedLinkTypes()

ilLinkInputGUI::setAllowedLinkTypes ( string $a_val )

Set allowed link types (LIST, BOTH, INT, EXT)

Parameters

string $a_val self::LIST|self::BOTH|self::INT|self::EXT

Definition at line 77 of file class.ilLinkInputGUI.php.

Referenced by ilObjLinkResourceGUI\addLinkInputToForm(), and ilPageObjectGUI\initOpenedContentForm().

                                                       : void
     {
         $this->allowed_link_types = $a_val;
     }

Here is the caller graph for this function:

◆ setExternalLinkMaxLength()

ilLinkInputGUI::setExternalLinkMaxLength ( int $a_max )

Parameters

int	max length for external links

Definition at line 149 of file class.ilLinkInputGUI.php.

                                                         : void
     {
         $this->external_link_max_length = $a_max;
     }

◆ setFilterWhiteList()

ilLinkInputGUI::setFilterWhiteList ( bool $a_val )

Set filter white list.

Parameters

bool $a_val filter list is white list

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

                                                    : void
     {
         $this->filter_white_list = $a_val;
     }

◆ setInternalLinkDefault()

ilLinkInputGUI::setInternalLinkDefault	(	string	$a_type,
		int	$a_obj = `0`
	)

Set internal link default.

Parameters

string	$a_type	link type
int	$a_obj	object id

Definition at line 93 of file class.ilLinkInputGUI.php.

      : void {
         $this->int_link_default_type = $a_type;
         $this->int_link_default_obj = $a_obj;
     }

◆ setInternalLinkFilterTypes()

ilLinkInputGUI::setInternalLinkFilterTypes ( array $a_val )

Set internal link filter types.

Parameters

array $a_val filter types

Definition at line 106 of file class.ilLinkInputGUI.php.

                                                             : void
     {
         $this->int_link_filter_types = $a_val;
     }

◆ setValue()

ilLinkInputGUI::setValue ( string $a_value )

Set Value.

Parameters

string $a_value

Definition at line 195 of file class.ilLinkInputGUI.php.

Referenced by setValueByArray(), and setValueByIntLinkAttributes().

                                              : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilLinkInputGUI::setValueByArray ( array $a_values )

Definition at line 209 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\getPostVar(), null, and setValue().

                                                     : void
     {
         switch ($a_values[$this->getPostVar() . "_mode"] ?? null) {
             case "int":
                 if ($a_values[$this->getPostVar() . "_ajax_type"] &&
                     $a_values[$this->getPostVar() . "_ajax_id"]) {
                     $val = $a_values[$this->getPostVar() . "_ajax_type"] . "|" .
                         $a_values[$this->getPostVar() . "_ajax_id"];
                     if ($a_values[$this->getPostVar() . "_ajax_target"] != "") {
                         $val .= "|" . $a_values[$this->getPostVar() . "_ajax_target"];
                     }
                     $this->setValue($val);
                 }
                 break;
 
             case "no":
                 break;
 
             default:
                 if ($a_values[$this->getPostVar()]) {
                     $this->setValue($a_values[$this->getPostVar()]);
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ setValueByIntLinkAttributes()

ilLinkInputGUI::setValueByIntLinkAttributes	(	string	$a_type,
		string	$a_target,
		string	$a_target_frame = `""`
	)

Definition at line 621 of file class.ilLinkInputGUI.php.

References ilFormPropertyGUI\$type, ilObject\_lookupType(), and setValue().

      : void {
         $t = explode("_", $a_target);
         $target_id = ($t[3] ?? "");
         $type = "";
         $map = self::getAttrTypeToType();
         if ($a_type == "RepositoryItem") {
             $type = ilObject::_lookupType((int) $target_id, true);
         } elseif (isset($map[$a_type])) {
             $type = $map[$a_type];
         }
         if ($type != "" && $target_id != "") {
             $val = $type . "|" . $target_id;
             if ($a_target_frame != "") {
                 $val .= "|" . $a_target_frame;
             }
             $this->setValue($val);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $allowed_link_types

string ilLinkInputGUI::$allowed_link_types = self::BOTH

protected

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

Referenced by getAllowedLinkTypes().

◆ $external_link_max_length

int ilLinkInputGUI::$external_link_max_length = self::EXTERNAL_LINK_MAX_LENGTH

protected

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

Referenced by getExternalLinkMaxLength().

◆ $filter_white_list

bool ilLinkInputGUI::$filter_white_list = true

protected

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

Referenced by getFilterWhiteList().

◆ $iltypemap

array ilLinkInputGUI::$iltypemap

staticprotected

Initial value:

= array(
        "page" => "PageObject",
        "chap" => "StructureObject",
        "term" => "GlossaryItem",
        "wpage" => "WikiPage"
    )

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

◆ $int_link_default_obj

int ilLinkInputGUI::$int_link_default_obj = 0

protected

Definition at line 40 of file class.ilLinkInputGUI.php.

◆ $int_link_default_type

string ilLinkInputGUI::$int_link_default_type = "RepositoryItem"

protected

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

◆ $int_link_filter_types

array ilLinkInputGUI::$int_link_filter_types = array("RepositoryItem")

protected

Definition at line 41 of file class.ilLinkInputGUI.php.

◆ $obj_definition

ilObjectDefinition ilLinkInputGUI::$obj_definition

protected

Definition at line 51 of file class.ilLinkInputGUI.php.

◆ $requested_postvar

string ilLinkInputGUI::$requested_postvar

protected

Definition at line 52 of file class.ilLinkInputGUI.php.

◆ $value

string ilLinkInputGUI::$value = ""

protected

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

Referenced by getInput(), and getValue().

◆ BOTH

const ilLinkInputGUI::BOTH = "both"

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

Referenced by ilPCSectionGUI\initForm().

◆ EXT

const ilLinkInputGUI::EXT = "ext"

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

Referenced by ilPCSectionGUI\initForm().

◆ EXTERNAL_LINK_MAX_LENGTH

const ilLinkInputGUI::EXTERNAL_LINK_MAX_LENGTH = 200

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

◆ INT

const ilLinkInputGUI::INT = "int"

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

Referenced by ilPageObjectGUI\initOpenedContentForm().

◆ LIST

const ilLinkInputGUI::LIST = "list"

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

Referenced by ilObjLinkResourceGUI\addLinkInputToForm().

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

components/ILIAS/Form/classes/class.ilLinkInputGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ executeCommand()

◆ getAllowedLinkTypes()

◆ getAttrTypeToType()

◆ getContentOutsideFormTag()

◆ getExternalLinkMaxLength()

◆ getFilterWhiteList()

◆ getInput()

◆ getIntLinkAttributes()

◆ getOnloadCode()

◆ getTranslatedValue()

◆ getTypeToAttrType()

◆ getValue()

◆ insert()

◆ isInternalLink()

◆ render()

◆ setAllowedLinkTypes()

◆ setExternalLinkMaxLength()

◆ setFilterWhiteList()

◆ setInternalLinkDefault()

◆ setInternalLinkFilterTypes()

◆ setValue()

◆ setValueByArray()

◆ setValueByIntLinkAttributes()

Field Documentation

◆ $allowed_link_types

◆ $external_link_max_length

◆ $filter_white_list

◆ $iltypemap

◆ $int_link_default_obj

◆ $int_link_default_type

◆ $int_link_filter_types

◆ $obj_definition

◆ $requested_postvar

◆ $value

◆ BOTH

◆ EXT

◆ EXTERNAL_LINK_MAX_LENGTH

◆ INT

◆ LIST