ilDclMobRecordFieldModel Class Reference

Inheritance diagram for ilDclMobRecordFieldModel:

Collaboration diagram for ilDclMobRecordFieldModel:

Public Member Functions
	parseValue ($value)
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	afterClone ()
Public Member Functions inherited from ilDclFileRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	parseValue ($value)
	setValueFromForm (ilPropertyFormGUI $form)
	delete ()
	parseExportValue ($value)
	parseSortingValue ($value, bool $link=true)
	afterClone ()
Public Member Functions inherited from ilDclBaseRecordFieldModel
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	doCreate ()
	Creates an Id and a database entry. More...
	doUpdate ()
	Update object in database. More...
	delete ()
	Delete record field in database. More...
	getValue ()
	getValueForRepresentation ()
	serializeData ($value)
	Serialize data before storing to db. More...
	deserializeData ($value)
	Deserialize data before applying to field. More...
	setValue ($value, bool $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm (ilPropertyFormGUI $form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel (ilExcel $excel, int $row, int $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, int &$row, int &$col)
	getPlainText ()
	getSortingValue (bool $link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation (ilDclBaseRecordRepresentation $record_representation)
	getFieldRepresentation ()
	setFieldRepresentation (ilDclBaseFieldRepresentation $field_representation)

Protected Member Functions
	removeData ()
Protected Member Functions inherited from ilDclFileRecordFieldModel
	removeData ()
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...

Additional Inherited Members
Protected Attributes inherited from ilDclFileRecordFieldModel
ILIAS ResourceStorage Services	$irss
ilDataCollectionStakeholder	$stakeholder
ILIAS FileUpload FileUpload	$upload
Protected Attributes inherited from ilDclBaseRecordFieldModel
int	$id = null
ilDclBaseFieldModel	$field
ilDclBaseRecordModel	$record
ilDclBaseRecordRepresentation	$record_representation = null
ilDclBaseFieldRepresentation	$field_representation = null
	$value
ilObjUser	$user
ilCtrl	$ctrl
ilDBInterface	$db
ilLanguage	$lng
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery

Detailed Description

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

Member Function Documentation

afterClone()

ilDclMobRecordFieldModel::afterClone

(

)

Definition at line 149 of file class.ilDclMobRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$field, ilDclBaseRecordFieldModel\$record, ilDclBaseRecordFieldModel\doUpdate(), ilObjMediaObject\duplicate(), ilDclCache\getCloneOf(), ilDclBaseRecordFieldModel\getField(), ilObject\getId(), ilDclBaseRecordFieldModel\getId(), ilDclBaseRecordFieldModel\getRecord(), ilDclCache\getRecordFieldCache(), ilDclBaseRecordFieldModel\setValue(), ilDclCache\TYPE_FIELD, and ilDclCache\TYPE_RECORD.

                                : void
    {
        $field = ilDclCache::getCloneOf((int) $this->getField()->getId(), ilDclCache::TYPE_FIELD);
        $record = ilDclCache::getCloneOf($this->getRecord()->getId(), ilDclCache::TYPE_RECORD);
        $record_field = ilDclCache::getRecordFieldCache($record, $field);

        if (!$record_field->getValue()) {
            return;
        }

        $mob_old = new ilObjMediaObject($record_field->getValue());
        $mob_new = $mob_old->duplicate();

        $this->setValue($mob_new->getId(), true);
        $this->doUpdate();
    }

Here is the call graph for this function:

parseExportValue()

ilDclMobRecordFieldModel::parseExportValue

(

$value

)

Function to parse incoming data from form input value $value.

returns the int|string to store in the database.

Parameters

int | string

$value

Returns

int|string

Definition at line 116 of file class.ilDclMobRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value.

    {
        $file = $value;
        if (is_numeric($file)) {
            $mob = new ilObjMediaObject($file);
            return $mob->getTitle();
        }

        return $file;
    }

parseSortingValue()

ilDclMobRecordFieldModel::parseSortingValue	(		$value,
		bool	$link = true
	)

Returns sortable value for the specific field-types.

Parameters

int

$value

Definition at line 131 of file class.ilDclMobRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value.

                                                                : string
    {
        $mob = new ilObjMediaObject($value);

        return $mob->getTitle();
    }

parseValue()

ilDclMobRecordFieldModel::parseValue

(

$value

)

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

References $location, ilDclBaseRecordFieldModel\$value, ilObjMediaObject\_getDirectory(), ilObjMediaObject\_saveUsage(), ilFFmpeg\enabled(), ilFFmpeg\extractImage(), ilFileUtils\getASCIIFilename(), ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilObjMediaObject\getMimeType(), ilDclBaseRecordFieldModel\getRecord(), ilDclPropertyFormGUI\getTempFilename(), ilDclBaseRecordFieldModel\getValue(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), removeData(), ilFileUtils\rename(), ilFileUtils\renameExecutables(), ilFFmpeg\supportsImageExtraction(), and ILIAS\Repository\upload().

    {
        if ($value === -1) {
            return null;
        }

        $media = $value;

        $has_record_id = $this->http->wrapper()->query()->has('record_id');
        $is_confirmed = $this->http->wrapper()->post()->has('save_confirmed');
        $has_save_confirmation = ($this->getRecord()->getTable()->getSaveConfirmation() && !$has_record_id);

        if (($media['tmp_name'] ?? '') !== '' && (!$has_save_confirmation || $is_confirmed)) {
            $mob = new ilObjMediaObject();
            $mob->setTitle($media['name']);
            $mob->create();
            $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
            if (!is_dir($mob_dir)) {
                $mob->createDirectory();
            }
            $media_item = new ilMediaItem();
            $mob->addMediaItem($media_item);
            $media_item->setPurpose('Standard');
            $file_name = ilFileUtils::getASCIIFilename($media['name']);
            $file_name = str_replace(' ', '_', $file_name);
            $target_file_path = $mob_dir . '/' . $file_name;
            $location = $file_name;

            if ($has_save_confirmation) {
                $ilfilehash = $this->http->wrapper()->post()->retrieve(
                    'ilfilehash',
                    $this->refinery->kindlyTo()->string()
                );

                $move_file = ilDclPropertyFormGUI::getTempFilename(
                    $ilfilehash,
                    'field_' . $this->getField()->getId(),
                    $media['name'],
                    $media['type']
                );
            } else {
                if (!$this->upload->hasBeenProcessed()) {
                    $this->upload->process();
                }

                if (!$this->upload->hasUploads()) {
                    throw new ilException($this->lng->txt('upload_error_file_not_found'));
                }
                $move_file = $media['tmp_name'];
            }

            ilFileUtils::rename($move_file, $target_file_path);
            ilFileUtils::renameExecutables($mob_dir);

            $format = ilObjMediaObject::getMimeType($target_file_path);

            ilObjMediaObject::_saveUsage(
                $mob->getId(),
                'dcl:html',
                $this->getRecord()->getTable()->getCollectionObject()->getId()
            );
            $media_item->setFormat($format);
            $media_item->setLocation($location);
            $media_item->setLocationType('LocalFile');

            if (ilFFmpeg::enabled() && ilFFmpeg::supportsImageExtraction($format)) {
                $med = $mob->getMediaItem('Standard');
                $mob_file = ilObjMediaObject::_getDirectory($mob->getId()) . '/' . $med->getLocation();
                $a_target_dir = ilObjMediaObject::_getDirectory($mob->getId());
                ilFFmpeg::extractImage($mob_file, 'mob_vpreview.png', $a_target_dir);
            }

            $mob->update();
            $return = $mob->getId();
            if ($this->value !== null) {
                $this->removeData();
            }
        } else {
            if (($media['tmp_name'] ?? '') !== '') {
                $return = $media;
            } else {
                $return = $this->getValue();
            }
        }

        return $return;
    }

Here is the call graph for this function:

removeData()

ilDclMobRecordFieldModel::removeData ( )

protected

Definition at line 138 of file class.ilDclMobRecordFieldModel.php.

References ilObjMediaObject\_removeUsage(), and ilDclBaseRecordFieldModel\getRecord().

Referenced by parseValue().

                                   : void
    {
        $mob = new ilObjMediaObject($this->value);
        ilObjMediaObject::_removeUsage(
            $mob->getId(),
            'dcl:html',
            $this->getRecord()->getTable()->getCollectionObject()->getId()
        );
        $mob->delete();
    }

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:

• components/ILIAS/DataCollection/classes/Fields/Mob/class.ilDclMobRecordFieldModel.php