Inheritance diagram for ilObjectDAV:

Collaboration diagram for ilObjectDAV:

Public Member Functions
	__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...

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

Data Fields
	$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 37 of file class.ilObjectDAV.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectDAV::__construct	(	$refId,
		$obj = `null`
	)

Constructor.

Parameters

int	A refId to the object.

Reimplemented in ilObjFileDAV, and ilObjNullDAV.

Definition at line 60 of file class.ilObjectDAV.php.

    {
        if (is_object($obj)) {
            $this->writelog('<constructor>(' . $refId . ',' . get_class($obj) . ')');
        }
        $this->refId = $refId;
        $this->obj =&$obj;
    }

References $obj, $refId, and writelog().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

ilObjectDAV::__toString ( )

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

Definition at line 864 of file class.ilObjectDAV.php.

    {
        return get_class($this) . '#' . $this->getObjectId();
    }

References getObjectId().

Here is the call graph for this function:

◆ addCopy()

ilObjectDAV::addCopy	(	&	$objDAV,
			$newName = `null`
	)

Adds a copy of the specified object as a child to this object.

Parameters

ilObjectDAV	the object to be copied.
string	the new name of the copy (optional).

Returns: A new ilObjectDAV object representing the cloned object.

Definition at line 520 of file class.ilObjectDAV.php.

    {
        $this->writelog("addCopy($objDAV,$newName) ....");
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
        $tree = $DIC['tree'];
        $revIdMapping = array();
        $newRef = $this->cloneNodes($objDAV->getRefId(), $this->getRefId(), $revIdMapping, $newName);
        //$rbacadmin->adjustMovedObjectPermissions($newRef, $tree->getParentId($objDAV->getRefId()));
        return self::createObject($newRef, $objDAV->getILIASType());
        $this->writelog('... addCopy done.');
    }

References $DIC, cloneNodes(), createObject(), and writelog().

Here is the call graph for this function:

◆ addMove()

ilObjectDAV::addMove	(	&	$objDAV,
			$newName = `null`
	)

Adds (moves) the specified object as a child to this object.

The object is removed from its former parent.

Parameters

ilObjectDAV	the object to be moved.
string	the new name (optional).

Definition at line 593 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
        global $DIC;
        $ilias = $DIC['ilias'];
        global $DIC;
        $log = $DIC['log'];
    
        $this->writelog('addMove(' . $objDAV->getRefId() . ' to ' . $this->getRefId() . ', newName=' . $newName . ')');
        
        // Step 0:Assign new name to moved object
        if (!is_null($newName)) {
            $objDAV->setResourceName($newName);
            $objDAV->write();
        }
        
        // Step 1: Store old parent
        $old_parent = $tree->getParentId($objDAV->getRefId());
        
        // Step 2: Move the tree
        $tree->moveTree($objDAV->getRefId(), $this->getRefId());
        
        // Step 3: Repair permissions
        $rbacadmin->adjustMovedObjectPermissions($objDAV->getRefId(), $old_parent);
        
        /*
        // STEP 1: Move subtree to trash
        $this->writelog('addMove('.$objDAV->getRefId().' to '.$this->getRefId().') step 1: move subtree to trash');
        $subnodes = $tree->getSubTree($tree->getNodeData($objDAV->getRefId()));
        foreach ($subnodes as $node)
        {
            $rbacadmin->revokePermission($node["child"]);
            $affectedUsers = ilUtil::removeItemFromDesktops($node["child"]);
        }
        $tree->saveSubTree($objDAV->getRefId());
        $tree->deleteTree($tree->getNodeData($objDAV->getRefId()));
 
        // STEP 2: Move subtree to new location
        // TODO: this whole put in place again stuff needs revision. Permission settings get lost.
        $this->writelog('addMove() step 2: move subtree to new location');
        // put top node to dest
        $rbacadmin->revokePermission($subnodes[0]['child']);
        $obj_data =& $ilias->obj_factory->getInstanceByRefId($subnodes[0]['child']);
        $obj_data->putInTree($this->getRefId());
        $obj_data->setPermissions($this->getRefId());
        array_shift($subnodes);
 
        // put all sub nodes to their parent (of which we have moved top already to dest).
        foreach ($subnodes as $node)
        {
            $rbacadmin->revokePermission($node['child']);
            $obj_data =& $ilias->obj_factory->getInstanceByRefId($node['child']);
            $obj_data->putInTree($node['parent']);
            $obj_data->setPermissions($node['parent']);
        }
 
        // STEP 3: Remove trashed objects from system
        $this->writelog('addMove('.$objDAV->getRefID().') step 3: remove trashed objects from system');
        require_once 'Services/Tree/classes/class.ilTree.php';
        $trashTree = new ilTree(- (int) $objDAV->getRefId());
        $node = $trashTree->getNodeData($objDAV->getRefId());
        $subnodes = $trashTree->getSubTree($node);
 
        // remember already checked deleted node_ids
        $checked[] = -(int) $objDAV->getRefId();
 
        // dive in recursive manner in each already deleted subtrees and remove these objects too
        $this->removeDeletedNodes($objDAV->getRefId(), $checked, false);
 
        // delete trash tree
        $tree->deleteTree($node);
        $this->writelog('addMove('.$objDAV->getRefID().') all 3 steps done');
        */
    }

References $DIC, $log, and writelog().

Here is the call graph for this function:

◆ children()

ilObjectDAV::children ( )

Returns the children of this object.

Returns: Array<ilObjectDAV>. Returns an empty array, if this object is not a collection..

Reimplemented in ilObjMountPointDAV.

Definition at line 734 of file class.ilObjectDAV.php.

    {
        // FIXME: Remove duplicate entries from this list, because of RFC2518, chapter 5.2
        //        If a duplicate is found, the older object must win. We use the object
        //        id to determine this. This is based on the assumption, that new objects
        //        have higher object id's then older objects.
        
        global $DIC;
        $tree = $DIC['tree'];
        
        $childrenDAV = array();
        // Performance optimization. We sort the children using PHP instead of using the database.
        //$childrenData =& $tree->getChilds($this->getRefId(),'title');
        $childrenData =&$tree->getChilds($this->getRefId(), '');
        foreach ($childrenData as $data) {
            $childDAV =&self::createObject($data['ref_id'], $data['type']);
            if (!is_null($childDAV)) {
                // Note: We must not assign with =& here, because this will cause trouble
                //       when other functions attempt to work with the $childrenDAV array.
                $childrenDAV[] = $childDAV;
            }
        }
        return $childrenDAV;
    }

References $data, $DIC, createObject(), and getRefId().

Referenced by childrenWithPermission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ childrenWithPermission()

ilObjectDAV::childrenWithPermission	(	$operations,
		$type = `''`
	)

Returns the children of this object with the specified permissions.

Parameters

string	one or more operations, separated by commas (i.e.: visible,read,join)
string	the ILIAS type definition abbreviation (i.e.: frm,grp,crs) (only needed for 'create' operation'.

Returns: Array<ilObjectDAV>. Returns an empty array, if this object is not a collection..

Definition at line 767 of file class.ilObjectDAV.php.

    {
        //$this->writelog('@'.$this->getRefId().'.childrenWithPermission('.$operations.','.$type.')');
        $childrenDAV = $this->children();
        $permittedChildrenDAV = array();
        foreach ($childrenDAV as $childDAV) {
            if ($childDAV->isPermitted($operations, $type)) {
                $permittedChildrenDAV[] = $childDAV;
            }
        }
        //$this->writelog('@'.$this->getRefId().'.childrenWithPermission():'.count($permittedChildrenDAV).' children');
        return $permittedChildrenDAV;
    }

References $type, and children().

Here is the call graph for this function:

◆ cloneNodes()

ilObjectDAV::cloneNodes	(		$srcRef,
			$dstRef,
		&	$mapping,
			$newName = `null`
	)

Recursively clones all nodes of the RBAC tree.

@access private

Parameters

integer	ref_id of source object
integer	ref_id of destination object
array	mapping new_ref_id => old_ref_id
string	the new name of the copy (optional).

Returns: The ref_id pointing to the cloned object.

Definition at line 543 of file class.ilObjectDAV.php.

    {
        $this->writelog("cloneNodes($srcRef,$dstRef,$mapping,$newName)");
        global $DIC;
        $tree = $DIC['tree'];
        global $DIC;
        $ilias = $DIC['ilias'];
        
        // clone the source node
        $srcObj =&$ilias->obj_factory->getInstanceByRefId($srcRef);
        $this->writelog('cloneNodes cloning srcRef=' . $srcRef . ' dstRef=' . $dstRef . '...');
        $newObj = $srcObj->cloneObject($dstRef);
        $newRef = $newObj->getRefId();
        
        // We must immediately apply a new name to the object, to
        // prevent confusion of WebDAV clients about having two objects with identical
        // name in the repository.
        $this->writelog("cloneNodes newname not null? " . (!is_null($newName)));
        if (!is_null($newName)) {
            $newObjDAV = self::createObject($newRef, $srcObj->getType());
            $newObjDAV->setResourceName($newName);
            $newObjDAV->write();
        }
        unset($srcObj);
        $mapping[$newRef] = $srcRef;
 
        // clone all children of the source node
        $children = $tree->getChilds($srcRef);
        foreach ($tree->getChilds($srcRef) as $child) {
            // Don't clone role folders, because it does not make sense to clone local roles
            // FIXME - Maybe it does make sense (?)
            if ($child["type"] != 'rolf') {
                $this->cloneNodes($child["ref_id"], $newRef, $mapping, null);
            } else {
                if (count($rolf = $tree->getChildsByType($newRef, "rolf"))) {
                    $mapping[$rolf[0]["ref_id"]] = $child["ref_id"];
                }
            }
        }
        $this->writelog('cloneNodes ...cloned srcRef=' . $srcRef . ' dstRef=' . $dstRef . ' newRef=' . $newRef);
        return $newRef;
    }

References $DIC, cloneNodes(), createObject(), and writelog().

Referenced by addCopy(), and cloneNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCollection()

ilObjectDAV::createCollection ( $name )

Creates a dav collection as a child of this object.

Parameters

string the name of the collection.

Returns: ilObjectDAV returns the created collection, or null if creation failed.

Reimplemented in ilObjCategoryDAV.

Definition at line 390 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
 
        // create and insert Folder in tree
        require_once 'Modules/Folder/classes/class.ilObjFolder.php';
        $newObj = new ilObjFolder(0);
        $newObj->setType($this->getILIASCollectionType());
        $newObj->setTitle($name);
        //$newObj->setDescription('');
        $newObj->create();
        $newObj->createReference();
        $newObj->setPermissions($this->getRefId());
        $newObj->putInTree($this->getRefId());
        
        require_once 'class.ilObjFolderDAV.php';
        return new ilObjFolderDAV($newObj->getRefId(), $newObj);
    }

References $DIC, $name, getILIASCollectionType(), and getRefId().

Here is the call graph for this function:

◆ createFile()

ilObjectDAV::createFile ( $name )

Creates a dav file as a child of this object.

Parameters

string the name of the file.

Returns: ilObjectDAV returns the created object, or null if creation failed.

Definition at line 415 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
 
        // create and insert Folder in tree
        require_once 'Modules/File/classes/class.ilObjFile.php';
        $newObj = new ilObjFile(0);
        $newObj->setType($this->getILIASFileType());
        $newObj->setTitle($name);
        $newObj->setFileName($name);
        include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
        $mime = ilMimeTypeUtil::getMimeType("", $name, 'application/octet-stream');
        //$newObj->setFileType('application/octet-stream');
        $newObj->setFileType($mime);
        //$newObj->setDescription('');
        $newObj->create();
        $newObj->createReference();
        $newObj->setPermissions($this->getRefId());
        $newObj->putInTree($this->getRefId());
        //$newObj->createDirectory();
        
        require_once 'class.ilObjFileDAV.php';
        $objDAV = new ilObjFileDAV($newObj->getRefId(), $newObj);
        /*
        $fs = $objDAV->getContentOutputStream();
        fwrite($fs,' ');
        fclose($fs);
        */
        return $objDAV;
    }

References $DIC, $name, getILIASFileType(), ilMimeTypeUtil\getMimeType(), and getRefId().

Here is the call graph for this function:

◆ createFileFromNull()

ilObjectDAV::createFileFromNull	(		$name,
		&	$nullDAV
	)

Creates a dav file as a child of this object.

Parameters

string the name of the file.

Returns: ilObjectDAV returns the created object, or null if creation failed.

Definition at line 452 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
 
        // create and insert Folder in tree
        require_once 'Modules/File/classes/class.ilObjFile.php';
        $objDAV =&$nullDAV->convertToILIASType($this->getRefId(), $this->getILIASFileType());
        $objDAV->initFromNull();
        return $objDAV;
    }

References $DIC, getILIASFileType(), and getRefId().

Here is the call graph for this function:

◆ createNewVersion()

ilObjectDAV::createNewVersion ( )

Creates a new version of the object.

Only objects which support versioning need to implement this method.

Reimplemented in ilObjFileDAV.

Definition at line 379 of file class.ilObjectDAV.php.

380 {

381 }

◆ createNull()

ilObjectDAV::createNull ( $name )

Creates a dav null object as a child of this object.

null objects are used for locking names.

Parameters

string the name of the null object.

Returns: ilObjectDAV returns the created object, or null if creation failed.

Definition at line 470 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
 
        // create and insert Folder in tree
        require_once './Services/Object/classes/class.ilObject.php';
        $newObj = new ilObject(0);
        $newObj->setType('null');
        $newObj->setTitle($name);
        $newObj->create();
        $newObj->createReference();
        $newObj->setPermissions($this->getRefId());
        $newObj->putInTree($this->getRefId());
        
        require_once 'class.ilObjNullDAV.php';
        $objDAV = new ilObjNullDAV($newObj->getRefId(), $newObj);
        
        return $objDAV;
    }

References $DIC, $name, and getRefId().

Here is the call graph for this function:

◆ createObject()

static ilObjectDAV::createObject	(	$refId,
		$type
	)

static

Static factory method to create a DAV object for a given refId and type.

Parameters

int	refID.
String	type The ILIAS object type.

Returns: ilObjectDAV. Returns null, if no DAV object can be constructed for the specified type.

Definition at line 789 of file class.ilObjectDAV.php.

    {
        $newObj = null;
        
        switch ($type) {
            case 'mountPoint':
                require_once 'class.ilObjMountPointDAV.php';
                $newObj = new ilObjMountPointDAV($refId, null);
                break;
            case 'root':
                require_once 'class.ilObjRootDAV.php';
                $newObj = new ilObjRootDAV($refId, null);
                break;
            case 'cat':
                require_once 'class.ilObjCategoryDAV.php';
                $newObj = new ilObjCategoryDAV($refId, null);
                break;
            case 'fold':
                require_once 'class.ilObjFolderDAV.php';
                $newObj = new ilObjFolderDAV($refId, null);
                break;
            case 'crs':
                require_once 'class.ilObjCourseDAV.php';
                $newObj = new ilObjCourseDAV($refId, null);
                break;
            case 'grp':
                require_once 'class.ilObjGroupDAV.php';
                $newObj = new ilObjGroupDAV($refId, null);
                break;
            case 'file':
                require_once 'class.ilObjFileDAV.php';
                $newObj = new ilObjFileDAV($refId, null);
                break;
            case 'null':
                require_once 'class.ilObjNullDAV.php';
                $newObj = new ilObjNullDAV($refId, null);
                break;
            default:
                break;
        }
        if (!is_null($newObj)) {
            $newObj->read();
        }
        return $newObj;
    }

References $refId, and $type.

Referenced by addCopy(), children(), ilObjMountPointDAV\children(), cloneNodes(), ilObjNullDAV\convertToILIASType(), ilDAVServer\getObject(), and ilDAVServer\toObjectPath().

Here is the caller graph for this function:

◆ getContentData()

ilObjectDAV::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 in ilObjFileDAV.

Definition at line 289 of file class.ilObjectDAV.php.

    {
        return null;
    }

◆ getContentLength()

ilObjectDAV::getContentLength ( )

Returns the number of bytes of the content.

Returns: int.

Reimplemented in ilObjCategoryDAV, ilObjCourseDAV, ilObjFileDAV, ilObjFolderDAV, ilObjGroupDAV, ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 251 of file class.ilObjectDAV.php.

    {
        return 0;
    }

◆ getContentOutputStream()

ilObjectDAV::getContentOutputStream ( )

Returns an output stream to the content.

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

Reimplemented in ilObjFileDAV.

Definition at line 267 of file class.ilObjectDAV.php.

    {
        return null;
    }

◆ getContentOutputStreamLength()

ilObjectDAV::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 in ilObjFileDAV.

Definition at line 280 of file class.ilObjectDAV.php.

    {
        // subclass responsibility
    }

◆ getContentStream()

ilObjectDAV::getContentStream ( )

Returns the content of the object as a stream.

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

Reimplemented in ilObjFileDAV.

Definition at line 259 of file class.ilObjectDAV.php.

    {
        return null;
    }

◆ getContentType()

ilObjectDAV::getContentType ( )

Returns the mime type of the content of this object.

Returns: String.

Reimplemented in ilObjCategoryDAV, ilObjCourseDAV, ilObjFileDAV, ilObjFolderDAV, ilObjGroupDAV, ilObjMountPointDAV, ilObjNullDAV, and ilObjRootDAV.

Definition at line 227 of file class.ilObjectDAV.php.

    {
        return 'application/x-non-readable';//'application/octet-stream';
    }

◆ getCreationTimestamp()

ilObjectDAV::getCreationTimestamp ( )

Returns the creation date of this object as a Unix timestamp.

Precondition: Object must have been read.

Returns: int.

Reimplemented in ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 171 of file class.ilObjectDAV.php.

    {
        return strtotime($this->obj->getCreateDate());
    }

◆ getDisplayName()

ilObjectDAV::getDisplayName ( )

Returns the display name of this object.

Precondition: Object must have been read.

Returns: String.

Reimplemented in ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 161 of file class.ilObjectDAV.php.

    {
        return $this->obj->getTitle();
    }

◆ getILIASCollectionType()

ilObjectDAV::getILIASCollectionType ( )

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

Reimplemented in ilObjCategoryDAV, and ilObjRootDAV.

Definition at line 363 of file class.ilObjectDAV.php.

    {
        return 'fold';
    }

Referenced by createCollection().

Here is the caller graph for this function:

◆ getILIASFileType()

ilObjectDAV::getILIASFileType ( )

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

Definition at line 370 of file class.ilObjectDAV.php.

    {
        return 'file';
    }

Referenced by createFile(), and createFileFromNull().

Here is the caller graph for this function:

◆ getILIASType()

ilObjectDAV::getILIASType ( )

Returns the ilias type of the current object.

Definition at line 352 of file class.ilObjectDAV.php.

    {
        if ($this->obj instanceof ilObject) {
            return $this->obj->getType();
        }
        $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Invalid object given, class=' . get_class($this->obj));
        $GLOBALS['DIC']['ilLog']->logStack();
    }

References $GLOBALS.

◆ getModificationTimestamp()

ilObjectDAV::getModificationTimestamp ( )

Returns the modification date of this object as a Unix timestamp.

Precondition: Object must have been read.

Returns: int.

Reimplemented in ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 181 of file class.ilObjectDAV.php.

    {
        return strtotime($this->obj->getLastUpdateDate());
    }

◆ getNodeId()

ilObjectDAV::getNodeId ( )

Returns the node id of this object.

This only used by objects that are represented as a single object in RBAC, but as multiple objects in WebDAV.

Returns: int.

Definition at line 93 of file class.ilObjectDAV.php.

    {
        return 0;
    }

◆ getObjectId()

ilObjectDAV::getObjectId ( )

Returns the object id of this object.

Returns: int.

Reimplemented in ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 82 of file class.ilObjectDAV.php.

    {
        return ($this->obj == null) ? null : $this->obj->getId();
    }

Referenced by __toString(), and ilObjNullDAV\convertToILIASType().

Here is the caller graph for this function:

◆ getRefId()

ilObjectDAV::getRefId ( )

Returns the ref id of this object.

Returns: int.

Definition at line 74 of file class.ilObjectDAV.php.

    {
        return $this->refId;
    }

References $refId.

Referenced by children(), ilObjNullDAV\convertToILIASType(), ilObjCategoryDAV\createCollection(), createCollection(), createFile(), createFileFromNull(), createNull(), initFromNull(), ilObjFileDAV\initFromNull(), isPermitted(), ilObjCourseDAV\read(), read(), ilObjFileDAV\read(), ilObjGroupDAV\read(), ilObjNullDAV\read(), and ilObjRootDAV\read().

Here is the caller graph for this function:

◆ getResourceName()

ilObjectDAV::getResourceName ( )

Returns the resource name of this object.

Precondition: Object must have been read.

Returns: String.

Reimplemented in ilObjMountPointDAV, and ilObjRootDAV.

Definition at line 142 of file class.ilObjectDAV.php.

    {
        return $this->obj->getUntranslatedTitle();
    }

Referenced by ilObjFileDAV\initFromNull().

Here is the caller graph for this function:

◆ getResourceType()

ilObjectDAV::getResourceType ( )

Returns the DAV resource type of this object.

@return String "collection", "" (file) or "null".

Reimplemented in ilObjCategoryDAV, ilObjCourseDAV, ilObjFileDAV, ilObjFolderDAV, ilObjGroupDAV, ilObjMountPointDAV, ilObjNullDAV, and ilObjRootDAV.

Definition at line 191 of file class.ilObjectDAV.php.

    {
        return "";
    }

Referenced by isCollection(), isFile(), and isNullResource().

Here is the caller graph for this function:

◆ initFromNull()

ilObjectDAV::initFromNull ( )

Initializes the object after it has been converted from NULL.

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

@return void.

Reimplemented in ilObjFileDAV.

Definition at line 104 of file class.ilObjectDAV.php.

    {
        $this->obj->setPermissions($this->getRefId());
    }

References getRefId().

Here is the call graph for this function:

◆ isCollection()

ilObjectDAV::isCollection ( )

Returns true if this object is a DAV collection.

@return bool.

Definition at line 201 of file class.ilObjectDAV.php.

    {
        return $this->getResourceType() == 'collection';
    }

References getResourceType().

Here is the call graph for this function:

◆ isFile()

ilObjectDAV::isFile ( )

Returns true if this object is a DAV file.

@return bool.

Definition at line 210 of file class.ilObjectDAV.php.

    {
        return $this->getResourceType() == '';
    }

References getResourceType().

Here is the call graph for this function:

◆ isNullResource()

ilObjectDAV::isNullResource ( )

Returns true if this is a null resource.

Null objects are used for locking names.

Definition at line 218 of file class.ilObjectDAV.php.

    {
        return $this->getResourceType() == 'null';
    }

References getResourceType().

Here is the call graph for this function:

◆ isOnline()

ilObjectDAV::isOnline ( )

Returns true if the object is online.

Reimplemented in ilObjCourseDAV.

Definition at line 297 of file class.ilObjectDAV.php.

    {
        return true;
    }

Referenced by isPermitted().

Here is the caller graph for this function:

◆ isPermitted()

ilObjectDAV::isPermitted	(	$operations,
		$type = `''`
	)

Returns whether a specific operation is permitted for the current user.

This method takes all conditions into account that are required to perform the specified action on behalf of the current user.

Parameters

string	one or more operations, separated by commas (i.e.: visible,read,join)
string	the ILIAS type definition abbreviation (i.e.: frm,grp,crs) (only needed for 'create' operation'.

Returns: boolean returns true if ALL passed operations are given, otherwise false

Reimplemented in ilObjMountPointDAV.

Definition at line 312 of file class.ilObjectDAV.php.

    {
        // Mount instructions are always visible
        if (isset($_GET['mount-instructions'])) {
            return true;
        }
        
        // The 'visible' operation is only permitted if the object is online,
        // or if the user is also permitted the perform the 'write' operation.
        if (false) {            // old implementation deactivated
            $ops = explode(',', $operations);
            if (in_array('visible', $ops) && !in_array('write', $ops)) {
                if (!$this->isOnline()) {
                    $operations .= ',write';
                }
            }
        
            global $DIC;
            $rbacsystem = $DIC['rbacsystem'];
            return $rbacsystem->checkAccess($operations, $this->getRefId(), $type);
        } else {                // this one fixes bug #5367
            $GLOBALS['DIC']['ilLog']->write('Checking permission for ref_id: ' . $this->getRefId());
            $GLOBALS['DIC']['ilLog']->write("Operations: " . print_r($operations, true));
            
            global $DIC;
            $ilAccess = $DIC['ilAccess'];
            $operations = explode(",", $operations . "");
            foreach ($operations as $operation) {
                if (!$ilAccess->checkAccess($operation, '', $this->getRefId(), $type)) {
                    $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Permission denied for user ' . $GLOBALS['DIC']['ilUser']->getId());
                    return false;
                }
            }
            return true;
        }
    }

References $_GET, $DIC, $GLOBALS, $type, getRefId(), and isOnline().

Here is the call graph for this function:

◆ read()

ilObjectDAV::read ( )

Reads the object data.

Returns: void.

Reimplemented in ilObjCourseDAV, ilObjFileDAV, ilObjGroupDAV, ilObjMountPointDAV, ilObjNullDAV, and ilObjRootDAV.

Definition at line 116 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $ilias = $DIC['ilias'];
        
        if (is_null($this->obj)) {
            $this->obj =&$ilias->obj_factory->getInstanceByRefId($this->getRefId());
            $this->obj->read();
        }
    }

References $DIC, and getRefId().

Here is the call graph for this function:

◆ remove()

ilObjectDAV::remove ( $objDAV )

Removes the specified child from this object.

Parameters

ilObjectDAV the child to be removed.

Definition at line 498 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $tree = $DIC['tree'];
        $rbacadmin = $DIC['rbacadmin'];
        
        $subnodes = $tree->getSubTree($tree->getNodeData($objDAV->getRefId()));
        foreach ($subnodes as $node) {
            $rbacadmin->revokePermission($node["child"]);
            $affectedUsers = ilUtil::removeItemFromDesktops($node["child"]);
        }
        $tree->saveSubTree($objDAV->getRefId());
        $tree->deleteTree($tree->getNodeData($objDAV->getRefId()));
    }

References $DIC, and ilUtil\removeItemFromDesktops().

Here is the call graph for this function:

◆ removeDeletedNodes()

ilObjectDAV::removeDeletedNodes	(	$a_node_id,
		$a_checked,
		$a_delete_objects = `true`
	)

remove already deleted objects within the objects in trash recursive function

@access public

Parameters

integer	ref_id of source object
boolean

Definition at line 679 of file class.ilObjectDAV.php.

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $log = $DIC['log'];
        $ilias = $DIC['ilias'];
        $tree = $DIC['tree'];
        
        $query = "SELECT tree FROM tree WHERE parent = ? AND tree < 0 ";
        $sta = $ilDB->prepare($query, array('integer','integer'));
        $res = $ilDB->execute($sta, array(
            $a_node_id,
            0));
        
 
        while ($row = $ilDB->fetchObject($res)) {
            // only continue recursion if fetched node wasn't touched already!
            if (!in_array($row->tree, $a_checked)) {
                $deleted_tree = new ilTree($row->tree);
                $a_checked[] = $row->tree;
 
                $row->tree = $row->tree * (-1);
                $del_node_data = $deleted_tree->getNodeData($row->tree);
                $del_subtree_nodes = $deleted_tree->getSubTree($del_node_data);
 
                $this->removeDeletedNodes($row->tree, $a_checked);
            
                if ($a_delete_objects) {
                    foreach ($del_subtree_nodes as $node) {
                        $node_obj =&$ilias->obj_factory->getInstanceByRefId($node["ref_id"]);
                        
                        // write log entry
                        /*$this->writelog("removeDeletedNodes(), delete obj_id: ".$node_obj->getId().
                            ", ref_id: ".$node_obj->getRefId().", type: ".$node_obj->getType().", ".
                            "title: ".$node_obj->getTitle());
                        */
                        $node_obj->delete();
                    }
                }
            
                $tree->deleteTree($del_node_data);
                
                // write log entry
                //$this->writelog("removeDeletedNodes(), deleted tree, tree_id: ".$del_node_data["tree"].", child: ".$del_node_data["child"]);
            }
        }
        
        return true;
    }

References $DIC, $ilDB, $log, $query, $res, $row, and removeDeletedNodes().

Referenced by removeDeletedNodes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContentLength()

ilObjectDAV::setContentLength ( $length )

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

Parameters

Integer.

Reimplemented in ilObjFileDAV.

Definition at line 243 of file class.ilObjectDAV.php.

    {
        // subclass responsibility
    }

◆ setContentType()

ilObjectDAV::setContentType ( $type )

Sets the mime type of the content of this object.

Parameters

String.

Reimplemented in ilObjFileDAV.

Definition at line 235 of file class.ilObjectDAV.php.

    {
        // subclass responsibility
    }

◆ setResourceName()

ilObjectDAV::setResourceName ( $name )

Sets the resource name of this object.

Precondition: Object must have been read. @parm String.

Definition at line 151 of file class.ilObjectDAV.php.

    {
        $this->writelog('setResourceName(' . $name . ')');
        return $this->obj->setTitle($name);
    }

References $name, and writelog().

Here is the call graph for this function:

◆ write()

ilObjectDAV::write ( )

Writes the object data.

Returns: void.

Reimplemented in ilObjCategoryDAV, ilObjFileDAV, and ilObjMountPointDAV.

Definition at line 130 of file class.ilObjectDAV.php.

    {
        $this->writelog('write() refid=' . $this->refId);
        $this->obj->update();
    }

References writelog().

Referenced by ilObjNullDAV\convertToILIASType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writelog()

ilObjectDAV::writelog ( $message )

Writes a message to the logfile.,.

Parameters

message String.

Returns: void.

Definition at line 840 of file class.ilObjectDAV.php.

    {
        if ($this->isDebug) {
            global $DIC;
            $log = $DIC['log'];
            $ilias = $DIC['ilias'];
            $log->write(
                $ilias->account->getLogin()
                . ' DAV .' . get_class($this) . ' ' . str_replace("\n", ";", $message)
            );
            /*
            $fh = fopen('/opt/ilias/log/ilias.log', 'a');
            fwrite($fh, date('Y-m-d h:i:s '));
            fwrite($fh, str_replace("\n",";",$message));
            fwrite($fh, "\n\n");
            fclose($fh);
            */
        }
    }

References $DIC, $log, and $message.

Referenced by __construct(), addCopy(), addMove(), cloneNodes(), ilObjNullDAV\convertToILIASType(), setResourceName(), and write().

Here is the caller graph for this function:

Field Documentation

◆ $isDebug

ilObjectDAV::$isDebug = false

The ObjectDAV prints lots of log messages to the ilias log, if this variable is set to true.

Definition at line 53 of file class.ilObjectDAV.php.

◆ $obj

ilObjectDAV::$obj

Application layer object.

Definition at line 47 of file class.ilObjectDAV.php.

Referenced by __construct(), ilObjFileDAV\__construct(), and ilObjNullDAV\__construct().

◆ $refId

ilObjectDAV::$refId

Refid to the object.

Definition at line 42 of file class.ilObjectDAV.php.

Referenced by __construct(), ilObjNullDAV\convertToILIASType(), createObject(), and getRefId().

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

Services/WebDAV/classes/class.ilObjectDAV.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ addCopy()

◆ addMove()

◆ children()

◆ childrenWithPermission()

◆ cloneNodes()

◆ createCollection()

◆ createFile()

◆ createFileFromNull()

◆ createNewVersion()

◆ createNull()

◆ createObject()

◆ getContentData()

◆ getContentLength()

◆ getContentOutputStream()

◆ getContentOutputStreamLength()

◆ getContentStream()

◆ getContentType()

◆ getCreationTimestamp()

◆ getDisplayName()

◆ getILIASCollectionType()

◆ getILIASFileType()

◆ getILIASType()

◆ getModificationTimestamp()

◆ getNodeId()

◆ getObjectId()

◆ getRefId()

◆ getResourceName()

◆ getResourceType()

◆ initFromNull()

◆ isCollection()

◆ isFile()

◆ isNullResource()

◆ isOnline()

◆ isPermitted()

◆ read()

◆ remove()

◆ removeDeletedNodes()

◆ setContentLength()

◆ setContentType()

◆ setResourceName()

◆ write()

◆ writelog()

Field Documentation

◆ $isDebug

◆ $obj

◆ $refId