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 ($a_title="", $a_postvar="")
	Constructor. More...

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

	getAllowedLinkTypes ()
	Get allowed link types (LIST, BOTH, INT, EXT) More...

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

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

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

	getFilterWhiteList ()
	Get filter white list. More...

	setExternalLinkMaxLength ($a_max)

	getExternalLinkMaxLength ()

	executeCommand ()
	Execute current command. More...

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

	getValue ()
	Get Value. More...

	setValueByArray ($a_values)
	Set value by array. More...

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

	render ()
	Render item. More...

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

	insert ($a_tpl)
	Insert property html. More...

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

	setValueByIntLinkAttributes ($a_type, $a_target, $a_target_frame="")
	Set value by internal links attributes. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

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

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

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

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

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

	stripSlashesAddSpaceFallback ($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...

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 ($a_value)

static	getTranslatedValue ($a_value)

Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters ($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
	$allowed_link_types = self::BOTH

	$int_link_default_type = "RepositoryItem"

	$int_link_default_obj = 0

	$int_link_filter_types = array("RepositoryItem")

	$filter_white_list = true

	$external_link_max_length = self::EXTERNAL_LINK_MAX_LENGTH

	$obj_definition

Protected Attributes inherited from ilFormPropertyGUI
	$ctrl

	$lng

	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Static Protected Attributes
static	$iltypemap

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

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

Version: $Id$

@ilCtrl_IsCalledBy ilLinkInputGUI: ilFormPropertyDispatchGUI @ilCtrl_Calls ilLinkInputGUI: ilInternalLinkGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilFormPropertyGUI\setType().

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: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

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

    {
        $lng = $this->lng;
        
        // debugging
        // return false;
        
        if ($this->getRequired()) {
            if ($_POST[$this->getPostVar() . "_mode_type"] == "list") {
                return true;
            }
 
            switch ($_POST[$this->getPostVar() . "_mode"]) {
                case "ext":
                    if (!$_POST[$this->getPostVar()]) {
                        $this->setAlert($lng->txt("msg_input_is_required"));
                        return false;
                    }
                    break;
                    
                case "int":
                    if (!$_POST[$this->getPostVar() . "_ajax_type"] ||
                        !$_POST[$this->getPostVar() . "_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;
            }
        }
        
        if ($_POST[$this->getPostVar() . "_mode"] == "int") {
            $_POST[$this->getPostVar() . "_ajax_type"] = ilUtil::stripSlashes($_POST[$this->getPostVar() . "_ajax_type"]);
            $_POST[$this->getPostVar() . "_ajax_id"] = ilUtil::stripSlashes($_POST[$this->getPostVar() . "_ajax_id"]);
            $_POST[$this->getPostVar() . "_ajax_target"] = ilUtil::stripSlashes($_POST[$this->getPostVar() . "_ajax_target"]);
            
            // overwriting post-data so getInput() will work
            $val = $_POST[$this->getPostVar() . "_ajax_type"] . "|" .
                $_POST[$this->getPostVar() . "_ajax_id"];
            if ($_POST[$this->getPostVar() . "_ajax_target"] != "") {
                $val .= "|" . $_POST[$this->getPostVar() . "_ajax_target"];
            }
 
            $_POST[$this->getPostVar()] = $val;
        } elseif ($_POST[$this->getPostVar() . "_mode"] == "no") {
            $_POST[$this->getPostVar()] = "";
        } else {
            $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
        }
        
        return true;
    }

References $_POST, ilFormPropertyGUI\$lng, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ executeCommand()

ilLinkInputGUI::executeCommand ( )

Execute current command.

Reimplemented from ilFormPropertyGUI.

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();
 
        switch ($next_class) {
            case "ilinternallinkgui":
                $lng->loadLanguageModule("content");
                require_once("./Services/Link/classes/class.ilInternalLinkGUI.php");
                $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());
                $link_gui->setMode("asynch");
 
                $ret = $ilCtrl->forwardCommand($link_gui);
                break;
 
            default:
                var_dump($cmd);
                //exit();
        }
        
        return $ret;
    }

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

Here is the call graph for this function:

◆ getAllowedLinkTypes()

ilLinkInputGUI::getAllowedLinkTypes ( )

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

Returns: string self::LIST|self::BOTH|self::INT|self::EXT

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

    {
        return $this->allowed_link_types;
    }

References $allowed_link_types.

Referenced by getContentOutsideFormTag(), and render().

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 119 of file class.ilLinkInputGUI.php.

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

Referenced by setValueByIntLinkAttributes().

Here is the caller graph for this function:

◆ getContentOutsideFormTag()

ilLinkInputGUI::getContentOutsideFormTag ( )

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

panels/layers

Returns: string

Reimplemented from ilFormPropertyGUI.

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

    {
        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("");
        }
    }

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

Here is the call graph for this function:

◆ getExternalLinkMaxLength()

ilLinkInputGUI::getExternalLinkMaxLength ( )

Returns: int

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

    {
        return $this->external_link_max_length;
    }

References $external_link_max_length.

Referenced by render().

Here is the caller graph for this function:

◆ getFilterWhiteList()

ilLinkInputGUI::getFilterWhiteList ( )

Get filter white list.

Returns: bool filter list is white list

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

    {
        return $this->filter_white_list;
    }

References $filter_white_list.

Referenced by executeCommand().

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 581 of file class.ilLinkInputGUI.php.

    {
        $val = explode("|", $_POST[$this->getPostVar()]);
 
        $ret = false;
        $type = "";
        $target = "";
        if (self::isInternalLink($_POST[$this->getPostVar()])) {
            $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;
    }

References $_POST, $ret, $target_type, ilFormPropertyGUI\$type, ilFormPropertyGUI\getPostVar(), and getTypeToAttrType().

Here is the call graph for this function:

◆ getTranslatedValue()

static ilLinkInputGUI::getTranslatedValue ( $a_value )

static

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

    {
        global $DIC;
 
        $lng = $DIC->language();
        
        $value = explode("|", $a_value);
        
        switch ($value[0]) {
            case "media":
                $type = $lng->txt("obj_mob");
                $name = ilObject::_lookupTitle($value[1]);
                break;
 
            case "page":
                include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                $type = $lng->txt("obj_pg");
                $name = ilLMPageObject::_lookupTitle($value[1]);
                break;
 
            case "chap":
                include_once("./Modules/LearningModule/classes/class.ilStructureObject.php");
                $type = $lng->txt("obj_st");
                $name = ilStructureObject::_lookupTitle($value[1]);
                break;
 
            case "term":
                $type = $lng->txt("term");
                $name = ilGlossaryTerm::_lookGlossaryTerm($value[1]);
                break;
 
            default:
                $type = $lng->txt("obj_" . $value[0]);
                $name = ilObject::_lookupTitle(ilObject::_lookupObjId($value[1]));
                break;
        }
        
        return array("type" => $type, "name" => $name);
    }

References $DIC, ilFormPropertyGUI\$lng, $name, ilFormPropertyGUI\$type, ilGlossaryTerm\_lookGlossaryTerm(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilLMObject\_lookupTitle().

Referenced by ilWebResourceEditableLinkTableGUI\fillRow(), and render().

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 109 of file class.ilLinkInputGUI.php.

    {
        return self::$iltypemap;
    }

References $iltypemap.

Referenced by getIntLinkAttributes().

Here is the caller graph for this function:

◆ getValue()

ilLinkInputGUI::getValue ( )

Get Value.

Returns: string Value

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

    {
        return $this->value;
    }

Referenced by render().

Here is the caller graph for this function:

◆ insert()

ilLinkInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

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

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

References render().

Here is the call graph for this function:

◆ isInternalLink()

static ilLinkInputGUI::isInternalLink ( $a_value )

static

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

    {
        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], $matches)) {
                        return true;
                    }
                }
            }
        }
        return false;
    }

Referenced by ilObjLinkResourceGUI\checkLinkInput(), ilObjLinkResourceListGUI\getCommandFrame(), ilObjLinkResourceGUI\handleSubItemLinks(), ilWebResourceLinkTableGUI\parse(), and ilObjLinkResourceGUI\updateLinks().

Here is the caller graph for this function:

◆ render()

ilLinkInputGUI::render ( )

Render item.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        // 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());
        }
        
        // internal
        if ($has_int) {
            $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $this->getPostVar());
            $link = array(get_class($this->getParent()), "ilformpropertydispatchgui", get_class($this), "ilinternallinkgui");
            $link = $ilCtrl->getLinkTargetByClass($link, "", false, true, false);
            $ilCtrl->setParameterByClass("ilformpropertydispatchgui", "postvar", $_REQUEST["postvar"]);
                                
            $no_disp_class = (strpos($this->getValue(), "|"))
                ? ""
                : " ilNoDisplay";
            
            $itpl = new ilTemplate('tpl.prop_link.html', true, true, 'Services/Form');
            $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) {
            $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");
            if (!$this->getRequired()) {
                $no = new ilRadioOption($lng->txt("form_no_link"), "no");
                $mode->addOption($no);
            }
            $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) {
            include_once("./Services/Link/classes/class.ilInternalLinkGUI.php");
            $html .= $hidden_type->getToolbarHTML() .
                $hidden_id->getToolbarHTML() .
                $hidden_target->getToolbarHTML();
        }
        
        return $html;
    }

References ilFormPropertyGUI\$ctrl, ilFormPropertyGUI\$lng, ilFormPropertyGUI\$title, BOTH, EXT, getAllowedLinkTypes(), getExternalLinkMaxLength(), ilFormPropertyGUI\getParent(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), getTranslatedValue(), getValue(), INT, and LIST.

Referenced by insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowedLinkTypes()

ilLinkInputGUI::setAllowedLinkTypes ( $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 67 of file class.ilLinkInputGUI.php.

    {
        $this->allowed_link_types = $a_val;
    }

◆ setExternalLinkMaxLength()

ilLinkInputGUI::setExternalLinkMaxLength ( $a_max )

Parameters

int	max length for external links

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

    {
        $this->external_link_max_length = $a_max;
    }

◆ setFilterWhiteList()

ilLinkInputGUI::setFilterWhiteList ( $a_val )

Set filter white list.

Parameters

bool $a_val filter list is white list

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

    {
        $this->filter_white_list = $a_val;
    }

◆ setInternalLinkDefault()

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

Set internal link default.

Parameters

string	$a_type	link type
int	$a_obj	object id

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

    {
        $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 99 of file class.ilLinkInputGUI.php.

    {
        $this->int_link_filter_types = $a_val;
    }

◆ setValue()

ilLinkInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

    {
        $this->value = $a_value;
    }

Referenced by setValueByArray(), and setValueByIntLinkAttributes().

Here is the caller graph for this function:

◆ setValueByArray()

ilLinkInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

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

    {
        switch ($a_values[$this->getPostVar() . "_mode"]) {
            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;
        }
    }

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

Here is the call graph for this function:

◆ setValueByIntLinkAttributes()

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

Set value by internal links attributes.

Parameters

return

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

    {
        $t = explode("_", $a_target);
        $target_id = $t[3];
        $type = "";
        $map = self::getAttrTypeToType();
        if ($a_type == "RepositoryItem") {
            $type = ilObject::_lookupType($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);
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $allowed_link_types

ilLinkInputGUI::$allowed_link_types = self::BOTH

protected

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

Referenced by getAllowedLinkTypes().

◆ $external_link_max_length

ilLinkInputGUI::$external_link_max_length = self::EXTERNAL_LINK_MAX_LENGTH

protected

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

Referenced by getExternalLinkMaxLength().

◆ $filter_white_list

ilLinkInputGUI::$filter_white_list = true

protected

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

Referenced by getFilterWhiteList().

◆ $iltypemap

ilLinkInputGUI::$iltypemap

staticprotected

Initial value:

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

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

Referenced by getTypeToAttrType().

◆ $int_link_default_obj

ilLinkInputGUI::$int_link_default_obj = 0

protected

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

◆ $int_link_default_type

ilLinkInputGUI::$int_link_default_type = "RepositoryItem"

protected

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

◆ $int_link_filter_types

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

protected

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

◆ $obj_definition

ilLinkInputGUI::$obj_definition

protected

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

◆ BOTH

const ilLinkInputGUI::BOTH = "both"

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

Referenced by ilPCSectionGUI\initForm(), and render().

◆ EXT

const ilLinkInputGUI::EXT = "ext"

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

Referenced by ilPCSectionGUI\initForm(), and render().

◆ EXTERNAL_LINK_MAX_LENGTH

const ilLinkInputGUI::EXTERNAL_LINK_MAX_LENGTH = 200

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

◆ INT

const ilLinkInputGUI::INT = "int"

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

Referenced by ilPageObjectGUI\initOpenedContentForm(), and render().

◆ LIST

const ilLinkInputGUI::LIST = "list"

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

Referenced by ilObjLinkResourceGUI\initFormLink(), and render().

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

Services/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()

◆ getIntLinkAttributes()

◆ 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

◆ BOTH

◆ EXT

◆ EXTERNAL_LINK_MAX_LENGTH

◆ INT

◆ LIST