ilObjFolder Class Reference

Class ilObjFolder. More...

Inheritance diagram for ilObjFolder:

Collaboration diagram for ilObjFolder:

Public Member Functions
	ilObjFolder ($a_id=0, $a_call_by_reference=true)
	Constructor @access public. More...
	setFolderTree ($a_tree)
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone folder. More...
	putInTree ($a_parent)
	insert folder into grp_tree 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...
	read ()
	Overwritten read method. More...
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor @access public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ($a_force_db=false)
	read object data from db into object More...
	getId ()
	get object id @access public More...
	setId ($a_id)
	set object id @access public More...
	setRefId ($a_id)
	set reference id @access public More...
	getRefId ()
	get reference id @access public More...
	getType ()
	get object type @access public More...
	setType ($a_type)
	set object type @access public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title @access public More...
	getUntranslatedTitle ()
	get untranslated object title @access 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 ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date @access public More...
	getLastUpdateDate ()
	get last update date @access public More...
	getDiskUsage ()
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
	_lookupOwner ($a_id)
	lookup object owner More...
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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) @access public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	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. 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...
	_lookupCreationDate ($a_id)
	Lookup creation date. 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...
Public Member Functions inherited from ilContainer
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor @access public. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	_getContainerDirectory ($a_id)
	Get the container directory. More...
	getBigIconPath ()
	Get path for big icon. More...
	getSmallIconPath ()
	Get path for small icon. More...
	getTinyIconPath ()
	Get path for tiny icon. More...
	getCustomIconPath ()
	Get path for custom icon. More...
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...
	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting. More...
	_writeContainerSetting ($a_id, $a_keyword, $a_value)
	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...
	saveIcons ($a_custom_icon)
	save container icons More...
	removeCustomIcon ()
	remove small icon More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
	clone all objects according to this container More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container. More...
	gotItems ()
	Check whether we got any items. More...
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	Get grouped repository object types. More...
	enablePageEditing ()
	Check whether page editing is allowed for container. More...
	create ()
	Create. More...
	update ()
	Update. More...
	read ()
	read 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
	$obj_data_record
	object_data record More...
Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0
const	VIEW_OBJECTIVE = 1
const	VIEW_TIMING = 2
const	VIEW_ARCHIVE = 3
const	VIEW_SIMPLE = 4
const	VIEW_BY_TYPE = 5
const	VIEW_INHERIT = 6
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
const	SORT_CREATION = 4
const	SORT_DIRECTION_ASC = 0
const	SORT_DIRECTION_DESC = 1
const	SORT_NEW_ITEMS_POSITION_TOP = 0
const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1
const	SORT_NEW_ITEMS_ORDER_TITLE = 0
const	SORT_NEW_ITEMS_ORDER_CREATION = 1
const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

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 ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupObjId ($a_id)
static	setDeletedDates ($a_ref_ids)
	Set deleted date @global type $ilDB. More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public 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	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...
Static Public Member Functions inherited from ilContainer
static	_getContainerSettings ($a_id)
static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false
Protected Attributes inherited from ilContainer
	$order_type = 0
	$hiddenfilesfound = false

Detailed Description

Class ilObjFolder.

Author

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

Version

Id

class.ilObjFolder.php 40448 2013-03-08 10:02:02Z jluetzen

Definition at line 34 of file class.ilObjFolder.php.

Member Function Documentation

addAdditionalSubItemInformation()

ilObjFolder::addAdditionalSubItemInformation

(

&

$a_item_data

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

Definition at line 231 of file class.ilObjFolder.php.

        {               
                include_once './Services/Object/classes/class.ilObjectActivation.php';
                ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
        }

References ilObjectActivation\addAdditionalSubItemInformation().

Here is the call graph for this function:

cloneDependencies()

ilObjFolder::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Clone object dependencies (crs items, preconditions)

@access public

Parameters

int	target ref id of new course
int	copy id

Reimplemented from ilContainer.

Definition at line 110 of file class.ilObjFolder.php.

        {               
                parent::cloneDependencies($a_target_id,$a_copy_id);
 
                include_once('Services/Object/classes/class.ilObjectActivation.php');
                ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
                
                return true;
        }

References ilObjectActivation\cloneDependencies(), and ilObject\getRefId().

Here is the call graph for this function:

cloneObject()

ilObjFolder::cloneObject	(		$a_target_id,
			$a_copy_id = 0
	)

Clone folder.

@access public

Parameters

int	target id
int	copy id

Reimplemented from ilContainer.

Definition at line 64 of file class.ilObjFolder.php.

        {
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                
                // Copy learning progress settings
                include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                $obj_settings = new ilLPObjSettings($this->getId());
                $obj_settings->cloneSettings($new_obj->getId());
                unset($obj_settings);
                
                return $new_obj;
        }

References ilObject\getId().

Here is the call graph for this function:

downloadFolder()

ilObjFolder::downloadFolder

(

)

Definition at line 163 of file class.ilObjFolder.php.

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

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

Here is the call graph for this function:

getViewMode()

ilObjFolder::getViewMode

(

)

Get container view mode.

Reimplemented from ilContainer.

Definition at line 199 of file class.ilObjFolder.php.

        {
                global $tree;
                
                // default: by type
                $view = ilContainer::VIEW_BY_TYPE;
 
                // always inherit from 
                $container_ref_id = $tree->checkForParentType($this->ref_id, 'grp');
                if(!$container_ref_id)
                {
                        $container_ref_id = $tree->checkForParentType($this->ref_id, 'crs');
                }
                if($container_ref_id)
                {
                        include_once("./Modules/Course/classes/class.ilObjCourseAccess.php");
                        $view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($container_ref_id));
                        if ($view_mode == ilContainer::VIEW_SESSIONS ||
                                $view_mode == ilContainer::VIEW_BY_TYPE ||
                                $view_mode == ilContainer::VIEW_SIMPLE)
                        {
                                $view = $view_mode;
                        }
                }
                
                return $view;
        }

References ilObject\_lookupObjId(), ilObjCourseAccess\_lookupViewMode(), ilContainer\VIEW_BY_TYPE, ilContainer\VIEW_SESSIONS, and ilContainer\VIEW_SIMPLE.

Here is the call graph for this function:

ilObjFolder()

ilObjFolder::ilObjFolder	(		$a_id = 0,
			$a_call_by_reference = true
	)

Constructor @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Definition at line 44 of file class.ilObjFolder.php.

        {
                $this->type = "fold";
                parent::__construct($a_id,$a_call_by_reference);
                $this->lng->loadLanguageModule('fold');
        }

putInTree()

ilObjFolder::putInTree

(

$a_parent

)

insert folder into grp_tree

Reimplemented from ilObject.

Definition at line 81 of file class.ilObjFolder.php.

        {
                global $tree;
                
                if (!is_object($this->folder_tree))
                {
                        $this->folder_tree =& $tree; 
                }
 
                if ($this->withReferences())
                {
                        // put reference id into tree
                        $this->folder_tree->insertNode($this->getRefId(), $a_parent);
                }
                else
                {
                        // put object id into tree
                        $this->folder_tree->insertNode($this->getId(), $a_parent);
                }
        }

References ilObject\getId(), ilObject\getRefId(), and ilObject\withReferences().

Here is the call graph for this function:

read()

ilObjFolder::read

(

)

Overwritten read method.

@access public

Parameters

return

Reimplemented from ilContainer.

Definition at line 244 of file class.ilObjFolder.php.

        {
                global $tree;
                
                parent::read();
                
                // Inherit order type from parent course (if exists)
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
        }

References ilContainerSortingSettings\_lookupSortMode(), ilObject\getId(), and ilContainer\setOrderType().

Here is the call graph for this function:

recurseFolder()

static ilObjFolder::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 128 of file class.ilObjFolder.php.

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

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

Referenced by downloadFolder(), ilObjWorkspaceFolder\downloadFolder(), recurseFolder(), and ilObjWorkspaceFolder\recurseFolder().

Here is the call graph for this function:

Here is the caller graph for this function:

setFolderTree()

ilObjFolder::setFolderTree

(

$a_tree

)

Definition at line 51 of file class.ilObjFolder.php.

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

Field Documentation

$folder_tree

ilObjFolder::$folder_tree

Definition at line 36 of file class.ilObjFolder.php.

---

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

• Modules/Folder/classes/class.ilObjFolder.php