ilDclTextRecordRepresentation Class Reference

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

Inheritance diagram for ilDclTextRecordRepresentation:

Collaboration diagram for ilDclTextRecordRepresentation:

Public Member Functions
	getHTML (bool $link=true, array $options=[])
	fillFormInput (ilPropertyFormGUI $form)
Public Member Functions inherited from ilDclBaseRecordRepresentation
	__construct (ilDclBaseRecordFieldModel $record_field)
	getFormGUI (ilPropertyFormGUI $formGUI)
	parseFormInput ($value)
	function parses stored value to the variable needed to fill into the form for editing. More...
	fillFormInput (ilPropertyFormGUI $form)
	Fills the form with the value of a record. More...
	getHTML (bool $link=true, array $options=[])
	Outputs html of a certain field. More...
	getSingleHTML (?array $options=null, bool $link=true)
	Returns data for single record view. More...
	getConfirmationHTML ()
	Returns data for confirmation list When returning false, attribute is ignored in list. More...
	fillRow (ilTemplate $tpl)
	Fills row with record data. More...
	getRecordField ()
	Get Record Field. More...
	getField ()
	Getter shortcut for field. More...
	getRecord ()
	Getter shortcut for record. More...

Data Fields
const	LINK_MAX_LENGTH = 40

Protected Member Functions
	shortenLink (string $value)
Protected Member Functions inherited from ilDclBaseRecordRepresentation
	getFormInput ()
	Gets the value from from the record field. More...

Additional Inherited Members
Protected Attributes inherited from ilDclBaseRecordRepresentation
ilDclBaseRecordFieldModel	$record_field
ilLanguage	$lng
ilAccess	$access
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ILIAS UI Renderer	$renderer
ilObjUser	$user

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

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

Member Function Documentation

fillFormInput()

ilDclTextRecordRepresentation::fillFormInput

(

ilPropertyFormGUI

$form

)

Definition at line 99 of file class.ilDclTextRecordRepresentation.php.

References ilDclBaseRecordRepresentation\getField(), ilDclBaseRecordRepresentation\getFormInput(), ILIAS\Survey\Mode\getId(), ilPropertyFormGUI\getItemByPostVar(), ilDclBaseRecordRepresentation\getRecordField(), ilDclBaseFieldModel\PROP_TEXTAREA, and ilDclBaseFieldModel\PROP_URL.

                                                          : void
    {
        $input_field = $form->getItemByPostVar('field_' . $this->getField()->getId());
        $raw_input = $this->getFormInput();

        $value = is_array($raw_input) ? $raw_input['link'] : $raw_input;
        $field_values = [];
        if ($this->getField()->getProperty(ilDclBaseFieldModel::PROP_URL)) {
            $field_values["field_" . $this->getRecordField()->getField()->getId() . "_title"] = (isset($raw_input['title'])) ? $raw_input['title'] : '';
        }

        if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_TEXTAREA)) {
            $breaks = ["<br />"];
            $value = str_ireplace($breaks, "", $value);
        }

        $field_values["field_" . $this->getRecordField()->getField()->getId()] = $value;
        $input_field->setValueByArray($field_values);
    }

Here is the call graph for this function:

getHTML()

ilDclTextRecordRepresentation::getHTML	(	bool	$link = true,
		array	$options = []
	)

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

References $ref_id, ILIAS\Repository\ctrl(), ilDclBaseRecordRepresentation\getField(), ILIAS\Survey\Mode\getId(), ilDclBaseRecordRepresentation\getRecord(), ilDclBaseRecordRepresentation\getRecordField(), ILIAS\FileDelivery\http(), ilDclBaseFieldModel\PROP_LINK_DETAIL_PAGE_TEXT, ilDclBaseFieldModel\PROP_URL, ILIAS\Repository\refinery(), shortenLink(), and ILIAS\Repository\user().

                                                                   : string
    {
        $value = $this->getRecordField()->getValue();

        $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
        $views = $this->getRecord()->getTable()->getVisibleTableViews($ref_id, true, $this->user->getId());

        //Property URL
        $field = $this->getField();
        if ($field->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
            if (is_array($value)) {
                $link = (string) $value['link'];
                $link_value = $value['title'] ?: $this->shortenLink($link);
            } else {
                $link = (string) $value;
                $link_value = $this->shortenLink($link);
            }

            if (substr($link, 0, 3) === 'www') {
                $link = 'https://' . $link;
            }

            if (preg_match(
                "/^[a-z0-9!#$%&'*+=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i",
                $link
            )) {
                $link = "mailto:" . $link;
            } elseif (!(preg_match('~(^(news|(ht|f)tp(s?)\://){1}\S+)~i', $link))) {
                return $link;
            }

            $html = "<a rel='noopener' target='_blank' href='" . htmlspecialchars(
                $link,
                ENT_QUOTES
            ) . "'>" . htmlspecialchars($link_value, ENT_QUOTES) . "</a>";
        } elseif ($field->hasProperty(ilDclBaseFieldModel::PROP_LINK_DETAIL_PAGE_TEXT) && $link && $views !== []) {
            $view = array_shift($views);
            if ($this->http->wrapper()->query()->has('tableview_id')) {
                $tableview_id = $this->http->wrapper()->query()->retrieve('tableview_id', $this->refinery->kindlyTo()->int());
                foreach ($views as $v) {
                    if ($v->getId() === $tableview_id) {
                        $view = $tableview_id;
                        break;
                    }
                }
            }

            $this->ctrl->clearParametersByClass("ilDclDetailedViewGUI");
            $this->ctrl->setParameterByClass(
                'ilDclDetailedViewGUI',
                'record_id',
                $this->getRecordField()->getRecord()->getId()
            );

            $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, 'table_id', $this->getRecord()->getTableId());
            $this->ctrl->setParameterByClass(ilDclDetailedViewGUI::class, 'tableview_id', $view->getId());
            $html = '<a href="' . $this->ctrl->getLinkTargetByClass(
                "ilDclDetailedViewGUI",
                'renderRecord'
            ) . '">' . $value . '</a>';
        } else {
            $html = (is_array($value) && isset($value['link'])) ? $value['link'] : nl2br((string) $value);
        }

        return $html;
    }

Here is the call graph for this function:

shortenLink()

ilDclTextRecordRepresentation::shortenLink ( string  $value )

protected

Definition at line 90 of file class.ilDclTextRecordRepresentation.php.

References ILIAS\Repository\int().

Referenced by getHTML().

                                                 : string
    {
        $value = preg_replace('/^(https?:\/\/)?(www\.)?/', '', $value);
        $half = (int) ((self::LINK_MAX_LENGTH - 4) / 2);
        $value = preg_replace('/^(.{' . ($half + 1) . '})(.{4,})(.{' . $half . '})$/', '\1...\3', $value);

        return $value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

LINK_MAX_LENGTH

const ilDclTextRecordRepresentation::LINK_MAX_LENGTH = 40

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

---

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

• Modules/DataCollection/classes/Fields/Text/class.ilDclTextRecordRepresentation.php