trait.ilObjFileMetadata.php File Reference

Go to the source code of this file.

Functions
	updateFileData ()
	createProperties (bool $a_upload=false)
	The basic properties of a file object are stored in table object_data. More...
	setNoMetaDataCreation (bool $a_status)
	beforeCreateMetaData ()
	beforeUpdateMetaData ()
	doCreateMetaData ()
	create file object meta data More...
	beforeMDUpdateListener (string $a_element)
	doMDUpdateListener (string $a_element)
	doUpdateMetaData ()
	update meta data More...

Variables
trait	ilObjFileMetadata
	Trait ilObjFileMetadata. More...

Function Documentation

beforeCreateMetaData()

beforeCreateMetaData ( )

protected

Definition at line 62 of file trait.ilObjFileMetadata.php.

                                             : bool
    {
        return !(bool) $this->no_meta_data_creation;
    }

beforeMDUpdateListener()

beforeMDUpdateListener ( string  $a_element )

protected

Definition at line 88 of file trait.ilObjFileMetadata.php.

References ILIAS\Survey\Mode\getId().

                                                                : bool
    {
        // Check file extension
        // Removing the file extension is not allowed
        $md = new ilMD($this->getId(), 0, $this->getType());
        if (!is_object($md_gen = $md->getGeneral())) {
            return false;
        }
        $title = $this->appendSuffixToTitle($md_gen->getTitle(), $this->getFileName());
        $md_gen->setTitle($title);
        $md_gen->update();

        return true;
    }

Here is the call graph for this function:

beforeUpdateMetaData()

beforeUpdateMetaData ( )

protected

Definition at line 67 of file trait.ilObjFileMetadata.php.

                                             : bool
    {
        return !(bool) $this->no_meta_data_creation;
    }

createProperties()

createProperties

(

bool

$a_upload = false

)

The basic properties of a file object are stored in table object_data.

This is not sufficient for a file object. Therefore we create additional properties in table file_data. This method has been put into a separate operation, to allow a WebDAV Null resource (class.ilObjNull.php) to become a file object.

Definition at line 38 of file trait.ilObjFileMetadata.php.

References $DIC, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_write(), ILIAS\Survey\Mode\getId(), and updateFileData().

Referenced by ilObjFile\doCreate().

                                                            : void
    {
        global $DIC;

        // New Item
        if (isset($this->ref_id)) {
            $default_visibility = ilNewsItem::_getDefaultVisibilityForRefId($this->ref_id);
            if ($default_visibility === "public") {
                ilBlockSetting::_write("news", "public_notifications", 1, 0, $this->getId());
            }
        }
        $this->updateFileData();

        // no meta data handling for file list files
        if ($this->getMode() !== self::MODE_FILELIST) {
            $this->createMetaData();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doCreateMetaData()

doCreateMetaData ( )

protected

create file object meta data

Definition at line 75 of file trait.ilObjFileMetadata.php.

References $format, and ILIAS\Survey\Mode\getId().

                                         : void
    {
        return;   // add technical section with file size and format
        $md_obj = new ilMD($this->getId(), 0, $this->getType());
        $technical = $md_obj->addTechnical();
        $technical->setSize($this->getFileSize());
        $technical->save();
        $format = $technical->addFormat();
        $format->setFormat($this->getFileType());
        $format->save();
        $technical->update();
    }

Here is the call graph for this function:

doMDUpdateListener()

doMDUpdateListener ( string  $a_element )

protected

Definition at line 103 of file trait.ilObjFileMetadata.php.

References $id, and ILIAS\Survey\Mode\getId().

                                                            : void
    {
        // handling for technical section
        switch ($a_element) {
            case 'Technical':

                // Update Format (size is not stored in db)
                $md = new ilMD($this->getId(), 0, $this->getType());
                if (!is_object($md_technical = $md->getTechnical())) {
                    return;
                }

                foreach ($md_technical->getFormatIds() as $id) {
                    $md_format = $md_technical->getFormat($id);
                    $this->setFileType($md_format->getFormat());
                    break;
                }

                break;
        }
    }

Here is the call graph for this function:

doUpdateMetaData()

doUpdateMetaData ( )

protected

update meta data

Definition at line 128 of file trait.ilObjFileMetadata.php.

References $format, and ILIAS\Survey\Mode\getId().

                                         : void
    {
        return;// add technical section with file size and format
        $md_obj = new ilMD($this->getId(), 0, $this->getType());
        if (!is_object($technical = $md_obj->getTechnical())) {
            $technical = $md_obj->addTechnical();
            $technical->save();
        }
        $technical->setSize($this->getFileSize());

        $format_ids = $technical->getFormatIds();
        if (count($format_ids) > 0) {
            $format = $technical->getFormat($format_ids[0]);
            $format->setFormat($this->getFileType());
            $format->update();
        } else {
            $format = $technical->addFormat();
            $format->setFormat($this->getFileType());
            $format->save();
        }
        $technical->update();
    }

Here is the call graph for this function:

setNoMetaDataCreation()

setNoMetaDataCreation

(

bool

$a_status

)

Definition at line 57 of file trait.ilObjFileMetadata.php.

    {
        $this->no_meta_data_creation = $a_status;
    }

updateFileData()

updateFileData ( )

protected

Definition at line 12 of file trait.ilObjFileMetadata.php.

References $DIC, and ILIAS\Survey\Mode\getId().

Referenced by createProperties().

                                       : void
    {
        global $DIC;
        $check_existing = $DIC->database()->queryF(
            'SELECT file_id FROM file_data WHERE file_id = %s',
            ['integer'],
            [$this->getId()]
        );
        if ($check_existing->numRows() === 0) {
            $DIC->database()->insert('file_data', $this->getArrayForDatabase());
        } else {
            $DIC->database()->update(
                'file_data',
                $this->getArrayForDatabase(),
                ['file_id' => ['integer', $this->getId()]]
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ilObjFileMetadata

trait ilObjFileMetadata

Initial value:

{
    protected ?bool $no_meta_data_creation = null

Trait ilObjFileMetadata.

Author

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

Definition at line 9 of file trait.ilObjFileMetadata.php.