ilDclFileuploadFieldRepresentation 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 ilDclFileuploadFieldRepresentation:

Collaboration diagram for ilDclFileuploadFieldRepresentation:

Public Member Functions
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	addFilterInputFieldToTable (ilTable2GUI $table)
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
Public Member Functions inherited from ilDclBaseFieldRepresentation
	__construct (ilDclBaseFieldModel $field)
	addFilterInputFieldToTable (ilTable2GUI $table)
	Add filter input to TableGUI. More...
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
	Checks if a filter affects a record. More...
	parseSortingValue (string $value, bool $link=true)
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	Returns field-input. More...
	addFieldCreationForm (ilSubEnabledFormPropertyGUI $form, ilObjDataCollection $dcl, string $mode="create")
	Adds the options for the field-types to the field-creation form. More...
	getPropertyInputFieldId (string $property)
	Return post-var for property-fields. More...
	getField ()
	Return BaseFieldModel. More...

Protected Member Functions
	requiredWorkaroundForInputField (ilFileInputGUI $input, ?int $record_id)
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
Protected Member Functions inherited from ilDclBaseFieldRepresentation
	setupFilterInputField (?ilTableFilterItem $input)
	Set basic settings for filter-input-gui. More...
	setupInputField (ilFormPropertyGUI $input, ilDclBaseFieldModel $field)
	Sets basic settings on field-input. More...
	getFilterInputFieldValue (ilTableFilterItem $input)
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
	Build the creation-input-field. More...

Additional Inherited Members
Protected Attributes inherited from ilDclBaseFieldRepresentation
ilDclBaseFieldModel	$field
ilLanguage	$lng
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilComponentRepository	$component_repository
ilComponentFactory	$component_factory

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclFileuploadFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

Returns

array|string|null

Exceptions

Exception

Definition at line 58 of file class.ilDclFileuploadFieldRepresentation.php.

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_TEXT, ilDclBaseFieldRepresentation\getField(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), ILIAS\Survey\Mode\getId(), and ilDclBaseFieldRepresentation\setupFilterInputField().

    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_TEXT,
            false,
            $this->getField()->getId()
        );
        $input->setSubmitFormOnEnter(true);

        $this->setupFilterInputField($input);

        return $this->getFilterInputFieldValue($input);
    }

Here is the call graph for this function:

buildFieldCreationInput()

ilDclFileuploadFieldRepresentation::buildFieldCreationInput ( ilObjDataCollection  $dcl, string  $mode = 'create'  )

protected

Definition at line 96 of file class.ilDclFileuploadFieldRepresentation.php.

References ILIAS\Repository\lng(), and ilDclBaseFieldModel\PROP_SUPPORTED_FILE_TYPES.

                                                                                                 : ilRadioOption
    {
        $opt = parent::buildFieldCreationInput($dcl, $mode);

        $prop_filetype = new ilTextInputGUI(
            $this->lng->txt('dcl_supported_filetypes'),
            'prop_' . ilDclBaseFieldModel::PROP_SUPPORTED_FILE_TYPES
        );
        $prop_filetype->setInfo($this->lng->txt('dcl_supported_filetypes_desc'));

        $opt->addSubItem($prop_filetype);

        return $opt;
    }

Here is the call graph for this function:

getInputField()

ilDclFileuploadFieldRepresentation::getInputField	(	ilPropertyFormGUI	$form,
		?int	$record_id = null
	)

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

References ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), and requiredWorkaroundForInputField().

                                                                                  : ilFileInputGUI
    {
        $input = new ilFileInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        $input->setSuffixes($this->getField()->getSupportedExtensions());
        $input->setAllowDeletion(true);

        $this->requiredWorkaroundForInputField($input, $record_id);

        return $input;
    }

Here is the call graph for this function:

passThroughFilter()

ilDclFileuploadFieldRepresentation::passThroughFilter	(	ilDclBaseRecordModel	$record,
			$filter
	)

Parameters

string

$filter

Definition at line 76 of file class.ilDclFileuploadFieldRepresentation.php.

References ilObject\_exists(), ilObject\_lookupType(), ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), and ilDclBaseRecordModel\getRecordFieldValue().

                                                                            : bool
    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
        $pass = false;
        if (!ilObject2::_exists($value) || ilObject2::_lookupType($value) != "file") {
            $pass = true;
        }

        $file_obj = new ilObjFile($value, false);
        $file_name = $file_obj->getTitle();
        if (!$filter || strpos(strtolower($file_name), strtolower($filter)) !== false) {
            $pass = true;
        }

        return $pass;
    }

Here is the call graph for this function:

requiredWorkaroundForInputField()

ilDclFileuploadFieldRepresentation::requiredWorkaroundForInputField ( ilFileInputGUI  $input, ?int  $record_id  )

protected

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

References ILIAS\Repository\ctrl(), ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), ilDclCache\getRecordCache(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setRequired(), and ilDclBaseFieldRepresentation\setupInputField().

Referenced by getInputField(), and ilDclMobFieldRepresentation\getInputField().

                                                                                              : void
    {
        if ($record_id) {
            $record = ilDclCache::getRecordCache($record_id);
        }

        $this->setupInputField($input, $this->getField());

        //WORKAROUND
        // If field is from type file: if it's required but already has a value it is no longer required as the old value is taken as default without the form knowing about it.
        if ($record_id && $record->getId()) {
            $field_value = $record->getRecordFieldValue($this->getField()->getId());
            if ($field_value) {
                $input->setRequired(false);
            }
        }
        // If this is an ajax request to return the form, input files are currently not supported
        if ($this->ctrl->isAsynch()) {
            $input->setDisabled(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/DataCollection/classes/Fields/Fileupload/class.ilDclFileuploadFieldRepresentation.php