This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjFolder:

Collaboration diagram for ilObjFolder:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	setFolderTree (ilTree $a_tree)

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

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

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	getViewMode ()

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

	read ()

Public Member Functions inherited from ilContainer
	getTileSizes ()

	getObjectTranslation ()

	setObjectTranslation (?ilObjectTranslation $obj_trans)

	createContainerDirectory ()

	getContainerDirectory ()

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	getStyleSheetId ()

	setStyleSheetId (int $a_style_id)

	setNewsTimeline (bool $a_val)

	getNewsTimeline ()

	setNewsTimelineAutoEntries (bool $a_val)

	getNewsTimelineAutoEntries ()

	setNewsTimelineLandingPage (bool $a_val)

	getNewsTimelineLandingPage ()

	isNewsTimelineEffective ()

	isNewsTimelineLandingPageEffective ()

	setNewsBlockActivated (bool $a_val)

	getNewsBlockActivated ()

	setUseNews (bool $a_val)

	getUseNews ()

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)

	delete ()
	delete category and all related data More...

	getViewMode ()

	getOrderType ()

	setOrderType (int $a_value)

	isClassificationFilterActive ()

	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...

	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ilContainerUserFilter $container_user_filter=null)

	gotItems ()

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

	getGroupedObjTypes ()

	enablePageEditing ()

	create ()
	note: title, description and type should be set when this function is called More...

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

	update ()

	read ()

	readContainerSettings ()

	removeTranslations ()

	deleteTranslation (string $a_lang)

	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Data Fields
ilTree	$folder_tree = null

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

const	TILE_NORMAL = 0

const	TILE_SMALL = 1

const	TILE_LARGE = 2

const	TILE_EXTRA_LARGE = 3

const	TILE_FULL = 4

array	$items = []

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Additional Inherited Members
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory (int $a_id)

static	_lookupContainerSetting (int $a_id, string $a_keyword, string $a_default_value=null)

static	_hasContainerSetting (int $a_id, string $a_keyword)

static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)

static	_getContainerSettings (int $a_id)

static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, int $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 Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Static Public Attributes inherited from ilContainer
static bool	$data_preloaded = false

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()

	applyContainerUserFilter (array $objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...

	filterObjIdsByCopyright (array $obj_ids, string $copyright_id)

	filterObjIdsByDefaultCopyright (array $obj_ids, string $default_identifier)

	legacyOnlineFilter (array $obj_ids, array $objects, int $val)
	Legacy online filter. More...

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes inherited from ilContainer
ILIAS Style Content DomainService	$content_style_domain

ilNewsService	$news

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilObjectDefinition	$obj_definition

int	$order_type = 0

bool	$hiddenfilesfound = false

bool	$news_timeline = false

bool	$news_timeline_auto_entries = false

ilSetting	$setting

ilObjectTranslation	$obj_trans = null

int	$style_id = 0

bool	$news_timeline_landing_page = false

bool	$news_block_activated = false

bool	$use_news = false

ilRecommendedContentManager	$recommended_content_manager

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too. If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjFolder

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFolder::__construct	(	int	$id = `0`,
		bool	$reference = `true`
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ addAdditionalSubItemInformation()

ilObjFolder::addAdditionalSubItemInformation ( array & $object )

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

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

                                                                   : void
    {
        ilObjectActivation::addAdditionalSubItemInformation($object);
    }

References ilObjectActivation\addAdditionalSubItemInformation().

Here is the call graph for this function:

◆ cloneDependencies()

ilObjFolder::cloneDependencies	(	int	$target_id,
		int	$copy_id
	)

Clone object dependencies (container sorting)

@access public

Parameters

int	target ref id of new course
int	copy id return bool

Reimplemented from ilContainer.

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

                                                                   : bool
    {
        parent::cloneDependencies($target_id, $copy_id);
 
        ilObjectActivation::cloneDependencies($this->getRefId(), $target_id, $copy_id);
 
        return true;
    }

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

Here is the call graph for this function:

◆ cloneObject()

ilObjFolder::cloneObject	(	int	$target_id,
		int	$copy_id = `0`,
		bool	$omit_tree = `false`
	)

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

                                                                                          : ?ilObject
    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
        // Copy learning progress settings
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
 
        return $new_obj;
    }

References $target_id, and ilObject\getId().

Here is the call graph for this function:

◆ getViewMode()

ilObjFolder::getViewMode ( )

Reimplemented from ilContainer.

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

                                 : int
    {
        $tree = $this->tree;
        $possible_view_modes = [
            ilContainer::VIEW_SESSIONS,
            ilContainer::VIEW_BY_TYPE,
            ilContainer::VIEW_SIMPLE
        ];
 
        // always try to inherit from grp container, then crs container
        $container_grp_ref_id = $tree->checkForParentType($this->ref_id, 'grp');
        if ($container_grp_ref_id) {
            $grp_view_mode = ilObjGroup::lookupViewMode(ilObject::_lookupObjId($container_grp_ref_id));
            if (in_array($grp_view_mode, $possible_view_modes)) {
                return $grp_view_mode;
            }
        }
        $container_crs_ref_id = $tree->checkForParentType($this->ref_id, 'crs');
        if ($container_crs_ref_id) {
            $crs_view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($container_crs_ref_id));
            if (in_array($crs_view_mode, $possible_view_modes)) {
                return $crs_view_mode;
            }
        }
 
        // default: by type
        return ilContainer::VIEW_BY_TYPE;
    }

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

Here is the call graph for this function:

◆ putInTree()

ilObjFolder::putInTree ( int $parent_ref_id )

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Reimplemented from ilContainer.

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

                                                 : void
    {
        $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(), $parent_ref_id);
        } else {
            // put object id into tree
            $this->folder_tree->insertNode($this->getId(), $parent_ref_id);
        }
    }

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

Here is the call graph for this function:

◆ read()

ilObjFolder::read ( )

Reimplemented from ilContainer.

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

                          : void
    {
        parent::read();
 
        // Inherit order type from parent course (if exists)
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
    }

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

Here is the call graph for this function:

◆ setFolderTree()

ilObjFolder::setFolderTree ( ilTree $a_tree )

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

                                                 : void
    {
        $this->folder_tree = $a_tree;
    }

Field Documentation

◆ $folder_tree

ilTree ilObjFolder::$folder_tree = null

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

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

Modules/Folder/classes/class.ilObjFolder.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalSubItemInformation()

◆ cloneDependencies()

◆ cloneObject()

◆ getViewMode()

◆ putInTree()

◆ read()

◆ setFolderTree()

Field Documentation

◆ $folder_tree