ilObjFolder Class Reference

Class ilObjFolder. More...

Inheritance diagram for ilObjFolder:

Collaboration diagram for ilObjFolder:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	setFolderTree ($a_tree)
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	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
	__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...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. 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...
	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 ()
	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...
Public Member Functions inherited from ilContainer
	__construct ($a_id=0, $a_reference=true)
	getObjectTranslation ()
	Get object translation. More...
	setObjectTranslation (ilObjectTranslation $obj_trans)
	Get object translation. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. 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...
	setNewsTimeline ($a_val)
	Set news timeline. More...
	getNewsTimeline ()
	Get news timeline. More...
	setNewsTimelineAutoEntries ($a_val)
	Set news timeline auto entries. More...
	getNewsTimelineAutoEntries ()
	Get news timeline auto entries. More...
	setNewsTimelineLandingPage ($a_val)
	Set news timline is landing page. More...
	getNewsTimelineLandingPage ()
	Get news timline is landing page. More...
	isNewsTimelineEffective ()
	Is news timeline effective? More...
	isNewsTimelineLandingPageEffective ()
	Is news timeline landing page effective? More...
	setNewsBlockActivated ($a_val)
	Set news block activated. More...
	getNewsBlockActivated ()
	Get news block activated. More...
	setUseNews ($a_val)
	Set use news. More...
	getUseNews ()
	Get use news. 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...
	delete ()
	delete category and all related data 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...
	putInTree ($a_parent_ref)
	update ()
	Update. More...
	read ()
	read More...
	readContainerSettings ()
	Read container settings. More...
	removeTranslations ()
	Remove all translations of container. More...
	deleteTranslation ($a_lang)
	Delete translation. More...
	addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
	Add translation. More...

Data Fields
	$folder_tree
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$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
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 ($ref_id, $title, $tmpdir)
	private functions which iterates through all folders and files and create an according file structure in a temporary directory. More...
static	renameDuplicateFile ($duplicate_filename)
	bugfix mantis 24309: add "_copy_" followed by a number to the filename (in front of the file-type-extension) if there are identically named files in the same folder to prevent an exception being thrown More...

Static Private Attributes
static	$duplicate_files = array()

Additional Inherited Members
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	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. 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. 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	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...
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...
static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...
static	_writeContainerSetting ($a_id, $a_keyword, $a_value)
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 ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview
Protected Attributes inherited from ilContainer
	$db
	$log
	$access
	$error
	$rbacsystem
	$tree
	$user
	$obj_definition
	$order_type = 0
	$hiddenfilesfound = false
	$news_timeline = false
	$news_timeline_auto_entries = false
	$setting
	$obj_trans = null

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 37 of file class.ilObjFolder.php.

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Parameters

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

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

References $DIC.

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->type = "fold";
        parent::__construct($a_id, $a_call_by_reference);
        $this->lng->loadLanguageModule('fold');
    }

Member Function Documentation

addAdditionalSubItemInformation()

ilObjFolder::addAdditionalSubItemInformation

(

&

$a_item_data

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

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

References ilObjectActivation\addAdditionalSubItemInformation().

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

Here is the call graph for this function:

cloneDependencies()

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

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

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

Here is the call graph for this function:

cloneObject()

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

Clone folder.

public

Parameters

int	target id
int	copy id

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

References ilObject\getId().

    {
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
        
        // 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;
    }

Here is the call graph for this function:

downloadFolder()

ilObjFolder::downloadFolder

(

)

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

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

    {
        $ilAccess = $this->access;

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

        $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(), LegacyPathHelper::createRelativePath($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()

ilObjFolder::getViewMode

(

)

Get container view mode.

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

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

    {
        $tree = $this->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;
    }

Here is the call graph for this function:

putInTree()

ilObjFolder::putInTree

(

$a_parent

)

insert folder into grp_tree

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

References ilContainer\$tree, ilObject\getId(), ilObject\getRefId(), and ilObject\withReferences().

    {
        $tree = $this->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);
        }
    }

Here is the call graph for this function:

read()

ilObjFolder::read

(

)

Overwritten read method.

public

Parameters

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

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

    {
        $tree = $this->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()));
    }

Here is the call graph for this function:

recurseFolder()

static ilObjFolder::recurseFolder (   $ref_id,   $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

int	$ref_id	Reference-ID of Folder
string	$title	of Folder
string	$tmpdir	(MUST be already relative due to filesystem-service)

Returns

string returns first created directory

Exceptions

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

References $DIC, ilObject\$ref_id, $s, $sanitizer, ilObject\$title, ilContainer\$tree, ilObject\_isInTrash(), ilObjFile\_lookupAbsolutePath(), and ilUtil\getASCIIFilename().

Referenced by downloadFolder().

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilAccess = $DIC->access();

        $tmpdir .= DIRECTORY_SEPARATOR . ilUtil::getASCIIFilename($title);

        $temp_fs = $DIC->filesystem()->temp();
        $temp_fs->createDir($tmpdir);

        $subtree = $tree->getChildsByTypeFilter($ref_id, array('fold', 'file'));

        $storage_fs = $DIC->filesystem()->storage();

        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 {
                // enhance new_filename to full relative path to enable checking for identically named files
                $new_filename = $tmpdir . DIRECTORY_SEPARATOR . ilUtil::getASCIIFilename($child["title"]);
                $sanitizer = new FilenameSanitizerImpl();
                $new_filename = $sanitizer->sanitize($new_filename);
                if ($temp_fs->has($new_filename)) {
                    $new_filename = self::renameDuplicateFile($new_filename);
                }

                // copy to temporal directory
                $relative_path_of_file = LegacyPathHelper::createRelativePath(ilObjFile::_lookupAbsolutePath($child["obj_id"]));
                if ($storage_fs->has($relative_path_of_file)) {
                    $s = $storage_fs->readStream($relative_path_of_file);
                } else {
                    throw new ilFileException('Could not copy ' . $relative_path_of_file . ' to ' . $new_filename);
                }
                $temp_fs->writeStream($new_filename, $s);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renameDuplicateFile()

static ilObjFolder::renameDuplicateFile (   $duplicate_filename )

staticprivate

bugfix mantis 24309: add "_copy_" followed by a number to the filename (in front of the file-type-extension) if there are identically named files in the same folder to prevent an exception being thrown

Parameters

$duplicate_filename

string filename including path and extension

Returns

string

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

References $filename, and $path.

    {
        // determine the copy_number that will be added to the filename either by obtaining it from
        // the entry of the current file in the duplicate_files-array or use 1 if there is no entry yet
        $copy_number = 1;
        $duplicate_has_array_entry = false;
        foreach (self::$duplicate_files as &$duplicate_file) {
            if ($duplicate_file['file_name'] == $duplicate_filename) {
                $duplicate_has_array_entry = true;
                $copy_number = $duplicate_file['copy_number'];
                // increment the copy_number for correctly renaming the next duplicate of this file
                $duplicate_file['copy_number']++;
            }
        }

        // create an array entry for the duplicate file if there isn't one to ensure that the
        // copy_number can be determined correctly for other duplicates of this file
        if (!$duplicate_has_array_entry) {
            self::$duplicate_files[] = [
                'file_name' => $duplicate_filename,
                'copy_number' => 2 // set as 2 because 1 is already used for this duplicate
            ];
        }

        // rename the file
        $path = pathinfo($duplicate_filename, PATHINFO_DIRNAME);
        $filename = pathinfo($duplicate_filename, PATHINFO_FILENAME);
        $extension = pathinfo($duplicate_filename, PATHINFO_EXTENSION);
        $new_filename = $path . "/" . $filename . " (" . $copy_number . ")." . $extension;

        return $new_filename;
    }

setFolderTree()

ilObjFolder::setFolderTree

(

$a_tree

)

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

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

Field Documentation

$duplicate_files

ilObjFolder::$duplicate_files = array()

staticprivate

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

$folder_tree

ilObjFolder::$folder_tree

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

---

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

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