Inheritance diagram for ilObjWorkspaceFolder:

Collaboration diagram for ilObjWorkspaceFolder:

Public Member Functions
	initType ()
	setFolderTree ($a_tree)
	doCloneObject ($a_new_object, $a_target_id, $a_copy_id=0)
	Clone folder.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (crs items, preconditions)
	downloadFolder ()
	getViewMode ()
	Get container view mode.
	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g.
Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	Read data from db.
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ($a_clone_mode=false)
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!!
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneMetaData ($target_obj)
	Copy meta data.
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone object permissions, put in tree ...
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	create ()
	create
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates.
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	getXMLZip ()
	getHTMLDirectory ()
	_lookupCreationDate ($a_id)
	Lookup creation date.

Data Fields
	$folder_tree

Static Private Member Functions
static	recurseFolder ($refid, $title, $tmpdir)
	private functions which iterates through all folders and files and create an according file structure in a temporary directory.

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
Protected Member Functions inherited from ilObject2
	doRead ()
	doCreate ()
	beforeCreate ()
	doUpdate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDelete ()
	beforeDelete ()
	beforeCloneObject ()

Detailed Description

Class ilObjWorkspaceFolder.

Author: Wolfgang Merkens wmerk.nosp@m.ens@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

Id:: class.ilObjFolder.php 25528 2010-09-03 10:37:11Z smeyer

Definition at line 15 of file class.ilObjWorkspaceFolder.php.

Member Function Documentation

ilObjWorkspaceFolder::addAdditionalSubItemInformation ( & $a_item_data )

Add additional information to sub item, e.g.

used in courses for timings information etc.

Definition at line 143 of file class.ilObjWorkspaceFolder.php.

        {
                
        }

ilObjWorkspaceFolder::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone object dependencies (crs items, preconditions)

public

Parameters

int	target ref id of new course
int	copy id

Reimplemented from ilObject2.

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

        {
                
        }

ilObjWorkspaceFolder::doCloneObject	(	$a_new_object,
		$a_target_id,
		$a_copy_id = `0`
	)

Clone folder.

public

Parameters

object	clone
int	target id
int	copy id

Reimplemented from ilObject2.

Definition at line 37 of file class.ilObjWorkspaceFolder.php.

        {
                
        }

ilObjWorkspaceFolder::downloadFolder ( )

Definition at line 98 of file class.ilObjWorkspaceFolder.php.

References ilObject\$lng, ilObject\_isInTrash(), ilUtil\delDir(), ilUtil\deliverFile(), ilObject2\getRefId(), ilObject2\getTitle(), ilUtil\ilTempnam(), ilUtil\makeDir(), recurseFolder(), ilUtil\sendInfo(), and ilUtil\zip().

                                         {
                global $lng, $rbacsystem, $ilAccess;
                include_once "./Services/Utilities/classes/class.ilUtil.php";
                include_once 'Modules/File/classes/class.ilObjFile.php';
                include_once 'Modules/File/classes/class.ilFileException.php';
                if (!$ilAccess->checkAccess("read", "", $this->getRefId()))
                {
                        $this->ilErr->raiseError(get_class($this)."::downloadFolder(): missing read permission!",$this->ilErr->WARNING);
                }
                if (ilObject::_isInTrash($this->getRefId()))
                {
                        $this->ilErr->raiseError(get_class($this)."::downloadFolder(): object is trashed!",$this->ilErr->WARNING);
                }
                
                $zip = PATH_TO_ZIP;
                $tmpdir = ilUtil::ilTempnam();          
                ilUtil::makeDir($tmpdir);
                $basename = ilUtil::getAsciiFilename($this->getTitle());
                $deliverFilename = $basename.".zip";
                $zipbasedir = $tmpdir.DIRECTORY_SEPARATOR.$basename;
                $tmpzipfile = $tmpdir.DIRECTORY_SEPARATOR.$deliverFilename;
                
                try {
                        ilObjFolder::recurseFolder ($this->getRefId(), $this->getTitle(), $tmpdir);
                        ilUtil::zip($zipbasedir, $tmpzipfile);
                        rename($tmpzipfile,$zipfile = ilUtil::ilTempnam());
                        ilUtil::delDir($tmpdir);
                        ilUtil::deliverFile($zipfile,$deliverFilename,'',false,true);
                } catch (ilFileException $e) {
                        ilUtil::sendInfo($e->getMessage(), true);
                }
        }

Here is the call graph for this function:

ilObjWorkspaceFolder::getViewMode ( )

Get container view mode.

Definition at line 134 of file class.ilObjWorkspaceFolder.php.

References ilContainer\VIEW_BY_TYPE.

        {               
                return ilContainer::VIEW_BY_TYPE;
        }

ilObjWorkspaceFolder::initType ( )

Reimplemented from ilObject2.

Definition at line 19 of file class.ilObjWorkspaceFolder.php.

        {
                $this->type = "wfld";
        }

static ilObjWorkspaceFolder::recurseFolder	(	$refid,
		$title,
		$tmpdir
	)

staticprivate

private functions which iterates through all folders and files and create an according file structure in a temporary directory.

This function works recursive.

Parameters

integer	$refid	reference it
tmpdictory	$tmpdir

Returns: returns first created directory

Definition at line 63 of file class.ilObjWorkspaceFolder.php.

References ilObject\$title, ilObject\_isInTrash(), ilObjFile\_lookupAbsolutePath(), and ilUtil\makeDir().

Referenced by downloadFolder().

                                                                        {
                global $rbacsystem, $tree, $ilAccess;
                                
                $tmpdir = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($title);
                ilUtil::makeDir($tmpdir);
                
                $subtree = $tree->getChildsByTypeFilter($refid, array("fold","file"));
                
                foreach ($subtree as $child) 
                {
                        if (!$ilAccess->checkAccess("read", "", $child["ref_id"]))
                        {
                                continue;                       
                        }
                        if (ilObject::_isInTrash($child["ref_id"]))
                        {
                                continue;
                        }
                        if ($child["type"] == "fold")
                        {
                                ilObjFolder::recurseFolder ($child["ref_id"], $child["title"], $tmpdir);
                        } else {
                                $newFilename = $tmpdir.DIRECTORY_SEPARATOR.ilUtil::getASCIIFilename($child["title"]);
                                // copy to temporal directory
                                $oldFilename = ilObjFile::_lookupAbsolutePath($child["obj_id"]);
                                if (!copy ($oldFilename, $newFilename))
                                {
                                        throw new ilFileException("Could not copy ".$oldFilename." to ".$newFilename);
                                }       
                                touch($newFilename, filectime($oldFilename));                                                           
                        }
                }
                
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjWorkspaceFolder::setFolderTree ( $a_tree )

Definition at line 24 of file class.ilObjWorkspaceFolder.php.

        {
                $this->folder_tree =& $a_tree;
        }

Field Documentation

ilObjWorkspaceFolder::$folder_tree

Definition at line 17 of file class.ilObjWorkspaceFolder.php.

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

Modules/WorkspaceFolder/classes/class.ilObjWorkspaceFolder.php

Public Member Functions

Data Fields

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation