Inheritance diagram for ilObjFileDAV:

Collaboration diagram for ilObjFileDAV:

Public Member Functions
	__construct ($refid, $obj=null)
	Constructor. More...

	initFromNull ()
	Initializes the object after it has been converted from the NULL type. More...

	createNewVersion ()
	Creates a new version of the object. More...

	getResourceType ()
	Returns the display name of this object. More...

	getContentType ()
	Returns the mime type of the content of this object. More...

	setContentType ($type)
	Sets the mime type of the content of this object. More...

	setContentLength ($length)
	Sets the length (in bytes) of the content of this object. More...

	getContentLength ()
	Returns the number of bytes of the content. More...

	getContentStream ()
	Returns the content of the object as a stream. More...

	getContentOutputStream ()
	Returns an output stream to the content. More...

	getContentOutputStreamLength ()
	Returns the length of the content output stream. More...

	getContentData ()
	Returns the content of the object as a byte array. More...

	read ()
	Reads the object data. More...

	write ()
	Writes the object data. More...

Public Member Functions inherited from ilObjectDAV
	__construct ($refId, $obj=null)
	Constructor. More...

	getRefId ()
	Returns the ref id of this object. More...

	getObjectId ()
	Returns the object id of this object. More...

	getNodeId ()
	Returns the node id of this object. More...

	initFromNull ()
	Initializes the object after it has been converted from NULL. More...

	read ()
	Reads the object data. More...

	write ()
	Writes the object data. More...

	getResourceName ()
	Returns the resource name of this object. More...

	setResourceName ($name)
	Sets the resource name of this object. More...

	getDisplayName ()
	Returns the display name of this object. More...

	getCreationTimestamp ()
	Returns the creation date of this object as a Unix timestamp. More...

	getModificationTimestamp ()
	Returns the modification date of this object as a Unix timestamp. More...

	getResourceType ()
	Returns the DAV resource type of this object. More...

	isCollection ()
	Returns true if this object is a DAV collection. More...

	isFile ()
	Returns true if this object is a DAV file. More...

	isNullResource ()
	Returns true if this is a null resource. More...

	getContentType ()
	Returns the mime type of the content of this object. More...

	setContentType ($type)
	Sets the mime type of the content of this object. More...

	setContentLength ($length)
	Sets the length (number of bytes) of the content of this object. More...

	getContentLength ()
	Returns the number of bytes of the content. More...

	getContentStream ()
	Returns the content of the object as a stream. More...

	getContentOutputStream ()
	Returns an output stream to the content. More...

	getContentOutputStreamLength ()
	Returns the length of the content output stream. More...

	getContentData ()
	Returns the content of the object as a byte array. More...

	isOnline ()
	Returns true if the object is online. More...

	isPermitted ($operations, $type='')
	Returns whether a specific operation is permitted for the current user. More...

	getILIASType ()
	Returns the ilias type of the current object. More...

	getILIASCollectionType ()
	Returns the ilias type for collections that can be created as children of this object. More...

	getILIASFileType ()
	Returns the ilias type for files that can be created as children of this object. More...

	createNewVersion ()
	Creates a new version of the object. More...

	createCollection ($name)
	Creates a dav collection as a child of this object. More...

	createFile ($name)
	Creates a dav file as a child of this object. More...

	createFileFromNull ($name, &$nullDAV)
	Creates a dav file as a child of this object. More...

	createNull ($name)
	Creates a dav null object as a child of this object. More...

	remove ($objDAV)
	Removes the specified child from this object. More...

	addCopy (&$objDAV, $newName=null)
	Adds a copy of the specified object as a child to this object. More...

	cloneNodes ($srcRef, $dstRef, &$mapping, $newName=null)
	Recursively clones all nodes of the RBAC tree. More...

	addMove (&$objDAV, $newName=null)
	Adds (moves) the specified object as a child to this object. More...

	removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects=true)
	remove already deleted objects within the objects in trash recursive function More...

	children ()
	Returns the children of this object. More...

	childrenWithPermission ($operations, $type='')
	Returns the children of this object with the specified permissions. More...

	writelog ($message)
	Writes a message to the logfile.,. More...

	__toString ()
	This method is needed, because the object class in PHP 5.2 does not have a default implementation of this method anymore. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectDAV
static	createObject ($refId, $type)
	Static factory method to create a DAV object for a given refId and type. More...

Data Fields inherited from ilObjectDAV
	$refId
	Refid to the object. More...

	$obj
	Application layer object. More...

	$isDebug = false
	The ObjectDAV prints lots of log messages to the ilias log, if this variable is set to true. More...

Detailed Description

Definition at line 43 of file class.ilObjFileDAV.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileDAV::__construct	(	$refid,
		$obj = `null`
	)

Constructor.

Parameters

refid A refid to the object.

Reimplemented from ilObjectDAV.

Definition at line 50 of file class.ilObjFileDAV.php.

    {
        parent::__construct($refid, $obj);
              
        // Set debug to true, if you want to get debug output for this
               // object
               //$this->isDebug = true;
    }

References ilObjectDAV\$obj.

Member Function Documentation

◆ createNewVersion()

ilObjFileDAV::createNewVersion ( )

Creates a new version of the object.

Only objects which support versioning need to implement this method.

Reimplemented from ilObjectDAV.

Definition at line 76 of file class.ilObjFileDAV.php.

    {
        $this->obj->setVersion($this->obj->getVersion() + 1);
        ilHistory::_createEntry(
            $this->obj->getId(),
            "replace",
            $this->obj->getFileName() . "," . $this->obj->getVersion()
        );
    }

References ilHistory\_createEntry().

Here is the call graph for this function:

◆ getContentData()

ilObjFileDAV::getContentData ( )

Returns the content of the object as a byte array.

Returns: Array, String. Return null if the content can not be delivered as data.

Reimplemented from ilObjectDAV.

Definition at line 186 of file class.ilObjFileDAV.php.

    {
        return null;
    }

◆ getContentLength()

ilObjFileDAV::getContentLength ( )

Returns the number of bytes of the content.

Returns: int.

Reimplemented from ilObjectDAV.

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

    {
        return ilObjFile::_lookupFileSize($this->obj->getId());
    }

References ilObjFile\_lookupFileSize().

Here is the call graph for this function:

◆ getContentOutputStream()

ilObjFileDAV::getContentOutputStream ( )

Returns an output stream to the content.

Returns: Stream or null, if the content does not support streaming.

Reimplemented from ilObjectDAV.

Definition at line 157 of file class.ilObjFileDAV.php.

    {
        $file = $this->obj->getFile();
        $parent = dirname($file);
        if (!file_exists($parent)) {
            ilUtil::makeDirParents($parent);
        }
        
        return fopen($file, 'w');
    }

References $file, and ilUtil\makeDirParents().

Here is the call graph for this function:

◆ getContentOutputStreamLength()

ilObjFileDAV::getContentOutputStreamLength ( )

Returns the length of the content output stream.

This method is used by the ilDAVServer, if a PUT operation has been performed for which the client did not specify the content length.

Parameters

Integer.

Reimplemented from ilObjectDAV.

Definition at line 176 of file class.ilObjFileDAV.php.

    {
        $file = $this->obj->getFile();
        return file_exists($file) ? filesize($file) : 0;
    }

References $file.

◆ getContentStream()

ilObjFileDAV::getContentStream ( )

Returns the content of the object as a stream.

Returns: Stream or null, if the content does not support streaming.

Reimplemented from ilObjectDAV.

Definition at line 148 of file class.ilObjFileDAV.php.

    {
        $file = $this->obj->getFile();
        return (file_exists($file)) ? fopen($file, 'r') : null;
    }

References $file.

◆ getContentType()

ilObjFileDAV::getContentType ( )

Returns the mime type of the content of this object.

Returns: String.

Reimplemented from ilObjectDAV.

Definition at line 114 of file class.ilObjFileDAV.php.

    {
        //return $this->obj->getFileType();
        return  $this->obj->guessFileType();
    }

◆ getResourceType()

ilObjFileDAV::getResourceType ( )

Returns the display name of this object.

Precondition: Object must have been read.

Returns

String. FIXME - Method deactivated. We don't display the file name as display name. Because the file name is not necessarily known to the user. / function getDisplayName() { return $this->obj->getFileName(); } Returns the DAV resource type of this object.

@return String "collection" or "".

Reimplemented from ilObjectDAV.

Definition at line 105 of file class.ilObjFileDAV.php.

    {
        return "";
    }

◆ initFromNull()

ilObjFileDAV::initFromNull ( )

Initializes the object after it has been converted from the NULL type.

We create all the additonal object data that is needed, to make the object work.

@return void.

Reimplemented from ilObjectDAV.

Definition at line 65 of file class.ilObjFileDAV.php.

    {
        $this->obj->setFileName($this->getResourceName());
        $this->obj->setFileType($this->obj->guessFileType());
        $this->write();
        $this->obj->setPermissions($this->getRefId());
    }

References ilObjectDAV\getRefId(), ilObjectDAV\getResourceName(), and write().

Here is the call graph for this function:

◆ read()

ilObjFileDAV::read ( )

Reads the object data.

Returns: void.

Reimplemented from ilObjectDAV.

Definition at line 194 of file class.ilObjFileDAV.php.

    {
        if (is_null($this->obj)) {
            $this->obj = new ilObjFile($this->getRefId(), true);
            $this->obj->read();
        }
    }

References ilObjectDAV\getRefId().

Here is the call graph for this function:

◆ setContentLength()

ilObjFileDAV::setContentLength ( $length )

Sets the length (in bytes) of the content of this object.

Parameters

Integer.

Reimplemented from ilObjectDAV.

Definition at line 131 of file class.ilObjFileDAV.php.

    {
        $this->writeLog('setContentLength(' . $length . ')');
        $this->obj->setFileSize($length);
    }

◆ setContentType()

ilObjFileDAV::setContentType ( $type )

Sets the mime type of the content of this object.

Parameters

String.

Reimplemented from ilObjectDAV.

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

    {
        $this->obj->setFileType($type);
    }

References $type.

◆ write()

ilObjFileDAV::write ( )

Writes the object data.

Returns: void.

Reimplemented from ilObjectDAV.

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

    {
        $this->isNewFile = $this->obj->getVersion() == 0;
        if ($this->isNewFile) {
            $this->obj->setVersion(1);
        }
        parent::write();
        /*
        ilHistory::_createEntry($this->getObjectId(), 'update', '', '','', true);
        */
    }

Referenced by initFromNull().

Here is the caller graph for this function:

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

Services/WebDAV/classes/class.ilObjFileDAV.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNewVersion()

◆ getContentData()

◆ getContentLength()

◆ getContentOutputStream()

◆ getContentOutputStreamLength()

◆ getContentStream()

◆ getContentType()

◆ getResourceType()

◆ initFromNull()

◆ read()

◆ setContentLength()

◆ setContentType()

◆ write()