@noinspection AutoloadingIssuesInspection More...

Inheritance diagram for ilDclFileRecordRepresentation:

Collaboration diagram for ilDclFileRecordRepresentation:

Public Member Functions
	__construct (ilDclBaseRecordFieldModel $record_field)

	getSingleHTML (?array $options=null, bool $link=true)
	Returns data for single record view. More...

	getHTML (bool $link=true, array $options=[])
	Outputs html of a certain field. More...

	parseFormInput ($value)
	function parses stored value to the variable needed to fill into the form for editing. More...

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...

Private Member Functions
	buildDownloadLink ()

Private Attributes
ILIAS ResourceStorage Services	$irss

ILIAS DI UIServices	$ui_services

Additional Inherited Members
Protected Member Functions inherited from ilDclBaseRecordRepresentation
	getFormInput ()
	Gets the value from from the record field. More...

Protected Attributes inherited from ilDclBaseRecordRepresentation
ILIAS UI Factory	$factory

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

@noinspection AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

◆ __construct()

ilDclFileRecordRepresentation::__construct ( ilDclBaseRecordFieldModel $record_field )

Reimplemented from ilDclBaseRecordRepresentation.

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

    {
        global $DIC;
        parent::__construct($record_field);
        $this->irss = $DIC->resourceStorage();
        $this->ui_services = $DIC->ui();
    }

References $DIC, ilDclBaseRecordRepresentation\$record_field, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ buildDownloadLink()

ilDclFileRecordRepresentation::buildDownloadLink ( )

private

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

                                        : string
    {
        $record_field = $this->getRecordField();
 
        $this->ctrl->setParameterByClass(
            ilDclRecordListGUI::class,
            "record_id",
            $record_field->getRecord()->getId()
        );
        $this->ctrl->setParameterByClass(
            ilDclRecordListGUI::class,
            "field_id",
            $record_field->getField()->getId()
        );
        return $this->ctrl->getLinkTargetByClass(
            ilDclRecordListGUI::class,
            "sendFile"
        );
    }

References ilDclBaseRecordRepresentation\$record_field, ILIAS\Repository\ctrl(), ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getRecord(), and ilDclBaseRecordRepresentation\getRecordField().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

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

Outputs html of a certain field.

Reimplemented from ilDclBaseRecordRepresentation.

Reimplemented in ilDclMobRecordRepresentation.

Definition at line 44 of file class.ilDclFileRecordRepresentation.php.

                                                                   : string
    {
        $value = $this->record_field->getValue();
 
        if ($value === null) {
            return '';
        }
 
        if (is_array($value)) {
            return $value['name'] ?? 'undefined';
        }
 
        $title = $this->valueToFileTitle($value);
 
        if ($title === '') {
            return $this->lng->txt('file_not_found');
        }
 
        if ($link) {
            $link_component = $this->ui_services->factory()->link()->standard(
                $title,
                $this->buildDownloadLink()
            );
 
            return $this->ui_services->renderer()->render($link_component);
        }
 
        return $title;
    }

References buildDownloadLink(), and ILIAS\Repository\lng().

Referenced by getSingleHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSingleHTML()

ilDclFileRecordRepresentation::getSingleHTML	(	?array	$options = `null`,
		bool	$link = `true`
	)

Returns data for single record view.

Reimplemented from ilDclBaseRecordRepresentation.

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

                                                                            : string
    {
        return $this->getHTML(true, $options ?? []);
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, and getHTML().

Here is the call graph for this function:

◆ parseFormInput()

ilDclFileRecordRepresentation::parseFormInput ( $value )

function parses stored value to the variable needed to fill into the form for editing.

Parameters

string | int $value

Returns: string|int

Reimplemented from ilDclBaseRecordRepresentation.

Reimplemented in ilDclMobRecordRepresentation.

Definition at line 74 of file class.ilDclFileRecordRepresentation.php.

    {
        if ($value === null || is_array($value)) {
            return '';
        }
        return $this->valueToFileTitle($value);
    }

Field Documentation

◆ $irss

ILIAS ResourceStorage Services ilDclFileRecordRepresentation::$irss

private

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

◆ $ui_services

ILIAS DI UIServices ilDclFileRecordRepresentation::$ui_services

private

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

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

components/ILIAS/DataCollection/classes/Fields/File/class.ilDclFileRecordRepresentation.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildDownloadLink()

◆ getHTML()

◆ getSingleHTML()

◆ parseFormInput()

Field Documentation

◆ $irss

◆ $ui_services