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...
	updateCopyright ()
	update copyright meta data More...
	getPathToSize ()
	getPathToFirstFormat ()
	getPathToVersion ()

Variables
trait	ilObjFileMetadata
	Trait ilObjFileMetadata. More...

Function Documentation

beforeCreateMetaData()

beforeCreateMetaData ( )

protected

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

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

beforeMDUpdateListener()

beforeMDUpdateListener ( string  $a_element )

protected

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

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

                                                                : bool
    {
        global $DIC;

        // Check file extension
        // Removing the file extension is not allowed
        if ($a_element !== 'General') {
            return true;
        }

        $paths = $DIC->learningObjectMetadata()->paths();

        $title = $DIC->learningObjectMetadata()->read(
            $this->getId(),
            0,
            $this->getType(),
            $paths->title()
        )->firstData($paths->title())->value();

        $title = $this->appendSuffixToTitle($title, $this->getFileName());

        $DIC->learningObjectMetadata()->manipulate($this->getId(), 0, $this->getType())
                                      ->prepareCreateOrUpdate($paths->title(), $title)
                                      ->execute();

        return true;
    }

Here is the call graph for this function:

beforeUpdateMetaData()

beforeUpdateMetaData ( )

protected

Definition at line 86 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 57 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 94 of file trait.ilObjFileMetadata.php.

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

                                         : void
    {
        global $DIC;

        // add file size and format to LOM
        $manipulator = $DIC->learningObjectMetadata()
                           ->manipulate($this->getId(), 0, $this->getType())
                           ->prepareCreateOrUpdate($this->getPathToSize(), (string) $this->getFileSize())
                           ->prepareCreateOrUpdate($this->getPathToVersion(), (string) $this->getVersion());
        if ($this->getFileType() !== '') {
            $manipulator = $manipulator->prepareCreateOrUpdate($this->getPathToFirstFormat(), $this->getFileType());
        }
        $manipulator->execute();
    }

Here is the call graph for this function:

doMDUpdateListener()

doMDUpdateListener ( string  $a_element )

protected

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

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

                                                            : void
    {
        global $DIC;

        // handling for technical section
        if ($a_element !== 'Technical') {
            return;
        }

        $first_format = $DIC->learningObjectMetadata()->read(
            $this->getId(),
            0,
            $this->getType(),
            $this->getPathToFirstFormat()
        )->firstData($this->getPathToFirstFormat())->value();

        $this->setFileType($first_format);
    }

Here is the call graph for this function:

doUpdateMetaData()

doUpdateMetaData ( )

protected

update meta data

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

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

                                         : void
    {
        global $DIC;

        $manipulator = $DIC->learningObjectMetadata()
                           ->manipulate($this->getId(), 0, $this->getType())
                           ->prepareCreateOrUpdate($this->getPathToSize(), (string) $this->getFileSize())
                           ->prepareCreateOrUpdate($this->getPathToVersion(), (string) $this->getVersion());
        if ($this->getFileType() !== '') {
            $manipulator = $manipulator->prepareCreateOrUpdate($this->getPathToFirstFormat(), $this->getFileType());
        }
        $manipulator->execute();
    }

Here is the call graph for this function:

getPathToFirstFormat()

getPathToFirstFormat ( )

protected

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

References $DIC.

Referenced by doCreateMetaData(), doMDUpdateListener(), and doUpdateMetaData().

                                             : Path
    {
        global $DIC;

        return $DIC->learningObjectMetadata()
                   ->paths()
                   ->custom()
                   ->withNextStep('technical')
                   ->withNextStep('format')
                   ->withAdditionalFilterAtCurrentStep(FilterType::INDEX, '0')
                   ->get();
    }

Here is the caller graph for this function:

getPathToSize()

getPathToSize ( )

protected

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

References $DIC.

Referenced by doCreateMetaData(), and doUpdateMetaData().

                                      : Path
    {
        global $DIC;

        return $DIC->learningObjectMetadata()
                   ->paths()
                   ->custom()
                   ->withNextStep('technical')
                   ->withNextStep('size')
                   ->get();
    }

Here is the caller graph for this function:

getPathToVersion()

getPathToVersion ( )

protected

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

References $DIC.

Referenced by doCreateMetaData(), and doUpdateMetaData().

                                         : Path
    {
        global $DIC;

        return $DIC->learningObjectMetadata()
                   ->paths()
                   ->custom()
                   ->withNextStep('lifeCycle')
                   ->withNextStep('version')
                   ->withNextStep('string')
                   ->get();
    }

Here is the caller graph for this function:

setNoMetaDataCreation()

setNoMetaDataCreation

(

bool

$a_status

)

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

    {
        $this->no_meta_data_creation = $a_status;
    }

updateCopyright()

updateCopyright ( )

protected

update copyright meta data

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

References $DIC.

Referenced by ilObjFile\beforeUpdate(), and ilObjFile\doCreate().

                                        : void
    {
        global $DIC;

        $lom_services = $DIC->learningObjectMetadata();

        $copyright_id = $this->getCopyrightID();
        if (!$lom_services->copyrightHelper()->isCopyrightSelectionActive() || $copyright_id === null) {
            return;
        }

        $lom_services->copyrightHelper()->prepareCreateOrUpdateOfCopyrightFromPreset(
            $lom_services->manipulate($this->getId(), 0, $this->getType()),
            $copyright_id
        )->execute();
    }

Here is the caller graph for this function:

updateFileData()

updateFileData ( )

protected

Definition at line 31 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 28 of file trait.ilObjFileMetadata.php.