ilContainer Class Reference

Class ilContainer. More...

Inheritance diagram for ilContainer:

Collaboration diagram for ilContainer:

Public Member Functions
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	createContainerDirectory ()
	Create directory for the container.
	getContainerDirectory ()
	Get the container directory.
	_getContainerDirectory ($a_id)
	Get the container directory.
	getBigIconPath ()
	Get path for big icon.
	getSmallIconPath ()
	Get path for small icon.
	getTinyIconPath ()
	Get path for tiny icon.
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems).
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems).
	getStyleSheetId ()
	get ID of assigned style sheet object
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object
	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting.
	_writeContainerSetting ($a_id, $a_keyword, $a_value)
	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path
	saveIcons ($a_big_icon, $a_small_icon, $a_tiny_icon)
	save container icons
	removeBigIcon ()
	remove big icon
	removeSmallIcon ()
	remove small icon
	removeTinyIcon ()
	remove tiny icon
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting)
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false)
	clone all objects according to this container
	getViewMode ()
	Get container view mode.
	getOrderType ()
	Get order type default implementation.
	setOrderType ($a_value)
	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container.
	gotItems ()
	Check whether we got any items.
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g.
	getGroupedObjTypes ()
	Get grouped repository object types.
	enablePageEditing ()
	Check whether page editing is allowed for container.
	create ()
	Create.
	update ()
	Update.
	read ()
	read
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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!!
	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
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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.
	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 ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Static Public Member Functions
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB.
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course.

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_ILINC = 7
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title
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

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:

class.ilContainer.php 61077 2015-10-14 13:20:11Z gitmgr

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

Member Function Documentation

ilContainer::_getContainerDirectory

(

$a_id

)

Get the container directory.

Returns

string container directory

Definition at line 111 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:

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 191 of file class.ilContainer.php.

References DB_FETCHMODE_ASSOC.

Referenced by ilObject\_getIcon(), _lookupIconPath(), ilContainerGUI\editPageContentObject(), ilContainerGUI\editPageFrameObject(), ilContainerGUI\forwardToPageObject(), ilContainerGUI\getContainerPageHTML(), ilObjCategoryListGUI\getInfoScreenStatus(), ilObject\hasAutoRating(), ilObjCategoryGUI\ilObjCategoryGUI(), ilObjRootFolderGUI\initEditForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilContainerGUI\initStylePropertiesForm(), ilObjectListGUI\insertCommands(), ilColumnGUI\isGloballyActivated(), ilCalendarSettings\lookupCalendarActivated(), 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:

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 235 of file class.ilContainer.php.

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

Referenced by ilPDSelectedItemsBlockGUI\addParentRow(), ilShopPurchaseGUI\addStandardRow(), ilContainerGUI\addStandardRow(), ilPDSelectedItemsBlockGUI\addStandardRow(), getBigIconPath(), getSmallIconPath(), getTinyIconPath(), ilUtil\getTypeIconPath(), and ilContainerGUI\setTitleAndDescription().

        {
                if ($a_size == "")
                {
                        $a_size = "big";
                }
                
                $size = $a_size;
                
                if (ilContainer::_lookupContainerSetting($a_id, "icon_".$size))
                {
                        $cont_dir = ilContainer::_getContainerDirectory($a_id);
                        
                        // png version? (introduced with ILIAS 4.3)
                        $file_name = $cont_dir."/icon_".$a_size.".png";
                        if (is_file($file_name))
                        {
                                return $file_name;
                        }
                        
                        // gif version? (prior to ILIAS 4.3)
                        $file_name = $cont_dir."/icon_".$a_size.".gif";
                        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:

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

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

References $query, and $res.

Referenced by removeBigIcon(), removeSmallIcon(), removeTinyIcon(), saveIcons(), ilContainerGUI\savePageContentObject(), ilObjRootFolderGUI\updateObject(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), 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:

ilContainer::addAdditionalSubItemInformation

(

&

$object

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented in ilObjCourse, ilObjGroup, ilObjFolder, ilObjCategory, and ilObjRootFolder.

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

Referenced by getSubItems().

        {
        }

Here is the caller graph for this function:

ilContainer::cloneAllObject	(		$session_id,
			$client_id,
			$new_type,
			$ref_id,
			$clone_source,
			$options,
			$soap_call = false
	)

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

Returns

new refid if clone has finished or parameter ref id if cloning is still in progress

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

References $client_id, $ilErr, $ilLog, $ilUser, $options, ilObject\$ref_id, $res, ilCopyWizardOptions\_allocateCopyId(), ilSession\_duplicate(), ilCopyWizardOptions\_getInstance(), ilCopyWizardOptions\_isFinished(), ilObject\_lookupObjId(), ilObject\_lookupType(), and ilSoapFunctions\ilClone().

        {
                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);
                
                // Special handling for course in existing courses
                if($new_type == 'crs' and ilObject::_lookupType(ilObject::_lookupObjId($ref_id)) == 'crs')
                {
                        $ilLog->write(__METHOD__.': Copy course in course...');
                        $ilLog->write(__METHOD__.': 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(30);
                $soap_client->enableWSDL(true);

                $ilLog->write(__METHOD__.': Trying to call Soap client...');
                if($soap_client->init())
                {
                        $ilLog->write(__METHOD__.': Calling soap clone method...');
                        $res = $soap_client->call('ilClone',array($new_session_id.'::'.$client_id, $copy_id));
                }
                else
                {
                        $ilLog->write(__METHOD__.': SOAP 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);
                }
                // Check if copy is in progress or if this has been called by soap (don't wait for finishing)
                if($soap_call || ilCopyWizardOptions::_isFinished($copy_id))
                {
                        return $res;
                }
                else
                {
                        return $ref_id;
                }       
        }

Here is the call graph for this function:

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

Reimplemented from ilObject.

Reimplemented in ilObjCourse, ilObjGroup, and ilObjFolder.

Definition at line 426 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:

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

Reimplemented in ilObjCourse, ilObjGroup, ilObjCategory, and ilObjFolder.

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

References $ilLog, ilPageObject\_exists(), ilObject\getId(), getOrderType(), and ilContainerSortingSettings\setSortMode().

        {
                global $ilLog;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
        
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                $sorting = new ilContainerSortingSettings($new_obj->getId());
                $sorting->setSortMode($this->getOrderType());
                $sorting->update();
                
                // copy content page
//              $ilLog->write("copy container, lookup page");
                include_once("./Services/Container/classes/class.ilContainerPage.php");
                if (ilContainerPage::_exists("cont",
                        $this->getId()))
                {
                        //$ilLog->write("...page found");
                        $orig_page = new ilContainerPage($this->getId());
                        $orig_page->copy($new_obj->getId(), "cont", $new_obj->getId());
                        /*$new_page_object = new ilContainerPage();
                        $new_page_object->setParentId($new_obj->getId());
                        $new_page_object->setId($new_obj->getId());
                        $new_page_object->createFromXML();
                        $new_page_object->setXMLContent($orig_page->getXMLContent());
                        $new_page_object->buildDom(true);
                        $new_page_object->update();*/

                        //$ilLog->write("...copy ml");

                        // copy (page) multilang settings
                        /*include_once("./Services/COPage/classes/class.ilPageMultiLang.php");
                        $ml = new ilPageMultiLang("cont", $this->getId());
                        $ml->copy("cont", $new_obj->getId());*/

                }
                
                return $new_obj;
        }

Here is the call graph for this function:

ilContainer::create

(

)

Create.

Reimplemented from ilObject.

Reimplemented in ilObjGroup.

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

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

Referenced by ilObjCourse\create().

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

Here is the caller graph for this function:

ilContainer::createContainerDirectory

(

)

Create directory for the container.

It is <webspace_dir>/container_data.

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

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

Referenced by 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:

ilContainer::enablePageEditing

(

)

Check whether page editing is allowed for container.

Definition at line 732 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;
                }
        }

ilContainer::getBigIconPath

(

)

Get path for big icon.

Returns

string icon path

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

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

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

        {
                return ilContainer::_lookupIconPath($this->getId(), "big");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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 798 of file class.ilContainer.php.

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

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

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

ilContainer::getContainerDirectory

(

)

Get the container directory.

Returns

string container directory

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

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

Referenced by removeBigIcon(), removeSmallIcon(), removeTinyIcon(), and saveIcons().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainer::getGroupedObjTypes

(

)

Get grouped repository object types.

Returns

array array of object types

Definition at line 718 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:

ilContainer::getHiddenFilesFound

(

)

Get Found hidden files (set by getSubItems).

Returns

boolean Found hidden files (set by getSubItems)

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

References $hiddenfilesfound.

        {
                return $this->hiddenfilesfound;
        }

ilContainer::getOrderType

(

)

Get order type default implementation.

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

References SORT_TITLE.

Referenced by cloneObject(), ilObjCourse\cloneSettings(), and ilObjCourse\update().

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

Here is the caller graph for this function:

ilContainer::getSmallIconPath

(

)

Get path for small icon.

Returns

string icon path

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

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

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

        {
                return ilContainer::_lookupIconPath($this->getId(), "small");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainer::getStyleSheetId

(

)

get ID of assigned style sheet object

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

Referenced by create(), and update().

        {
                return $this->style_id;
        }

Here is the caller graph for this function:

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 560 of file class.ilContainer.php.

References $ilBench, $ilSetting, $ilUser, ilObject\$type, ilContainerSorting\_getInstance(), ilEventItems\_getItemsOfContainer(), ilObjFileAccess\_isFileHidden(), addAdditionalSubItemInformation(), ilObjectListGUI\CONTEXT_REPOSITORY, getCompleteDescriptions(), 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:

ilContainer::getTinyIconPath

(

)

Get path for tiny icon.

Returns

string icon path

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

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

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

        {
                return ilContainer::_lookupIconPath($this->getId(), "tiny");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainer::getViewMode

(

)

Get container view mode.

Reimplemented in ilObjCourse, ilObjFolder, and ilObjiLincCourse.

Definition at line 534 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:

ilContainer::gotItems

(

)

Check whether we got any items.

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

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

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 70 of file class.ilContainer.php.

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

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

Here is the caller graph for this function:

ilContainer::read

(

)

read

public

Parameters

@return

Reimplemented in ilObjGroup, ilObjFolder, and ilObjiLincCourse.

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

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

Referenced by ilObjCourse\read().

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

ilContainer::removeBigIcon

(

)

remove big icon

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

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

        {
                $cont_dir = $this->getContainerDirectory();
                $big_file_name = $cont_dir."/icon_big.png";
                @unlink($big_file_name);
                ilContainer::_writeContainerSetting($this->getId(), "icon_big", 0);
        }

Here is the call graph for this function:

ilContainer::removeSmallIcon

(

)

remove small icon

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

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

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

Here is the call graph for this function:

ilContainer::removeTinyIcon

(

)

remove tiny icon

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

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

        {
                $cont_dir = $this->getContainerDirectory();
                $tiny_file_name = $cont_dir."/icon_tiny.png";
                @unlink($tiny_file_name);
                ilContainer::_writeContainerSetting($this->getId(), "icon_tiny", 0);
        }

Here is the call graph for this function:

ilContainer::saveIcons	(		$a_big_icon,
			$a_small_icon,
			$a_tiny_icon
	)

save container icons

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

References _writeContainerSetting(), createContainerDirectory(), ilUtil\escapeShellArg(), ilUtil\execConvert(), getContainerDirectory(), and ilObject\getId().

        {
                global $ilDB;
                
                $this->createContainerDirectory();
                $cont_dir = $this->getContainerDirectory();
                
                // save big icon
                $big_geom = $this->ilias->getSetting("custom_icon_big_width")."x".
                        $this->ilias->getSetting("custom_icon_big_height");
                $big_file_name = $cont_dir."/icon_big.png";

                if (is_file($a_big_icon))
                {
                        $a_big_icon = ilUtil::escapeShellArg($a_big_icon);
                        $big_file_name = ilUtil::escapeShellArg($big_file_name);
                        ilUtil::execConvert($a_big_icon."[0] -geometry ".$big_geom." PNG:".$big_file_name);
                }
                if (is_file($cont_dir."/icon_big.png"))
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_big", 1);
                }
                else
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_big", 0);
                }
                // save small icon
                $small_geom = $this->ilias->getSetting("custom_icon_small_width")."x".
                        $this->ilias->getSetting("custom_icon_small_height");
                $small_file_name = $cont_dir."/icon_small.png";

                if (is_file($a_small_icon))
                {
                        $a_small_icon = ilUtil::escapeShellArg($a_small_icon);
                        $small_file_name = ilUtil::escapeShellArg($small_file_name);
                        ilUtil::execConvert($a_small_icon."[0] -geometry ".$small_geom." PNG:".$small_file_name);
                }
                if (is_file($cont_dir."/icon_small.png"))
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_small", 1);
                }
                else
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_small", 0);
                }

                // save tiny icon
                $tiny_geom = $this->ilias->getSetting("custom_icon_tiny_width")."x".
                        $this->ilias->getSetting("custom_icon_tiny_height");
                $tiny_file_name = $cont_dir."/icon_tiny.png";

                if (is_file($a_tiny_icon))
                {
                        $a_tiny_icon = ilUtil::escapeShellArg($a_tiny_icon);
                        $tiny_file_name = ilUtil::escapeShellArg($tiny_file_name);
                        ilUtil::execConvert($a_tiny_icon."[0] -geometry ".$tiny_geom." PNG:".$tiny_file_name);
                }
                if (is_file($cont_dir."/icon_tiny.png"))
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_tiny", 1);
                }
                else
                {
                        ilContainer::_writeContainerSetting($this->getId(), "icon_tiny", 0);
                }

        }

Here is the call graph for this function:

ilContainer::setHiddenFilesFound

(

$a_hiddenfilesfound

)

Set Found hidden files (set by getSubItems).

Parameters

boolean

$a_hiddenfilesfound

Found hidden files (set by getSubItems)

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

Referenced by getSubItems().

        {
                $this->hiddenfilesfound = $a_hiddenfilesfound;
        }

Here is the caller graph for this function:

ilContainer::setOrderType

(

$a_value

)

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

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

        {
                $this->order_type = $a_value;
        }

Here is the caller graph for this function:

ilContainer::setStyleSheetId

(

$a_style_id

)

set ID of assigned style sheet object

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

Referenced by read().

        {
                $this->style_id = $a_style_id;
        }

Here is the caller graph for this function:

ilContainer::update

(

)

Update.

Reimplemented from ilObject.

Reimplemented in ilObjCourse, ilObjGroup, and ilObjiLincCourse.

Definition at line 762 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

ilContainer::$data_preloaded = false

static

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

ilContainer::$hiddenfilesfound = false

protected

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

Referenced by getHiddenFilesFound().

ilContainer::$order_type = 0

protected

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

const ilContainer::SORT_ACTIVATION = 2

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

Referenced by ilCourseObjective\__getOrderColumn(), ilCourseXMLParser\handlerBeginTag(), ilObjCourseGUI\initEditForm(), ilContainerSorting\sortItems(), ilContainerSortingSettings\sortModeToString(), and ilObjCourseGUI\updateObject().

const ilContainer::SORT_INHERIT = 3

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

Referenced by ilContainerSortingSettings\_lookupSortMode(), ilContainerSortingSettings\_readSortMode(), ilObjFolderGUI\afterSave(), ilObjFolderGUI\initEditCustomForm(), ilObjGroupGUI\initForm(), ilContainerSortingSettings\lookupSortModeFromParentContainer(), and ilObjGroupGUI\saveObject().

const ilContainer::SORT_MANUAL = 1

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

Referenced by ilCourseXMLWriter\__buildSetting(), ilObjCourse\__createDefaultSettings(), ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_isManualSortingEnabled(), ilObjLinkResourceGUI\activateTabs(), ilContainerGUI\addStandardContainerSubTabs(), ilContainerGUI\addStandardRow(), ilCategoryXmlWriter\buildSorting(), ilFolderXmlParser\handlerBeginTag(), ilCourseXMLParser\handlerBeginTag(), ilWebLinkXmlParser\handlerBeginTag(), ilCategoryXmlParser\handlerBeginTag(), ilObjFolderGUI\initEditCustomForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerContentGUI\renderItem(), ilContainerObjectiveGUI\renderObjective(), ilContainerGUI\showAdministrationPanel(), ilObjRootFolderGUI\showSortingSettings(), ilLinkResourceItems\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), and ilObjLinkResource\toXML().

const ilContainer::SORT_TITLE = 0

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

Referenced by ilCourseXMLWriter\__buildSetting(), ilCourseObjective\__getOrderColumn(), ilObjCategoryGUI\afterSave(), getOrderType(), ilFolderXmlParser\handlerBeginTag(), ilCourseXMLParser\handlerBeginTag(), ilWebLinkXmlParser\handlerBeginTag(), ilCategoryXmlParser\handlerBeginTag(), ilObjFolderGUI\initEditCustomForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerSortingSettings\lookupSortModeFromParentContainer(), ilObjGroupGUI\saveObject(), ilObjRootFolderGUI\showSortingSettings(), ilContainerSorting\sortItems(), ilLinkResourceItems\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), and ilObjLinkResource\toXML().

const ilContainer::VIEW_ARCHIVE = 3

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

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

const ilContainer::VIEW_DEFAULT = self::VIEW_BY_TYPE

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

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

const ilContainer::VIEW_ILINC = 7

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

Referenced by ilContainerGUI\getContentGUI(), and ilObjiLincCourse\getViewMode().

const ilContainer::VIEW_INHERIT = 6

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

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

const ilContainer::VIEW_OBJECTIVE = 1

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

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

const ilContainer::VIEW_SESSIONS = 0

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

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

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

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