ilDclFileuploadFieldRepresentation Class Reference

Class ilDclFileuploadFieldRepresentaion. More...

Inheritance diagram for ilDclFileuploadFieldRepresentation:

Collaboration diagram for ilDclFileuploadFieldRepresentation:

Public Member Functions
	getInputField (ilPropertyFormGUI $form, $record_id=0)
	Returns field-input. Parameters ilPropertyFormGUI $form int $record_id Returns ?ilFormPropertyGUI More...
	addFilterInputFieldToTable (ilTable2GUI $table)
	Add filter input to TableGUI. Parameters ilTable2GUI $table Returns null More...
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
	Checks if a filter affects a record. Parameters ilDclBaseRecordModel $record $filter Returns bool More...
	buildFieldCreationInput (ilObjDataCollection $dcl, $mode='create')
	@inheritDoc More...
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 ($value, $link=true)
	getInputField (ilPropertyFormGUI $form, $record_id=0)
	Returns field-input. More...
	addFieldCreationForm ($form, ilObjDataCollection $dcl, $mode="create")
	Adds the options for the field-types to the field-creation form. More...
	getPropertyInputFieldId ($property)
	Return post-var for property-fields. More...
	getField ()
	Return BaseFieldModel. More...

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

Additional Inherited Members
Protected Attributes inherited from ilDclBaseFieldRepresentation
	$field
	$lng
	$ctrl

Detailed Description

Class ilDclFileuploadFieldRepresentaion.

Author

Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclFileuploadFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

Add filter input to TableGUI.

Parameters

ilTable2GUI

$table

Returns

null

Reimplemented from ilDclBaseFieldRepresentation.

Reimplemented in ilDclMobFieldRepresentation.

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

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

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_TEXT, ilDclBaseFieldRepresentation\getField(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), and ilDclBaseFieldRepresentation\setupFilterInputField().

Here is the call graph for this function:

buildFieldCreationInput()

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

@inheritDoc

Reimplemented from ilDclBaseFieldRepresentation.

Reimplemented in ilDclMobFieldRepresentation.

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

    {
        $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;
    }

References ilDclBaseFieldModel\PROP_SUPPORTED_FILE_TYPES.

getInputField()

ilDclFileuploadFieldRepresentation::getInputField	(	ilPropertyFormGUI	$form,
			$record_id = 0
	)

Returns field-input.

Parameters

ilPropertyFormGUI	$form
int	$record_id

Returns

?ilFormPropertyGUI

Reimplemented from ilDclBaseFieldRepresentation.

Reimplemented in ilDclMobFieldRepresentation.

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

    {
        $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;
    }

References ilDclBaseFieldRepresentation\getField(), and requiredWorkaroundForInputField().

Here is the call graph for this function:

passThroughFilter()

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

Checks if a filter affects a record.

Parameters

ilDclBaseRecordModel	$record
	$filter

Returns

bool

Reimplemented from ilDclBaseFieldRepresentation.

Reimplemented in ilDclMobFieldRepresentation.

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

    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
        $pass = false;
        if (!ilObject2::_exists($value) || ilObject2::_lookupType($value, false) != "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;
    }

References $pass, ilObject2\_exists(), ilObject2\_lookupType(), ilDclBaseFieldRepresentation\getField(), and ilDclBaseRecordModel\getRecordFieldValue().

Here is the call graph for this function:

requiredWorkaroundForInputField()

ilDclFileuploadFieldRepresentation::requiredWorkaroundForInputField (   $input,   $record_id  )

protected

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

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

References ilDclBaseFieldRepresentation\getField(), ilDclCache\getRecordCache(), and ilDclBaseFieldRepresentation\setupInputField().

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

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