Inheritance diagram for ilContainer:

Collaboration diagram for ilContainer:

Public Member Functions
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor 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...

Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor 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 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 ()

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

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

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

Static Public Member Functions
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 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 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 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...

Data Fields
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

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

Static Public Attributes
static	$data_preloaded = false

Protected Attributes
	$order_type = 0

	$hiddenfilesfound = false

Detailed Description

Class ilContainer.

Base class for all container objects (categories, courses, groups)

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ _deleteContainerSettings()

static ilContainer::_deleteContainerSettings	(	$a_id,
		$a_keyword = `null`,
		$a_keyword_like = `false`
	)

static

Definition at line 270 of file class.ilContainer.php.

References $ilDB.

Referenced by ilObjCategoryGUI\updateTaxonomySettingsObject().

         {
                 global $ilDB;
                 
                 if(!$a_id)
                 {
                         return;
                 }
                 
                 $sql = "DELETE FROM container_settings WHERE ".
                                 " id = ".$ilDB->quote($a_id ,'integer');
                 if($a_keyword)
                 {
                         if(!$a_keyword_like)
                         {
                                 $sql .= " AND keyword = ".$ilDB->quote($a_keyword, "text");
                         }
                         else
                         {
                                 $sql .= " AND ".$ilDB->like("keyword", "text", $a_keyword);
                         }
                 }               
                 $ilDB->manipulate($sql);                
         }       

Here is the caller graph for this function:

◆ _exportContainerSettings()

static ilContainer::_exportContainerSettings	(	ilXmlWriter	$a_xml,
			$a_obj_id
	)

static

Definition at line 295 of file class.ilContainer.php.

References ilXmlWriter\xmlData(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by ilCategoryXmlWriter\export(), ilGroupXMLWriter\start(), and ilCourseXMLWriter\start().

         {
                 // container settings
                 $settings = self::_getContainerSettings($a_obj_id);
                 if(sizeof($settings))
                 {
                         $a_xml->xmlStartTag("ContainerSettings");
                         
                         foreach($settings as $keyword => $value)
                         {
                                 // :TODO: proper custom icon export/import
                                 if(stristr($keyword, "icon"))
                                 {
                                         continue;
                                 }
                                 
                                 $a_xml->xmlStartTag(
                                         'ContainerSetting',
                                         array(
                                                 'id' => $keyword,                                               
                                         )
                                 );
                                 
                                 $a_xml->xmlData($value);
                                 $a_xml->xmlEndTag("ContainerSetting");
                         }
                         
                         $a_xml->xmlEndTag("ContainerSettings");
                 }               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getContainerDirectory()

ilContainer::_getContainerDirectory ( $a_id )

Get the container directory.

Returns: string container directory

Definition at line 122 of file class.ilContainer.php.

References ilUtil\getWebspaceDir().

Referenced by ilObject\_getIcon(), _lookupIconPath(), and getContainerDirectory().

         {
                 return ilUtil::getWebspaceDir()."/container_data/obj_".$a_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getContainerSettings()

static ilContainer::_getContainerSettings ( $a_id )

static

Definition at line 253 of file class.ilContainer.php.

References $ilDB, $res, and $row.

Referenced by ilObjCategoryGUI\getActiveBlocks(), and ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId().

         {
                 global $ilDB;
                 
                 $res = array();
                 
                 $sql = "SELECT * FROM container_settings WHERE ".
                                 " id = ".$ilDB->quote($a_id ,'integer');
                 $set = $ilDB->query($sql);
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $res[$row["keyword"]] = $row["value"];                  
                 }               
                 
                 return $res;
         }       

Here is the caller graph for this function:

◆ _lookupContainerSetting()

ilContainer::_lookupContainerSetting	(	$a_id,
		$a_keyword,
		$a_default_value = `NULL`
	)

Lookup a container setting.

Parameters

int	container id
string	setting keyword

Returns: string setting value

Definition at line 215 of file class.ilContainer.php.

References $ilDB, and DB_FETCHMODE_ASSOC.

Referenced by ilObject\_getIcon(), ilAdvancedMDRecord\_getSelectedRecordsByObject(), _lookupIconPath(), ilContainerGUI\editPageContentObject(), ilContainerGUI\editPageFrameObject(), ilContainerGUI\forwardToPageObject(), ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), ilContainerGUI\getContainerPageHTML(), ilObjCategoryListGUI\getInfoScreenStatus(), ilTaxMDGUI\getSelectableTaxonomies(), ilObjCategoryGUI\getTabs(), ilObjectMetaDataGUI\hasAdvancedMDSettings(), ilObject\hasAutoRating(), ilObjCategoryGUI\ilObjCategoryGUI(), ilObjRootFolderGUI\initEditForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilContainerGUI\initStylePropertiesForm(), ilObjectListGUI\insertCommands(), ilTaggingClassificationProvider\isActive(), ilColumnGUI\isGloballyActivated(), ilCalendarSettings\lookupCalendarActivated(), ilObjectDataSet\readData(), ilContainerGUI\savePageContentObject(), ilObjRootFolderGUI\setTitleAndDescription(), and ilContainerGUI\setTitleAndDescription().

         {
                 global $ilDB;
                 
                 $q = "SELECT * FROM container_settings WHERE ".
                                 " id = ".$ilDB->quote($a_id ,'integer')." AND ".
                                 " keyword = ".$ilDB->quote($a_keyword ,'text');
                 $set = $ilDB->query($q);
                 $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);
                 
                 if(isset($rec['value']))
                 {
                         return $rec["value"];
                 }
                 if($a_default_value === NULL)
                 {
                         return '';
                 }
                 return $a_default_value;
         }

Here is the caller graph for this function:

◆ _lookupIconPath()

ilContainer::_lookupIconPath	(	$a_id,
		$a_size = `"big"`
	)

lookup icon path

Parameters

int	$a_id	container object id
string	$a_size	"big" \| "small"

Definition at line 332 of file class.ilContainer.php.

References $size, _getContainerDirectory(), and _lookupContainerSetting().

Referenced by ilPDSelectedItemsBlockGUI\addParentRow(), ilShopPurchaseGUI\addStandardRow(), ilContainerGUI\addStandardRow(), ilPDSelectedItemsBlockGUI\addStandardRow(), and ilContainerGUI\setTitleAndDescription().

         {
                 if ($a_size == "")
                 {
                         $a_size = "big";
                 }
                 $size = $a_size;
                 
                 if (ilContainer::_lookupContainerSetting($a_id, "icon_custom"))
                 {
                         $cont_dir = ilContainer::_getContainerDirectory($a_id);
 
                         $file_name = $cont_dir."/icon_custom.svg";
                         if (is_file($file_name))
                         {
                                 return $file_name;
                         }
                 }
                 
                 return "";
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeContainerSetting()

ilContainer::_writeContainerSetting	(	$a_id,
		$a_keyword,
		$a_value
	)

Definition at line 236 of file class.ilContainer.php.

References $ilDB, $query, and $res.

Referenced by ilCategoryXmlParser\handlerEndTag(), ilGroupXMLParser\handlerEndTag(), ilCourseXMLParser\handlerEndTag(), ilObjectDataSet\importRecord(), ilAdvancedMetaDataImporter\importXmlRepresentation(), removeCustomIcon(), saveIcons(), ilObjStudyProgramme\saveIcons(), ilContainerGUI\savePageContentObject(), ilObjRootFolderGUI\updateObject(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), ilObjCategoryGUI\updateTaxonomySettingsObject(), ilObjectServiceSettingsGUI\updateToolSettings(), and ilContainerGUI\useNewEditorObject().

         {
                 global $ilDB;
                 
                 $query = "DELETE FROM container_settings WHERE ".
                         "id = ".$ilDB->quote($a_id,'integer')." ".
                         "AND keyword = ".$ilDB->quote($a_keyword,'text');
                 $res = $ilDB->manipulate($query);
                 
                 $query = "INSERT INTO container_settings (id, keyword, value) VALUES (".
                         $ilDB->quote($a_id ,'integer').", ".
                         $ilDB->quote($a_keyword ,'text').", ".
                         $ilDB->quote($a_value ,'text').
                         ")";
                 $res = $ilDB->manipulate($query);
         }

Here is the caller graph for this function:

◆ addAdditionalSubItemInformation()

ilContainer::addAdditionalSubItemInformation ( & $object )

Add additional information to sub item, e.g.

used in courses for timings information etc.

Definition at line 755 of file class.ilContainer.php.

Referenced by getSubItems().

756 {

757 }

Here is the caller graph for this function:

◆ cloneAllObject()

ilContainer::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

Parameters

string	$session_id
string	$client_id
string	$new_type
int	$ref_id
int	$clone_source
array	$options
	bool	force soap
	int	submode 1 => copy all, 2 => copy content

Returns: new refid if clone has finished or parameter ref id if cloning is still in progress; array(copy_id => xyz, ref_id => new ref_id)

Definition at line 511 of file class.ilContainer.php.

References $client_id, $ilErr, $ilLog, $ilUser, $options, ilObject\$ref_id, $res, ilCopyWizardOptions\_allocateCopyId(), ilSession\_duplicate(), ilCopyWizardOptions\_getInstance(), ilLoggerFactory\getLogger(), ilSoapFunctions\ilClone(), and ilObjectCopyGUI\SUBMODE_CONTENT_ONLY.

         {
                 global $ilLog;
                 
                 include_once('./Services/Link/classes/class.ilLink.php');
                 include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                 
                 global $ilAccess,$ilErr,$rbacsystem,$tree,$ilUser;
                         
                 // Save wizard options
                 $copy_id = ilCopyWizardOptions::_allocateCopyId();
                 $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
                 $wizard_options->saveOwner($ilUser->getId());
                 $wizard_options->saveRoot($clone_source);
                         
                 // add entry for source container
                 $wizard_options->initContainer($clone_source, $ref_id);
                 
                 foreach($options as $source_id => $option)
                 {
                         $wizard_options->addEntry($source_id,$option);
                 }
                 $wizard_options->read();
                 $wizard_options->storeTree($clone_source);
                 
                 include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                 if($a_submode == ilObjectCopyGUI::SUBMODE_CONTENT_ONLY)
                 {
                         ilLoggerFactory::getLogger('obj')->info('Copy content only...');
                         ilLoggerFactory::getLogger('obj')->debug('Added mapping, source ID: '.$clone_source.', target ID: '.$ref_id);
                         $wizard_options->read();
                         $wizard_options->dropFirstNode();
                         $wizard_options->appendMapping($clone_source,$ref_id);
                 }
                 
                 
                 #print_r($options);
                 // Duplicate session to avoid logout problems with backgrounded SOAP calls
                 $new_session_id = ilSession::_duplicate($session_id);
                 // Start cloning process using soap call
                 include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
 
                 $soap_client = new ilSoapClient();
                 $soap_client->setResponseTimeout(5);
                 $soap_client->enableWSDL(true);
 
                 $ilLog->write(__METHOD__.': Trying to call Soap client...');
                 if($soap_client->init())
                 {
                         ilLoggerFactory::getLogger('obj')->info('Calling soap clone method');
                         $res = $soap_client->call('ilClone',array($new_session_id.'::'.$client_id, $copy_id));
                 }
                 else
                 {
                         ilLoggerFactory::getLogger('obj')->warning('SOAP clone call failed. Calling clone method manually');
                         $wizard_options->disableSOAP();
                         $wizard_options->read();                        
                         include_once('./webservice/soap/include/inc.soap_functions.php');
                         $res = ilSoapFunctions::ilClone($new_session_id.'::'.$client_id, $copy_id);
                 }
                 return array(
                                 'copy_id' => $copy_id,
                                 'ref_id' => (int) $res
                 );
         }

Here is the call graph for this function:

◆ cloneDependencies()

ilContainer::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone object dependencies (container sorting)

public

Parameters

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

Definition at line 473 of file class.ilContainer.php.

References $ilLog, ilContainerSorting\_getInstance(), ilObjItemGroup\fixContainerItemGroupRefsAfterCloning(), ilObject\getId(), and ilObjectLP\getInstance().

         {
                 global $ilLog;
                 
                 parent::cloneDependencies($a_target_id, $a_copy_id);
 
                 include_once('./Services/Container/classes/class.ilContainerSorting.php');
                 ilContainerSorting::_getInstance($this->getId())->cloneSorting($a_target_id,$a_copy_id);
                 
                 // fix item group references in page content
                 include_once("./Modules/ItemGroup/classes/class.ilObjItemGroup.php");
                 ilObjItemGroup::fixContainerItemGroupRefsAfterCloning($this, $a_copy_id);
                 
                 include_once('Services/Object/classes/class.ilObjectLP.php');
                 $olp = ilObjectLP::getInstance($this->getId());
                 $collection = $olp->getCollectionInstance();
                 if($collection)
                 {
                         $collection->cloneCollection($a_target_id, $a_copy_id);         
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ cloneObject()

ilContainer::cloneObject	(	$a_target_id,
		$a_copy_id = `0`
	)

Clone container settings.

public

Parameters

int	target ref_id
int	copy id

Returns: object new object

Definition at line 400 of file class.ilContainer.php.

References $file, $ilLog, ilContainerSortingSettings\_cloneSettings(), ilPageObject\_exists(), ilObjStyleSheet\_lookupStandard(), getContainerDirectory(), ilObject\getId(), ilObjectFactory\getInstanceByObjId(), and getStyleSheetId().

         {
                 global $ilLog;
 
                 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
         
                 include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                 #18624 - copy all sorting settings
                 ilContainerSortingSettings::_cloneSettings($this->getId(), $new_obj->getId());
                 
                 // copy content page
                 include_once("./Services/Container/classes/class.ilContainerPage.php");
                 if (ilContainerPage::_exists("cont",
                         $this->getId()))
                 {
                         $orig_page = new ilContainerPage($this->getId());
                         $orig_page->copy($new_obj->getId(), "cont", $new_obj->getId());                 
                 }
 
                 // #20614 - copy style
                 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                 $style_id = $this->getStyleSheetId();
                 if ($style_id > 0 &&
                         !ilObjStyleSheet::_lookupStandard($style_id))
                 {
                         $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
                         $new_id = $style_obj->ilClone();
                         $new_obj->setStyleSheetId($new_id);
                         $new_obj->update();
                 }
 
                 // #10271 - copy start objects page
                 include_once("./Services/Container/classes/class.ilContainerStartObjectsPage.php");
                 if (ilContainerStartObjectsPage::_exists("cstr",
                         $this->getId()))
                 {
                         $orig_page = new ilContainerStartObjectsPage($this->getId());
                         $orig_page->copy($new_obj->getId(), "cstr", $new_obj->getId());
                 }
                 
                 // #10271 
                 foreach(self::_getContainerSettings($this->getId()) as $keyword => $value)
                 {                                               
                         self::_writeContainerSetting($new_obj->getId(), $keyword, $value);
                         
                         // copy custom icons
                         if($keyword == "icon_custom" && 
                                 $value)
                         {
                                 // see saveIcons()
                                 $new_obj->createContainerDirectory();
                                 $tgt_dir = $new_obj->getContainerDirectory();
                                 $src_dir = $this->getContainerDirectory();                              
                                 $file = "icon_custom.svg";
                                 $src_file = $src_dir."/".$file;
                                 if(file_exists($src_file))
                                 {
                                         copy($src_file, $tgt_dir."/".$file);
                                 }
                         }
                 }
                 
                 return $new_obj;
         }

Here is the call graph for this function:

◆ create()

ilContainer::create ( )

Create.

Definition at line 792 of file class.ilContainer.php.

References $ret, ilObject\getId(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().

         {
                 $ret = parent::create();
                 
                 if (((int) $this->getStyleSheetId()) > 0)
                 {
                         include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                         ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
                 }
 
                 return $ret;
         }

Here is the call graph for this function:

◆ createContainerDirectory()

ilContainer::createContainerDirectory ( )

Create directory for the container.

It is <webspace_dir>/container_data.

Definition at line 92 of file class.ilContainer.php.

References ilObject\getId(), ilUtil\getWebspaceDir(), and ilUtil\makeDir().

Referenced by saveIcons(), and ilObjStudyProgramme\saveIcons().

         {
                 $webspace_dir = ilUtil::getWebspaceDir();
                 $cont_dir = $webspace_dir."/container_data";
                 if (!is_dir($cont_dir))
                 {
                         ilUtil::makeDir($cont_dir);
                 }
                 $obj_dir = $cont_dir."/obj_".$this->getId();
                 if (!is_dir($obj_dir))
                 {
                         ilUtil::makeDir($obj_dir);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enablePageEditing()

ilContainer::enablePageEditing ( )

Check whether page editing is allowed for container.

Definition at line 778 of file class.ilContainer.php.

References $ilSetting.

         {
                 global $ilSetting;
                 
                 // @todo: this will need a more general approach
                 if ($ilSetting->get("enable_cat_page_edit"))
                 {
                         return true;
                 }
         }

◆ getBigIconPath()

ilContainer::getBigIconPath ( )

Get path for big icon.

Returns: string icon path

Deprecated:: use _lookupIconPath instead

Definition at line 133 of file class.ilContainer.php.

References ilObject\getId().

Referenced by ilObjCategory\cloneObject(), ilObjGroup\cloneObject(), and ilObjCourse\cloneObject().

         {
                 return self::_lookupIconPath($this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompleteDescriptions()

static ilContainer::getCompleteDescriptions ( array $objects )

static

overwrites description fields to long or short description in an assoc array keys needed (obj_id and description)

Parameters

array $objects

Returns: array

Definition at line 844 of file class.ilContainer.php.

References $ilSetting, ilObject\$long_desc, ilObject\DESC_LENGTH, ilObject\getLongDescriptions(), and ilUtil\shortenText().

Referenced by ilContainerContentGUI\renderItem(), and ilContainerContentGUI\renderItemGroup().

         {
                 global $ilSetting, $ilObjDataCache;
                 // using long descriptions?
                 $short_desc = $ilSetting->get("rep_shorten_description");
                 $short_desc_max_length = $ilSetting->get("rep_shorten_description_length");
                 if(!$short_desc || $short_desc_max_length != ilObject::DESC_LENGTH)
                 {
                         // using (part of) shortened description
                         if($short_desc && $short_desc_max_length && $short_desc_max_length < ilObject::DESC_LENGTH)
                         {
                                 foreach($objects as $key => $object)
                                 {
                                         $objects[$key]["description"] = ilUtil::shortenText($object["description"], $short_desc_max_length, true);
                                 }
                         }
                         // using (part of) long description
                         else
                         {
                                 $obj_ids = array();
                                 foreach($objects as $key => $object)
                                 {
                                         $obj_ids[] = $object["obj_id"];
                                 }
                                 if(sizeof($obj_ids))
                                 {
                                         $long_desc = ilObject::getLongDescriptions($obj_ids);
                                         foreach($objects as $key => $object)
                                         {
                                                 // #12166 - keep translation, ignore long description
                                                 if($ilObjDataCache->isTranslatedDescription($object["obj_id"]))
                                                 {
                                                         $long_desc[$object["obj_id"]] = $object["description"];
                                                 }
                                                 if($short_desc && $short_desc_max_length)
                                                 {
                                                         $long_desc[$object["obj_id"]] = ilUtil::shortenText($long_desc[$object["obj_id"]], $short_desc_max_length, true);
                                                 }
                                                 $objects[$key]["description"] = $long_desc[$object["obj_id"]];
                                         }
                                 }
                         }
                 }
                 return $objects;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainerDirectory()

ilContainer::getContainerDirectory ( )

Get the container directory.

Returns: string container directory

Definition at line 112 of file class.ilContainer.php.

References _getContainerDirectory(), and ilObject\getId().

Referenced by cloneObject(), removeCustomIcon(), saveIcons(), and ilObjStudyProgramme\saveIcons().

         {
                 return $this->_getContainerDirectory($this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCustomIconPath()

ilContainer::getCustomIconPath ( )

Get path for custom icon.

Returns: string icon path

Definition at line 165 of file class.ilContainer.php.

References ilObject\getId().

         {
                 return self::_lookupIconPath($this->getId());
         }

Here is the call graph for this function:

◆ getGroupedObjTypes()

ilContainer::getGroupedObjTypes ( )

Get grouped repository object types.

Returns: array array of object types

Definition at line 764 of file class.ilContainer.php.

References ilObject\getType().

Referenced by getSubItems().

         {
                 global $objDefinition;
                 
                 if (empty($this->type_grps))
                 {
                         $this->type_grps = $objDefinition->getGroupedRepositoryObjectTypes($this->getType());
                 }
                 return $this->type_grps;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHiddenFilesFound()

ilContainer::getHiddenFilesFound ( )

Get Found hidden files (set by getSubItems).

Returns: boolean Found hidden files (set by getSubItems)

Definition at line 186 of file class.ilContainer.php.

References $hiddenfilesfound.

         {
                 return $this->hiddenfilesfound;
         }

◆ getOrderType()

ilContainer::getOrderType ( )

Get order type default implementation.

Definition at line 588 of file class.ilContainer.php.

References SORT_TITLE.

         {
                 return $this->order_type ? $this->order_type : ilContainer::SORT_TITLE;
         }

◆ getSmallIconPath()

ilContainer::getSmallIconPath ( )

Get path for small icon.

Returns: string icon path

Deprecated:: use _lookupIconPath instead

Definition at line 144 of file class.ilContainer.php.

References ilObject\getId().

Referenced by ilObjCategory\cloneObject(), ilObjGroup\cloneObject(), and ilObjCourse\cloneObject().

         {
                 return self::_lookupIconPath($this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleSheetId()

ilContainer::getStyleSheetId ( )

get ID of assigned style sheet object

Definition at line 194 of file class.ilContainer.php.

Referenced by cloneObject(), create(), and update().

         {
                 return $this->style_id;
         }

Here is the caller graph for this function:

◆ getSubItems()

ilContainer::getSubItems	(	$a_admin_panel_enabled = `false`,
		$a_include_side_block = `false`,
		$a_get_single = `0`
	)

Get subitems of container.

Parameters

bool	administration panel enabled
bool	side blocks enabled

Returns: array

Definition at line 606 of file class.ilContainer.php.

References $ilBench, $ilSetting, $ilUser, ilObject\$type, ilContainerSorting\_getInstance(), ilEventItems\_getItemsOfContainer(), ilObjFileAccess\_isFileHidden(), addAdditionalSubItemInformation(), ilObjectListGUI\CONTEXT_REPOSITORY, getGroupedObjTypes(), ilObject\getId(), ilObject\getRefId(), and setHiddenFilesFound().

         {
                 global $objDefinition, $ilBench, $tree, $ilObjDataCache, $ilUser, $rbacsystem,
                         $ilSetting;
 
                 // Caching
                 if (is_array($this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block]) &&
                         !$a_get_single)
                 {
                         return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
                 }
                 
                 $type_grps = $this->getGroupedObjTypes();
                 $objects = $tree->getChilds($this->getRefId(), "title");
 
                 $objects = self::getCompleteDescriptions($objects);
 
                 $found = false;
                 $all_ref_ids = array();
                 
                 if(!self::$data_preloaded)
                 {
                         include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                         $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);         
                 }               
 
                 include_once('Services/Container/classes/class.ilContainerSorting.php');
                 $sort = ilContainerSorting::_getInstance($this->getId());
 
                 // TODO: check this
                 // get items attached to a session
                 include_once './Modules/Session/classes/class.ilEventItems.php';
                 $event_items = ilEventItems::_getItemsOfContainer($this->getRefId());
                 
                 foreach ($objects as $key => $object)
                 {
                         if ($a_get_single > 0 && $object["child"] != $a_get_single)
                         {
                                 continue;
                         }
                         
                         // hide object types in devmode
                         if ($objDefinition->getDevMode($object["type"]) || $object["type"] == "adm"
                                 || $object["type"] == "rolf")
                         {
                                 continue;
                         }
                         
                         // remove inactive plugins
                         if ($objDefinition->isInactivePlugin($object["type"]))
                         {
                                 continue;
                         }
 
                         // BEGIN WebDAV: Don't display hidden Files, Folders and Categories
                         if (in_array($object['type'], array('file','fold','cat')))
                         {
                                 include_once 'Modules/File/classes/class.ilObjFileAccess.php';
                                 if (ilObjFileAccess::_isFileHidden($object['title']))
                                 {
                                         $this->setHiddenFilesFound(true);
                                         if (!$a_admin_panel_enabled)
                                         {
                                                 continue;
                                         }
                                 }
                         }
                         // END WebDAV: Don't display hidden Files, Folders and Categories
                         
                         // including event items!
                         if (!self::$data_preloaded)
                         {
                                 $preloader->addItem($object["obj_id"], $object["type"], $object["child"]);
                         }                       
                         
                         // filter out items that are attached to an event
                         if (in_array($object['ref_id'],$event_items))
                         {
                                 continue;
                         }
                         
                         // filter side block items
                         if(!$a_include_side_block && $objDefinition->isSideBlock($object['type']))
                         {
                                 continue;
                         }
 
                         $all_ref_ids[] = $object["child"];
                 }
                                                 
                 // data preloader
                 if (!self::$data_preloaded)
                 {
                         $preloader->preload();
                         unset($preloader);
                         
                         self::$data_preloaded = true;
                 }
                 
                 foreach($objects as $key => $object)
                 {                                       
                         // see above, objects were filtered
                         if(!in_array($object["child"], $all_ref_ids))
                         {
                                 continue;
                         }
                         
                         // group object type groups together (e.g. learning resources)
                         $type = $objDefinition->getGroupOfObj($object["type"]);
                         if ($type == "")
                         {
                                 $type = $object["type"];
                         }
                         
                         // this will add activation properties
                         $this->addAdditionalSubItemInformation($object);
                         
                         $this->items[$type][$key] = $object;
                                                 
                         $this->items["_all"][$key] = $object;
                         if ($object["type"] != "sess")
                         {
                                 $this->items["_non_sess"][$key] = $object;
                         }
                 }
                 
                 $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block]
                         = $sort->sortItems($this->items);
 
                 return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
         }

Here is the call graph for this function:

◆ getTinyIconPath()

ilContainer::getTinyIconPath ( )

Get path for tiny icon.

Returns: string icon path

Deprecated:: use _lookupIconPath instead

Definition at line 155 of file class.ilContainer.php.

References ilObject\getId().

Referenced by ilObjCategory\cloneObject(), ilObjGroup\cloneObject(), and ilObjCourse\cloneObject().

         {
                 return self::_lookupIconPath($this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getViewMode()

ilContainer::getViewMode ( )

Get container view mode.

Definition at line 580 of file class.ilContainer.php.

References VIEW_BY_TYPE.

Referenced by ilObjGroup\cloneObject(), ilObjGroup\create(), and ilObjGroup\update().

         {
                 return ilContainer::VIEW_BY_TYPE;
         }

Here is the caller graph for this function:

◆ gotItems()

ilContainer::gotItems ( )

Check whether we got any items.

Definition at line 742 of file class.ilContainer.php.

         {
                 if (is_array($this->items["_all"]) && count($this->items["_all"]) > 0)
                 {
                         return true;
                 }
                 return false;
         }

◆ ilContainer()

ilContainer::ilContainer	(	$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 81 of file class.ilContainer.php.

Referenced by ilObjStudyProgramme\__construct(), ilObjOrgUnit\__construct(), and ilObjCategory\ilObjCategory().

         {
                 parent::__construct($a_id, $a_call_by_reference);
         }

Here is the caller graph for this function:

◆ read()

ilContainer::read ( )

read

public

Parameters

Definition at line 826 of file class.ilContainer.php.

References ilContainerSortingSettings\_lookupSortMode(), ilObject\getId(), ilObjStyleSheet\lookupObjectStyle(), setOrderType(), and setStyleSheetId().

Referenced by ilObjOrgUnit\__construct().

         {
                 parent::read();
                 
                 include_once("./Services/Container/classes/class.ilContainerSortingSettings.php");
                 $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
                 
                 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                 $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeCustomIcon()

ilContainer::removeCustomIcon ( )

remove small icon

Definition at line 384 of file class.ilContainer.php.

References _writeContainerSetting(), getContainerDirectory(), and ilObject\getId().

Referenced by ilObjStudyProgramme\updateCustomIcon().

         {
                 $cont_dir = $this->getContainerDirectory();
                 $small_file_name = $cont_dir."/icon_custom.svg";
                 @unlink($small_file_name);
                 ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 0);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveIcons()

ilContainer::saveIcons ( $a_custom_icon )

save container icons

Definition at line 357 of file class.ilContainer.php.

References $ilDB, _writeContainerSetting(), createContainerDirectory(), getContainerDirectory(), ilObject\getId(), and ilUtil\moveUploadedFile().

         {
                 global $ilDB;
                 
                 $this->createContainerDirectory();
                 $cont_dir = $this->getContainerDirectory();
                 
                 $file_name = "";
                 if ($a_custom_icon != "")
                 {
                         $file_name = $cont_dir."/icon_custom.svg";
                         ilUtil::moveUploadedFile($a_custom_icon, "icon_custom.svg", $file_name);
 
                         if ($file_name != "" && is_file($file_name))
                         {
                                 ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 1);
                         }
                         else
                         {
                                 ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 0);
                         }
                 }
         }

Here is the call graph for this function:

◆ setHiddenFilesFound()

ilContainer::setHiddenFilesFound ( $a_hiddenfilesfound )

Set Found hidden files (set by getSubItems).

Parameters

boolean $a_hiddenfilesfound Found hidden files (set by getSubItems)

Definition at line 176 of file class.ilContainer.php.

Referenced by getSubItems().

         {
                 $this->hiddenfilesfound = $a_hiddenfilesfound;
         }

Here is the caller graph for this function:

◆ setOrderType()

ilContainer::setOrderType ( $a_value )

Definition at line 593 of file class.ilContainer.php.

Referenced by ilObjFolder\read(), ilObjCourse\read(), ilObjGroup\read(), and read().

         {
                 $this->order_type = $a_value;
         }

Here is the caller graph for this function:

◆ setStyleSheetId()

ilContainer::setStyleSheetId ( $a_style_id )

set ID of assigned style sheet object

Definition at line 202 of file class.ilContainer.php.

Referenced by read().

         {
                 $this->style_id = $a_style_id;
         }

Here is the caller graph for this function:

◆ update()

ilContainer::update ( )

Update.

Definition at line 808 of file class.ilContainer.php.

References $ret, ilObject\getId(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().

         {
                 $ret = parent::update();
                 
                 include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                 ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
 
                 return $ret;
         }

Here is the call graph for this function:

Field Documentation

◆ $data_preloaded

ilContainer::$data_preloaded = false

static

Definition at line 73 of file class.ilContainer.php.

◆ $hiddenfilesfound

ilContainer::$hiddenfilesfound = false

protected

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

Referenced by getHiddenFilesFound().

◆ $order_type

ilContainer::$order_type = 0

protected

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

◆ SORT_ACTIVATION

const ilContainer::SORT_ACTIVATION = 2

Definition at line 58 of file class.ilContainer.php.

Referenced by ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjCourseGUI\initEditForm(), ilContainerGUI\initManualSortingOptionForm(), ilContainerGUI\initSortingForm(), ilContainerGUI\saveSortingSettings(), ilContainerSorting\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), and ilObjCourseGUI\updateObject().

◆ SORT_CREATION

const ilContainer::SORT_CREATION = 4

Definition at line 60 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjFolderGUI\initEditCustomForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilContainerGUI\initManualSortingOptionForm(), ilContainerGUI\initSortingForm(), ilContainerGUI\saveSortingSettings(), ilContainerSorting\sortItems(), ilContainerSortingSettings\sortModeToString(), and ilContainerSorting\sortSubItems().

◆ SORT_DIRECTION_ASC

const ilContainer::SORT_DIRECTION_ASC = 0

Definition at line 62 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjStudyProgrammeGUI\afterSave(), ilContainerSortingSettings\getSortDirection(), ilContainerGUI\initSortingDirectionForm(), ilContainerSorting\sortItems(), ilContainerSorting\sortOrderDefault(), and ilContainerSorting\sortSubItems().

◆ SORT_DIRECTION_DESC

const ilContainer::SORT_DIRECTION_DESC = 1

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

Referenced by ilContainerSortingSettings\_importContainerSortingSettings(), and ilContainerGUI\initSortingDirectionForm().

◆ SORT_INHERIT

const ilContainer::SORT_INHERIT = 3

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

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_lookupSortMode(), ilContainerSortingSettings\_readSortMode(), ilObjFolderGUI\afterSave(), ilContainerSortingSettings\getInheritedSettings(), ilObjFolderGUI\initEditCustomForm(), ilObjGroupGUI\initForm(), ilContainerGUI\initSortingForm(), ilContainerSortingSettings\loadEffectiveSettings(), and ilObjGroupGUI\saveObject().

◆ SORT_MANUAL

const ilContainer::SORT_MANUAL = 1

Definition at line 57 of file class.ilContainer.php.

Referenced by ilObjCourse\__createDefaultSettings(), ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjLinkResourceGUI\activateTabs(), ilContainerGUI\addStandardRow(), ilObjStudyProgrammeGUI\afterSave(), ilObjCourse\getOrderType(), ilWebLinkXmlParser\handlerBeginTag(), ilObjFolderGUI\initEditCustomForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerGUI\initSortingForm(), ilContainerGUI\isActiveItemOrdering(), ilContainerGUI\saveSortingSettings(), ilContainerSorting\sortItems(), ilLinkResourceItems\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), ilObjLinkResource\toXML(), and ilObjLinkResourceGUI\view().

◆ SORT_NEW_ITEMS_ORDER_ACTIVATION

const ilContainer::SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Definition at line 70 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilContainerGUI\initManualSortingOptionForm(), and ilContainerSorting\sortOrderDefault().

◆ SORT_NEW_ITEMS_ORDER_CREATION

const ilContainer::SORT_NEW_ITEMS_ORDER_CREATION = 1

Definition at line 69 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjStudyProgrammeGUI\afterSave(), ilContainerGUI\initManualSortingOptionForm(), and ilContainerSorting\sortOrderDefault().

◆ SORT_NEW_ITEMS_ORDER_TITLE

const ilContainer::SORT_NEW_ITEMS_ORDER_TITLE = 0

Definition at line 68 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilContainerGUI\initManualSortingOptionForm(), and ilContainerSorting\sortOrderDefault().

◆ SORT_NEW_ITEMS_POSITION_BOTTOM

const ilContainer::SORT_NEW_ITEMS_POSITION_BOTTOM = 1

Definition at line 66 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjStudyProgrammeGUI\afterSave(), and ilContainerGUI\initManualSortingOptionForm().

◆ SORT_NEW_ITEMS_POSITION_TOP

const ilContainer::SORT_NEW_ITEMS_POSITION_TOP = 0

Definition at line 65 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_importContainerSortingSettings(), ilContainerGUI\initManualSortingOptionForm(), and ilContainerSorting\sortOrderDefault().

◆ SORT_TITLE

const ilContainer::SORT_TITLE = 0

Definition at line 56 of file class.ilContainer.php.

Referenced by ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjCategoryGUI\afterSave(), getOrderType(), ilWebLinkXmlParser\handlerBeginTag(), ilObjFolderGUI\initEditCustomForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerGUI\initManualSortingOptionForm(), ilContainerGUI\initSortingForm(), ilContainerSortingSettings\loadEffectiveSettings(), ilObjGroupGUI\saveObject(), ilContainerGUI\saveSortingSettings(), ilContainerSorting\sortItems(), ilLinkResourceItems\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), and ilObjLinkResource\toXML().

◆ VIEW_ARCHIVE

const ilContainer::VIEW_ARCHIVE = 3

Definition at line 48 of file class.ilContainer.php.

◆ VIEW_BY_TYPE

const ilContainer::VIEW_BY_TYPE = 5

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

Referenced by ilContainerGUI\getContentGUI(), ilObjWorkspaceFolder\getViewMode(), ilObjFolder\getViewMode(), getViewMode(), ilObjGroupGUI\initForm(), ilObjGroup\translateViewMode(), and ilObjCourseGUI\viewObject().

◆ VIEW_DEFAULT

const ilContainer::VIEW_DEFAULT = self::VIEW_BY_TYPE

Definition at line 53 of file class.ilContainer.php.

Referenced by ilObjGroup\getViewMode(), and ilObjGroup\translateViewMode().

◆ VIEW_INHERIT

const ilContainer::VIEW_INHERIT = 6

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

Referenced by ilObjGroupGUI\initForm(), ilObjGroupGUI\saveObject(), and ilObjGroup\translateViewMode().

◆ VIEW_OBJECTIVE

const ilContainer::VIEW_OBJECTIVE = 1

Definition at line 46 of file class.ilContainer.php.

Referenced by ilObjCourseGUI\_modifyItemGUI(), ilContainerGUI\getContentGUI(), ilObjCourseGUI\showPossibleSubObjects(), and ilObjCourseGUI\viewObject().

◆ VIEW_SESSIONS

const ilContainer::VIEW_SESSIONS = 0

Definition at line 45 of file class.ilContainer.php.

Referenced by ilContainerGUI\getContentGUI(), ilObjCourse\getSubItems(), ilObjFolder\getViewMode(), ilObjGroupGUI\initForm(), ilObjGroup\translateViewMode(), and ilObjCourseGUI\viewObject().

◆ VIEW_SIMPLE

const ilContainer::VIEW_SIMPLE = 4

Definition at line 49 of file class.ilContainer.php.

Referenced by ilContainerGUI\getContentGUI(), ilObjFolder\getViewMode(), ilObjGroupGUI\initForm(), ilObjGroup\translateViewMode(), and ilObjCourseGUI\viewObject().

◆ VIEW_TIMING

const ilContainer::VIEW_TIMING = 2

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

Referenced by ilObjCourseGUI\forwardToTimingsView(), ilObjFolderGUI\forwardToTimingsView(), and ilObjCourseGUI\viewObject().

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

Services/Container/classes/class.ilContainer.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

◆ _deleteContainerSettings()

◆ _exportContainerSettings()

◆ _getContainerDirectory()

◆ _getContainerSettings()

◆ _lookupContainerSetting()

◆ _lookupIconPath()

◆ _writeContainerSetting()

◆ addAdditionalSubItemInformation()

◆ cloneAllObject()

◆ cloneDependencies()

◆ cloneObject()

◆ create()

◆ createContainerDirectory()

◆ enablePageEditing()

◆ getBigIconPath()

◆ getCompleteDescriptions()

◆ getContainerDirectory()

◆ getCustomIconPath()

◆ getGroupedObjTypes()

◆ getHiddenFilesFound()

◆ getOrderType()

◆ getSmallIconPath()

◆ getStyleSheetId()

◆ getSubItems()

◆ getTinyIconPath()

◆ getViewMode()

◆ gotItems()

◆ ilContainer()

◆ read()

◆ removeCustomIcon()

◆ saveIcons()

◆ setHiddenFilesFound()

◆ setOrderType()

◆ setStyleSheetId()

◆ update()

Field Documentation

◆ $data_preloaded

◆ $hiddenfilesfound

◆ $order_type

◆ SORT_ACTIVATION

◆ SORT_CREATION

◆ SORT_DIRECTION_ASC

◆ SORT_DIRECTION_DESC

◆ SORT_INHERIT

◆ SORT_MANUAL

◆ SORT_NEW_ITEMS_ORDER_ACTIVATION

◆ SORT_NEW_ITEMS_ORDER_CREATION

◆ SORT_NEW_ITEMS_ORDER_TITLE

◆ SORT_NEW_ITEMS_POSITION_BOTTOM

◆ SORT_NEW_ITEMS_POSITION_TOP

◆ SORT_TITLE

◆ VIEW_ARCHIVE

◆ VIEW_BY_TYPE

◆ VIEW_DEFAULT

◆ VIEW_INHERIT

◆ VIEW_OBJECTIVE

◆ VIEW_SESSIONS

◆ VIEW_SIMPLE

◆ VIEW_TIMING