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. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (crs items, preconditions) More...

	downloadFolder ()

	getViewMode ()
	Get container view mode. More...

	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g. More...

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()

	read ()
	Read data from db. More...

	getId ()

	setId ($a_id)

	setRefId ($a_id)

	getRefId ()

	getType ()

	setType ($a_type)

	getPresentationTitle ()

	getTitle ()

	getUntranslatedTitle ()

	setTitle ($a_title)

	getDescription ()

	setDescription ($a_desc)

	getLongDescription ()

	getImportId ()

	setImportId ($a_import_id)

	getOwner ()

	getOwnerName ()

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)

	cloneMetaData ($target_obj)

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	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. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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!! More...

	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 More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Data Fields
	$folder_tree

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$ilias

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

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. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)

static	_getIdForImportId ($a_import_id)

static	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

static	_lookupOwner ($a_id)

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)

static	_lookupLastUpdate ($a_id, $a_as_string=false)

static	_getLastUpdateOfObjects ($a_objs)

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)

static	_resetDeletedDate ($a_ref_id)

static	_lookupDeletedDate ($a_ref_id)

static	_writeTitle ($a_obj_id, $a_title)

static	_writeDescription ($a_obj_id, $a_desc)

static	_writeImportId ($a_obj_id, $a_import_id)

static	_lookupType ($a_id, $a_reference=false)

static	_isInTrash ($a_ref_id)

static	_hasUntrashedReference ($a_obj_id)

static	_lookupObjectId ($a_ref_id)

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)

static	_exists ($a_id, $a_reference=false, $a_type=null)

static	_getObjectsByType ($a_obj_type="", $a_owner="")

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	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

◆ addAdditionalSubItemInformation()

ilObjWorkspaceFolder::addAdditionalSubItemInformation ( & $a_item_data )

Add additional information to sub item, e.g.

used in courses for timings information etc.

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

         {
                 
         }

◆ cloneDependencies()

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

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

         {
                 
         }

◆ doCloneObject()

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

Clone folder.

public

Parameters

object	clone
int	target id
int	copy id

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

         {
                 
         }

◆ downloadFolder()

ilObjWorkspaceFolder::downloadFolder ( )

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

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

         {
                 global $ilAccess;
                 
                 include_once 'Modules/File/classes/class.ilObjFile.php';
                 include_once 'Modules/File/classes/class.ilFileException.php';
                 
                 if (!$ilAccess->checkAccess("read", "", $this->getRefId()))
                 {
                         include_once "Services/Object/exceptions/class.ilObjectException.php";
                         throw new ilObjectException("missing read permission!");
                 }
                 if (ilObject::_isInTrash($this->getRefId()))
                 {
                         include_once "Services/Object/exceptions/class.ilObjectException.php";
                         throw new ilObjectException("object is trashed!");
                 }
                 
                 $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:

◆ getViewMode()

ilObjWorkspaceFolder::getViewMode ( )

Get container view mode.

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

References ilContainer\VIEW_BY_TYPE.

         {               
                 return ilContainer::VIEW_BY_TYPE;
         }

◆ initType()

ilObjWorkspaceFolder::initType ( )

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

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

◆ recurseFolder()

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(), array, ilUtil\makeDir(), and ilObjFolder\recurseFolder().

                                                                         {
                 global $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:

◆ setFolderTree()

ilObjWorkspaceFolder::setFolderTree ( $a_tree )

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

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

Field Documentation

◆ $folder_tree

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

◆ addAdditionalSubItemInformation()

◆ cloneDependencies()

◆ doCloneObject()

◆ downloadFolder()

◆ getViewMode()

◆ initType()

◆ recurseFolder()

◆ setFolderTree()

Field Documentation

◆ $folder_tree