trait.ilObjFileMetadata.php File Reference

Go to the source code of this file.

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

Variables
trait	ilObjFileMetadata
	Trait ilObjFileMetadata. More...

Function Documentation

beforeCreateMetaData()

beforeCreateMetaData ( )

protected

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

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

beforeMDUpdateListener()

beforeMDUpdateListener (   $a_element )

protected

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

    {
        // Check file extension
        // Removing the file extension is not allowed
        include_once 'Services/MetaData/classes/class.ilMD.php';
        $md = new ilMD($this->getId(), 0, $this->getType());
        if (!is_object($md_gen = $md->getGeneral())) {
            return false;
        }
        $title = $this->checkFileExtension($this->getFileName(), $md_gen->getTitle());
        $md_gen->setTitle($title);
        $md_gen->update();

        return true;
    }

beforeUpdateMetaData()

beforeUpdateMetaData ( )

protected

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

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

createProperties()

createProperties

(

$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 21 of file trait.ilObjFileMetadata.php.

References $_GET, $DIC, ilNewsItem\_getDefaultVisibilityForRefId(), ilBlockSetting\_write(), ilLogLevel\DEBUG, and ilStr\getBytesForString().

Referenced by ilObjFile\doCreate().

    {
        global $DIC;

        if ($a_upload) {
            return true;
        }

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

        // log creation
        $this->log->debug("ilObjFile::createProperties, ID: " . $this->getId() . ", Name: "
            . $this->getFileName() . ", Type: " . $this->getFileType() . ", Size: "
            . $this->getFileSize() . ", Mode: " . $this->getMode() . ", Name(Bytes): "
            . implode(":", ilStr::getBytesForString($this->getFileName())));
        $this->log->logStack(ilLogLevel::DEBUG);

        $DIC->database()->insert('file_data', $this->getArrayForDatabase());

        // 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 71 of file trait.ilObjFileMetadata.php.

References $format.

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

doMDUpdateListener()

doMDUpdateListener (   $a_element )

protected

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

    {
        // handling for technical section
        include_once 'Services/MetaData/classes/class.ilMD.php';

        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 false;
                }

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

                break;
        }

        return true;
    }

doUpdateMetaData()

doUpdateMetaData ( )

protected

update meta data

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

References $format.

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

setNoMetaDataCreation()

setNoMetaDataCreation

(

$a_status

)

Parameters

bool

$a_status

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

    {
        $this->no_meta_data_creation = (bool) $a_status;
    }

Variable Documentation

ilObjFileMetadata

trait ilObjFileMetadata

Initial value:

{
    
    protected $no_meta_data_creation

Trait ilObjFileMetadata.

Author

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

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