ilDclMobRecordFieldModel Class Reference

Class ilDclMobRecordFieldModel. More...

Inheritance diagram for ilDclMobRecordFieldModel:

Collaboration diagram for ilDclMobRecordFieldModel:

Public Member Functions
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	addHiddenItemsToConfirmation (ilConfirmationGUI &$confirmation)
	parseSortingValue ($value, $link=true)
	Returns sortable value for the specific field-types. More...
	setValueFromForm ($form)
	@inheritDoc More...
	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, $omit_parsing=false)
	Set value for record field. More...
	setValueFromForm ($form)
	getFormulaValue ()
	parseExportValue ($value)
	Function to parse incoming data from form input value $value. More...
	getValueFromExcel ($excel, $row, $col)
	parseValue ($value)
	Function to parse incoming data from form input value $value. More...
	getExportValue ()
	fillExcelExport (ilExcel $worksheet, &$row, &$col)
	getPlainText ()
	getSortingValue ($link=true)
	addHiddenItemsToConfirmation (ilConfirmationGUI &$confirmation)
	parseSortingValue ($value, $link=true)
	Returns sortable value for the specific field-types. More...
	cloneStructure (ilDclBaseRecordFieldModel $old_record_field)
	afterClone ()
	getField ()
	getId ()
	getRecord ()
	getRecordRepresentation ()
	setRecordRepresentation ($record_representation)
	getFieldRepresentation ()
	setFieldRepresentation ($field_representation)

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
	$id
	$field
	$record
	$record_representation
	$field_representation
	$value
	$user
	$ctrl
	$db
	$lng

Detailed Description

Class ilDclMobRecordFieldModel.

Author

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

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

Member Function Documentation

addHiddenItemsToConfirmation()

ilDclMobRecordFieldModel::addHiddenItemsToConfirmation

(

ilConfirmationGUI &

$confirmation

)

Parameters

ilConfirmationGUI

$confirmation

Reimplemented from ilDclBaseRecordFieldModel.

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

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

References ilDclBaseRecordFieldModel\$value, ilConfirmationGUI\addHiddenItem(), and ilDclBaseRecordFieldModel\getValue().

Here is the call graph for this function:

afterClone()

ilDclMobRecordFieldModel::afterClone

(

)

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

parseExportValue()

ilDclMobRecordFieldModel::parseExportValue

(

$value

)

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

returns the strin/number/etc. to store in the database.

Parameters

mixed

$value

Returns

mixed

Reimplemented from ilDclBaseRecordFieldModel.

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

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

References ilDclBaseRecordFieldModel\$value.

parseSortingValue()

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

Returns sortable value for the specific field-types.

Parameters

	$value
ilDclBaseRecordFieldModel	$record_field
bool | true	$link

Returns

int|string

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        $mob = new ilObjMediaObject($value, false);
 
        return $mob->getTitle();
    }

References ilDclBaseRecordFieldModel\$value.

parseValue()

ilDclMobRecordFieldModel::parseValue

(

$value

)

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

returns the string/number/etc. to store in the database.

Parameters

$value

Returns

int|string

Reimplemented from ilDclBaseRecordFieldModel.

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

    {
        if ($value == -1) { //marked for deletion.
            return 0;
        }
 
        $media = $value;
        $has_save_confirmation = ($this->getRecord()->getTable()->getSaveConfirmation() && !isset($_GET['record_id']));
        $is_confirmed = (bool) (isset($_POST['save_confirmed']));
 
        if (is_array($media) && $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 = ilUtil::getASCIIFilename($media['name']);
            $file_name = str_replace(" ", "_", $file_name);
            $file = $mob_dir . "/" . $file_name;
            $title = $file_name;
            $location = $file_name;
            if ($has_save_confirmation) {
                $move_file = ilDclPropertyFormGUI::getTempFilename($_POST['ilfilehash'], 'field_' . $this->getField()->getId(), $media["name"], $media["type"]);
                ilFileUtils::rename($move_file, $file);
            } else {
                ilUtil::moveUploadedFile($media['tmp_name'], $file_name, $file);
            }
 
            ilUtil::renameExecutables($mob_dir);
            // Check image/video
            $format = ilObjMediaObject::getMimeType($file);
 
            if ($format == 'image/jpeg') {
                list($width, $height, $type, $attr) = getimagesize($file);
                $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($file);
                            $wh
                                = ilObjMediaObject::_determineWidthHeight(
                                    $format,
                                    "File",
                                    $file,
                                    "",
                                    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($file, $wh['width'], $wh['height'], false);
                    }
                }
            }
 
            ilObjMediaObject::_saveUsage($mob->getId(), "dcl:html", $this->getRecord()->getTable()->getCollectionObject()->getId());
            $media_item->setFormat($format);
            $media_item->setLocation($location);
            $media_item->setLocationType("LocalFile");
 
            // FSX MediaPreview
            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) {
                    ilUtil::sendFailure($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;
    }

References $_GET, $_POST, Vendor\Package\$e, ilDclBaseRecordFieldModel\$field, $format, $location, $type, ilDclBaseRecordFieldModel\$value, ilObjMediaObject\_determineWidthHeight(), ilObjMediaObject\_getDirectory(), ilObjMediaObject\_resizeImage(), ilObjMediaObject\_saveUsage(), ilFFmpeg\enabled(), ilFFmpeg\extractImage(), ilUtil\getASCIIFilename(), ilDclBaseRecordFieldModel\getField(), ilDclBaseRecordFieldModel\getId(), ilObjMediaObject\getMimeType(), ilDclBaseRecordFieldModel\getRecord(), ilDclPropertyFormGUI\getTempFilename(), ilDclBaseRecordFieldModel\getValue(), ilUtil\moveUploadedFile(), ilDclBaseFieldModel\PROP_HEIGHT, ilDclBaseFieldModel\PROP_WIDTH, ilFileUtils\rename(), ilUtil\renameExecutables(), ilUtil\sendFailure(), and ilFFmpeg\supportsImageExtraction().

Here is the call graph for this function:

setValueFromForm()

ilDclMobRecordFieldModel::setValueFromForm

(

$form

)

@inheritDoc

Reimplemented from ilDclBaseRecordFieldModel.

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

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

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

Here is the call graph for this function:

---

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

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