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

Collaboration diagram for ilDclMobRecordFieldModel:

Public Member Functions
	__construct (ilDclBaseRecordModel $record, ilDclBaseFieldModel $field)
	parseValue ($value)
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	addHiddenItemsToConfirmation (ilConfirmationGUI $confirmation)
	parseSortingValue ($value, bool $link=true)
	Returns sortable value for the specific field-types. More...
	setValueFromForm (ilPropertyFormGUI $form)
	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)

Private Attributes
ilGlobalTemplateInterface	$main_tpl
ILIAS FileUpload FileUpload	$upload

Additional Inherited Members
Protected Member Functions inherited from ilDclBaseRecordFieldModel
	doRead ()
	Read object data from database. More...
	loadValue ()
	Load the value. More...
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

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

Constructor & Destructor Documentation

__construct()

ilDclMobRecordFieldModel::__construct	(	ilDclBaseRecordModel	$record,
		ilDclBaseFieldModel	$field
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\upload().

    {
        parent::__construct($record, $field);
        global $DIC;
        $this->upload = $DIC->upload();
        $this->main_tpl = $DIC->ui()->mainTemplate();
    }

Here is the call graph for this function:

Member Function Documentation

addHiddenItemsToConfirmation()

ilDclMobRecordFieldModel::addHiddenItemsToConfirmation

(

ilConfirmationGUI

$confirmation

)

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

References ILIAS\LTI\ToolProvider\$key, ilDclBaseRecordFieldModel\$value, ilConfirmationGUI\addHiddenItem(), and ilDclBaseRecordFieldModel\getValue().

                                                                                 : void
    {
        if (is_array($this->getValue())) {
            foreach ($this->getValue() as $key => $value) {
                $confirmation->addHiddenItem('field_' . $this->field->getId() . '[' . $key . ']', $value);
            }
        }
    }

Here is the call graph for this function:

afterClone()

ilDclMobRecordFieldModel::afterClone

(

)

Definition at line 214 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($this->getField()->getId(), ilDclCache::TYPE_FIELD);
        $record = ilDclCache::getCloneOf($this->getRecord()->getId(), ilDclCache::TYPE_RECORD);
        $record_field = ilDclCache::getRecordFieldCache($record, $field);

        if (!$record_field || !$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 172 of file class.ilDclMobRecordFieldModel.php.

References ilDclBaseRecordFieldModel\$value.

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

            return $mob_name;
        }

        return $file;
    }

parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

int

$value

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

References ilDclBaseRecordFieldModel\$value.

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

        return $mob->getTitle();
    }

parseValue()

ilDclMobRecordFieldModel::parseValue

(

$value

)

Parameters

array | int

$value

Returns

array|string

Exceptions

ilException
ilFileUtilsException
ilMediaObjectsException

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

References Vendor\Package\$e, ilDclBaseRecordFieldModel\$field, $format, $location, $type, ilDclBaseRecordFieldModel\$value, ilObjMediaObject\_determineWidthHeight(), ilObjMediaObject\_getDirectory(), ilObjMediaObject\_resizeImage(), ilObjMediaObject\_saveUsage(), ilFFmpeg\enabled(), ilFFmpeg\extractImage(), ilFileUtils\getASCIIFilename(), ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilObjMediaObject\getMimeType(), ilDclBaseFieldModel\getProperty(), ilDclBaseRecordFieldModel\getRecord(), ilDclPropertyFormGUI\getTempFilename(), ilDclBaseRecordFieldModel\getValue(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_HEIGHT, ilDclBaseFieldModel\PROP_WIDTH, ILIAS\Repository\refinery(), ilFileUtils\rename(), ilFileUtils\renameExecutables(), ilFFmpeg\supportsImageExtraction(), and ILIAS\Repository\upload().

    {
        if ($value === -1) { //marked for deletion.
            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 (is_array($media)
            && isset($media['tmp_name'])
            && $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;
            $title = $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 (false === $this->upload->hasBeenProcessed()) {
                    $this->upload->process();
                }

                if (false === $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);

            // Check image/video
            $format = ilObjMediaObject::getMimeType($target_file_path);

            if ($format == 'image/jpeg') {
                list($width, $height, $type, $attr) = getimagesize($target_file_path);
                $field = $this->getField();
                $new_width = $field->getProperty(ilDclBaseFieldModel::PROP_WIDTH);
                $new_height = $field->getProperty(ilDclBaseFieldModel::PROP_HEIGHT);
                if ($new_width || $new_height) {
                    //only resize if it is bigger, not if it is smaller
                    if ($new_height < $height && $new_width < $width) {
                        //resize proportional
                        if (!$new_height || !$new_width) {
                            $format = ilObjMediaObject::getMimeType($target_file_path);
                            $wh
                                = ilObjMediaObject::_determineWidthHeight(
                                    $format,
                                    "File",
                                    $target_file_path,
                                    "",
                                    true,
                                    false,
                                    $field->getProperty(ilDclBaseFieldModel::PROP_WIDTH),
                                    (int) $field->getProperty(ilDclBaseFieldModel::PROP_HEIGHT)
                                );
                        } else {
                            $wh['width'] = (int) $field->getProperty(ilDclBaseFieldModel::PROP_WIDTH);
                            $wh['height'] = (int) $field->getProperty(ilDclBaseFieldModel::PROP_HEIGHT);
                        }

                        $location = ilObjMediaObject::_resizeImage($target_file_path, $wh['width'], $wh['height']);
                    }
                }
            }

            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());
                try {
                    $new_file = ilFFmpeg::extractImage($mob_file, "mob_vpreview.png", $a_target_dir, 1);
                } catch (Exception $e) {
                    $this->main_tpl->setOnScreenMessage('failure', $e->getMessage(), true);
                }
            }

            $mob->update();
            $return = $mob->getId();
            // handover for save-confirmation
        } else {
            if (is_array($media) && isset($media['tmp_name']) && $media['tmp_name'] != '') {
                $return = $media;
            } else {
                $return = $this->getValue();
            }
        }

        return $return;
    }

Here is the call graph for this function:

setValueFromForm()

ilDclMobRecordFieldModel::setValueFromForm

(

ilPropertyFormGUI

$form

)

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

References ilDclBaseRecordFieldModel\$value, ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and ilDclBaseRecordFieldModel\setValue().

                                                             : void
    {
        $value = $form->getInput("field_" . $this->getField()->getId());
        if ($form->getItemByPostVar("field_" . $this->getField()->getId())->getDeletionFlag()) {
            $value = -1;
        }
        $this->setValue($value);
    }

Here is the call graph for this function:

Field Documentation

$main_tpl

ilGlobalTemplateInterface ilDclMobRecordFieldModel::$main_tpl

private

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

$upload

ILIAS FileUpload FileUpload ilDclMobRecordFieldModel::$upload

private

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

---

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

• Modules/DataCollection/classes/Fields/Mob/class.ilDclMobRecordFieldModel.php