Class ilContainer. More...

Inheritance diagram for ilContainer:

Collaboration diagram for ilContainer:

Public Member Functions

__construct ($a_id=0, $a_reference=true)

Constructor @access public. More...

getObjectTranslation ()

Get object translation. More...

setObjectTranslation (ilObjectTranslation $obj_trans)

Get object translation. More...

createContainerDirectory ()

Create directory for the container. More...

getContainerDirectory ()

Get the container directory. More...

setHiddenFilesFound ($a_hiddenfilesfound)

Set Found hidden files (set by getSubItems). More...

getHiddenFilesFound ()

Get Found hidden files (set by getSubItems). More...

getStyleSheetId ()

get ID of assigned style sheet object More...

setStyleSheetId ($a_style_id)

set ID of assigned style sheet object More...

setNewsTimeline ($a_val)

Set news timeline. More...

getNewsTimeline ()

Get news timeline. More...

setNewsTimelineAutoEntries ($a_val)

Set news timeline auto entries. More...

getNewsTimelineAutoEntries ()

Get news timeline auto entries. More...

setNewsTimelineLandingPage ($a_val)

Set news timline is landing page. More...

getNewsTimelineLandingPage ()

Get news timline is landing page. More...

isNewsTimelineEffective ()

Is news timeline effective? More...

isNewsTimelineLandingPageEffective ()

Is news timeline landing page effective? More...

setNewsBlockActivated ($a_val)

Set news block activated. More...

getNewsBlockActivated ()

Get news block activated. More...

setUseNews ($a_val)

Set use news. More...

getUseNews ()

Get use news. More...

cloneDependencies ($a_target_id, $a_copy_id)

Clone object dependencies (container sorting) More...

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

clone all objects according to this container More...

delete ()

delete category and all related data More...

getViewMode ()

Get container view mode. More...

getOrderType ()

Get order type default implementation. More...

setOrderType ($a_value)

getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)

Get subitems of container. More...

gotItems ()

Check whether we got any items. More...

addAdditionalSubItemInformation (&$object)

Add additional information to sub item, e.g. More...

getGroupedObjTypes ()

Get grouped repository object types. More...

enablePageEditing ()

Check whether page editing is allowed for container. More...

create ()

Create. More...

putInTree ($a_parent_ref)

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Parameters

int $a_parent_ref Ref-ID of the parent object

More...

update ()

Update. More...

read ()

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.

Constructor & Destructor Documentation

◆ __construct()

ilContainer::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

Constructor @access public.

Parameters

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

Reimplemented from ilObject.

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

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->log = $DIC["ilLog"];
        $this->access = $DIC->access();
        $this->error = $DIC["ilErr"];
        $this->rbacsystem = $DIC->rbac()->system();
        $this->tree = $DIC->repositoryTree();
        $this->user = $DIC->user();
        $this->obj_definition = $DIC["objDefinition"];
 
 
        $this->setting = $DIC["ilSetting"];
        parent::__construct($a_id, $a_reference);
        include_once("./Services/Object/classes/class.ilObjectTranslation.php");
 
        if ($this->getId() > 0) {
            $this->obj_trans = ilObjectTranslation::getInstance($this->getId());
        }
    }

References $DIC, error(), ilObject\getId(), ilObjectTranslation\getInstance(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ _deleteContainerSettings()

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

static

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        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);
    }

References $DIC, and $ilDB.

Referenced by ilObjectTileImage\copy(), ilObjectTileImage\delete(), ilObjectCustomIconImpl\delete(), ilObjCategoryGUI\getObjectMetadataGUI(), ilObjectTileImage\persistImageState(), and ilObjCategoryGUI\updateObject().

Here is the caller graph for this function:

◆ _exportContainerSettings()

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

static

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getContainerDirectory()

static ilContainer::_getContainerDirectory ( $a_id )

static

Get the container directory.

Returns: string container directory

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

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

References ilUtil\getWebspaceDir().

Referenced by getContainerDirectory().

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $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;
    }

References $DIC, $ilDB, $res, and $row.

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

Here is the caller graph for this function:

◆ _lookupContainerSetting()

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

static

Lookup a container setting.

Parameters

int	container id
string	setting keyword

Returns: string setting value

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $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(ilDBConstants::FETCHMODE_ASSOC);
        
        if (isset($rec['value'])) {
            return $rec["value"];
        }
        if ($a_default_value === null) {
            return '';
        }
        return $a_default_value;
    }

References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjCategoryGUI\__construct(), ilObjContentPageGUI\__construct(), ilContSkillMemberTableGUI\__construct(), ilContainerByTypeContentGUI\__construct(), ilContainerContentGUI\__construct(), ilObjectTileImage\__construct(), ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilLocatorGUI\addRepositoryItems(), ilObjectCommonSettingFormAdapter\addTitleIconVisibility(), ilObjectCommonSettingFormAdapter\addTopActionsVisibility(), ilObjSession\cloneSettings(), ilContainerGUI\editPageContentObject(), ilContainerGUI\editPageFrameObject(), ilObjectTileImage\exists(), ilObjectCustomIconImpl\exists(), ilIndividualAssessmentSettingsGUI\fillForm(), ilContSkillMemberTableGUI\fillRow(), ilContainerGUI\forwardToPageObject(), ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), ilContainerGUI\getContainerPageHTML(), ilObjCategoryListGUI\getInfoScreenStatus(), ilObjContentPageListGUI\getInfoScreenStatus(), ilObjCategoryGUI\getObjectMetadataGUI(), ilTaxMDGUI\getSelectableTaxonomies(), ilObjCategoryGUI\getTabs(), ilObjCourseGUI\getTabs(), ilObjGroupGUI\getTabs(), ilObjectMetaDataGUI\hasAdvancedMDSettings(), ilObject\hasAutoRating(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilContainerGUI\initListPresentationForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilContSkillAdminGUI\initSettingsForm(), ilContainerGUI\initStylePropertiesForm(), ilObjectListGUI\insertCommands(), ilObjectGUI\insertHeaderAction(), ilTaggingClassificationProvider\isActive(), ilColumnGUI\isGloballyActivated(), ilBadgeHandler\isObjectActive(), ilCalendarSettings\lookupCalendarActivated(), ilContSkillAdminGUI\saveCompetenceAssignment(), ilContainerGUI\savePageContentObject(), ilObjCategoryGUI\setEditTabs(), ilObjRootFolderGUI\setTitleAndDescription(), ilContainerGUI\setTitleAndDescription(), and ilAdvancedMDRecordObjectOrderings\sortRecords().

Here is the caller graph for this function:

◆ _writeContainerSetting()

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

static

Parameters

$a_id
$a_keyword
$a_value

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "DELETE FROM container_settings WHERE " .
            "id = " . $ilDB->quote($a_id, 'integer') . " " .
            "AND keyword = " . $ilDB->quote($a_keyword, 'text');
        $res = $ilDB->manipulate($query);
 
        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("Write container setting, id: " . $a_id . ", keyword: " . $a_keyword . ", value: " . $a_value);
 
        $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);
    }

References $DIC, $ilDB, $log, $query, $res, and ilLoggerFactory\getLogger().

Referenced by ilObjSession\cloneSettings(), ilObjectTileImage\copy(), ilObjectCustomIconImpl\copy(), create(), ilObjectTileImage\createFromImportDir(), ilObjCategoryGUI\getObjectMetadataGUI(), ilCategoryXmlParser\handlerEndTag(), ilCourseXMLParser\handlerEndTag(), ilGroupXMLParser\handlerEndTag(), ilContentPageDataSet\importRecord(), ilObjectDataSet\importRecord(), ilAdvancedMetaDataImporter\importXmlRepresentation(), ilObjectCustomIconImpl\persistIconState(), ilObjectTileImage\persistImageState(), putInTree(), ilObjectCustomIconImpl\remove(), ilContainerGUI\saveListPresentation(), ilContainerGUI\savePageContentObject(), ilContSkillAdminGUI\saveSettings(), ilObjectCommonSettingFormAdapter\saveTitleIconVisibility(), ilObjectCommonSettingFormAdapter\saveTopActionsVisibility(), update(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), ilObjectServiceSettingsGUI\updateToolSettings(), and ilContainerGUI\useNewEditorObject().

Here is the call graph for this function:

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.

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

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

861 {

862 }

Referenced by getSubItems().

Here is the caller graph for this function:

◆ addTranslation()

ilContainer::addTranslation	(	$a_title,
		$a_desc,
		$a_lang,
		$a_lang_default
	)

Add translation.

Parameters

$a_title
$a_desc
$a_lang
$a_lang_default

Returns: bool

Reimplemented in ilObjOrgUnit, and ilObjRootFolder.

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

    {
        if (empty($a_title)) {
            $a_title = "NO TITLE";
        }
 
        $this->obj_trans->addLanguage($a_lang, $a_title, $a_desc, $a_lang_default, true);
        $this->obj_trans->save();
 
        return true;
    }

Referenced by create().

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

    {
        $ilLog = $this->log;
        
        include_once('./Services/Link/classes/class.ilLink.php');
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
        
        $ilAccess = $this->access;
        $ilErr = $this->error;
        $rbacsystem = $this->rbacsystem;
        $tree = $this->tree;
        $ilUser = $this->user;
            
        // 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
        );
    }

References $access, $client_id, $error, $ilErr, $ilLog, $ilUser, $log, PHPMailer\PHPMailer\$options, $rbacsystem, ilObject\$ref_id, $res, $tree, $user, ilCopyWizardOptions\_allocateCopyId(), ilSession\_duplicate(), ilCopyWizardOptions\_getInstance(), ilLoggerFactory\getLogger(), ilSoapFunctions\ilClone(), and ilObjectCopyGUI\SUBMODE_CONTENT_ONLY.

Here is the call graph for this function:

◆ cloneDependencies()

ilContainer::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone object dependencies (container sorting)

@access public

Parameters

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

Reimplemented from ilObject.

Reimplemented in ilObjCategory, ilObjCourse, ilObjFolder, and ilObjGroup.

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

    {
        $ilLog = $this->log;
        
        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 internal links to other objects
        ilContainer::fixInternalLinksAfterCopy($a_target_id, $a_copy_id, $this->getRefId());
        
        // 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;
    }

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

Here is the call graph for this function:

◆ create()

ilContainer::create ( )

Create.

Reimplemented from ilObject.

Reimplemented in ilObjGroup, ilObjLearningSequence, ilObjOrgUnit, and ilObjStudyProgramme.

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

    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $ret = parent::create();
 
        // set translation object, since we have an object id now
        $this->obj_trans = ilObjectTranslation::getInstance($this->getId());
 
        // add default translation
        $this->addTranslation(
            $this->getTitle(),
            $this->getDescription(),
            $lng->getDefaultLanguage(),
            true
        );
 
        if (((int) $this->getStyleSheetId()) > 0) {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
        }
 
        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("Create Container, id: " . $this->getId());
 
        self::_writeContainerSetting($this->getId(), "news_timeline", (int) $this->getNewsTimeline());
        self::_writeContainerSetting($this->getId(), "news_timeline_incl_auto", (int) $this->getNewsTimelineAutoEntries());
        self::_writeContainerSetting($this->getId(), "news_timeline_landing_page", (int) $this->getNewsTimelineLandingPage());
        include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::NEWS_VISIBILITY, (int) $this->getNewsBlockActivated());
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, (int) $this->getUseNews());
 
        return $ret;
    }

References $DIC, ilObject\$lng, $log, $ret, _writeContainerSetting(), addTranslation(), ilObject\getDescription(), ilObject\getId(), ilObjectTranslation\getInstance(), ilLoggerFactory\getLogger(), getNewsBlockActivated(), getNewsTimeline(), getNewsTimelineAutoEntries(), getNewsTimelineLandingPage(), getStyleSheetId(), ilObject\getTitle(), getUseNews(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ilObjectServiceSettingsGUI\USE_NEWS, and ilObjStyleSheet\writeStyleUsage().

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

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

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

Here is the call graph for this function:

◆ delete()

ilContainer::delete ( )

delete category and all related data

Returns: boolean true if all object data were removed; false if only a references were removed

Reimplemented in ilObjCategory, ilObjCourse, ilObjGroup, ilObjLearningSequence, ilObjOrgUnit, ilObjRootFolder, and ilObjStudyProgramme.

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

    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
        // delete translations
        $this->obj_trans->delete();
 
        return true;
    }

◆ deleteTranslation()

ilContainer::deleteTranslation ( $a_lang )

Delete translation.

Parameters

$a_lang

Reimplemented in ilObjOrgUnit, and ilObjRootFolder.

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

    {
        $this->obj_trans->removeLanguage($a_lang);
        $this->obj_trans->save();
    }

◆ enablePageEditing()

ilContainer::enablePageEditing ( )

Check whether page editing is allowed for container.

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

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

References $ilSetting, and $setting.

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

    {
        global $DIC;
 
        $ilSetting = $DIC->settings();
        $ilObjDataCache = $DIC["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;
    }

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

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

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

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

References _getContainerDirectory(), and ilObject\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 869 of file class.ilContainer.php.

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

References $obj_definition, ilObject\$objDefinition, and ilObject\getType().

Referenced by getSubItems().

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

    {
        return $this->hiddenfilesfound;
    }

References $hiddenfilesfound.

◆ getNewsBlockActivated()

ilContainer::getNewsBlockActivated ( )

Get news block activated.

Returns: bool news block activated

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

    {
        return $this->news_block_activated;
    }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getNewsTimeline()

ilContainer::getNewsTimeline ( )

Get news timeline.

Returns: bool activate news timeline

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

    {
        return $this->news_timeline;
    }

References $news_timeline.

Referenced by create(), isNewsTimelineEffective(), isNewsTimelineLandingPageEffective(), and update().

Here is the caller graph for this function:

◆ getNewsTimelineAutoEntries()

ilContainer::getNewsTimelineAutoEntries ( )

Get news timeline auto entries.

Returns: bool include automatically created entries

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

    {
        return $this->news_timeline_auto_entries;
    }

References $news_timeline_auto_entries.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getNewsTimelineLandingPage()

ilContainer::getNewsTimelineLandingPage ( )

Get news timline is landing page.

Returns: bool is news timline landing page?

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

    {
        return $this->news_timeline_landing_page;
    }

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

Here is the caller graph for this function:

◆ getObjectTranslation()

ilContainer::getObjectTranslation ( )

Get object translation.

Returns: ilObjectTranslation

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

    {
        return $this->obj_trans;
    }

References $obj_trans.

Referenced by update().

Here is the caller graph for this function:

◆ getOrderType()

ilContainer::getOrderType ( )

Get order type default implementation.

Reimplemented in ilObjCourse.

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

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

References SORT_TITLE.

◆ getStyleSheetId()

ilContainer::getStyleSheetId ( )

get ID of assigned style sheet object

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

    {
        return $this->style_id;
    }

Referenced by create(), and update().

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

Reimplemented in ilObjCourse.

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

    {
        $objDefinition = $this->obj_definition;
        $tree = $this->tree;
 
        // 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];
    }

References $key, $obj_definition, ilObject\$objDefinition, $tree, ilObject\$type, ilContainerSorting\_getInstance(), ilEventItems\_getItemsOfContainer(), ilObjFileAccess\_isFileHidden(), addAdditionalSubItemInformation(), ilObjectListGUI\CONTEXT_REPOSITORY, getCompleteDescriptions(), getGroupedObjTypes(), ilObject\getId(), ilObject\getRefId(), and setHiddenFilesFound().

Here is the call graph for this function:

◆ getUseNews()

ilContainer::getUseNews ( )

Get use news.

Returns: bool use news system?

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

    {
        return $this->use_news;
    }

Referenced by create(), isNewsTimelineEffective(), isNewsTimelineLandingPageEffective(), and update().

Here is the caller graph for this function:

◆ getViewMode()

ilContainer::getViewMode ( )

Get container view mode.

Reimplemented in ilObjCourse, ilObjFolder, and ilObjGroup.

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

    {
        return ilContainer::VIEW_BY_TYPE;
    }

References VIEW_BY_TYPE.

◆ gotItems()

ilContainer::gotItems ( )

Check whether we got any items.

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

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

◆ isNewsTimelineEffective()

ilContainer::isNewsTimelineEffective ( )

Is news timeline effective?

Returns: bool

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

    {
        if ($this->getUseNews()) {
            if ($this->getNewsTimeline()) {
                return true;
            }
        }
        return false;
    }

References getNewsTimeline(), and getUseNews().

Here is the call graph for this function:

◆ isNewsTimelineLandingPageEffective()

ilContainer::isNewsTimelineLandingPageEffective ( )

Is news timeline landing page effective?

Returns: bool

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

    {
        if ($this->getUseNews()) {
            if ($this->getNewsTimeline()) {
                if ($this->getNewsTimelineLandingPage()) {
                    return true;
                }
            }
        }
        return false;
    }

References getNewsTimeline(), getNewsTimelineLandingPage(), and getUseNews().

Here is the call graph for this function:

◆ putInTree()

ilContainer::putInTree ( $a_parent_ref )

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Parameters

int $a_parent_ref Ref-ID of the parent object

Reimplemented from ilObject.

Reimplemented in ilObjFolder, and ilObjStudyProgramme.

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

    {
        parent::putInTree($a_parent_ref);
 
        // copy title, icon actions visibilities
        if (self::_lookupContainerSetting(ilObject::_lookupObjId($a_parent_ref), "hide_header_icon_and_title")) {
            self::_writeContainerSetting($this->getId(), "hide_header_icon_and_title", true);
        }
        if (self::_lookupContainerSetting(ilObject::_lookupObjId($a_parent_ref), "hide_top_actions")) {
            self::_writeContainerSetting($this->getId(), "hide_top_actions", true);
        }
    }

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

Here is the call graph for this function:

◆ read()

ilContainer::read ( )

read

@access public

Parameters

return

Reimplemented from ilObject.

Reimplemented in ilObjCourse, ilObjFolder, ilObjGroup, ilObjLearningSequence, and ilObjStudyProgramme.

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

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

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

Here is the call graph for this function:

◆ readContainerSettings()

ilContainer::readContainerSettings ( )

Read container settings.

Parameters

return

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

    {
        $this->setNewsTimeline(self::_lookupContainerSetting($this->getId(), "news_timeline"));
        $this->setNewsTimelineAutoEntries(self::_lookupContainerSetting($this->getId(), "news_timeline_incl_auto"));
        $this->setNewsTimelineLandingPage(self::_lookupContainerSetting($this->getId(), "news_timeline_landing_page"));
        include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
        $this->setNewsBlockActivated(self::_lookupContainerSetting(
            $this->getId(),
            ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
            $this->setting->get('block_activated_news', true)
        ));
        $this->setUseNews(self::_lookupContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, true));
    }

References ilObject\getId(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, setNewsBlockActivated(), setNewsTimeline(), setNewsTimelineAutoEntries(), setNewsTimelineLandingPage(), setUseNews(), and ilObjectServiceSettingsGUI\USE_NEWS.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeTranslations()

ilContainer::removeTranslations ( )

Remove all translations of container.

Reimplemented in ilObjOrgUnit, and ilObjRootFolder.

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

    {
        $this->obj_trans->delete();
    }

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

    {
        $this->hiddenfilesfound = $a_hiddenfilesfound;
    }

Referenced by getSubItems().

Here is the caller graph for this function:

◆ setNewsBlockActivated()

ilContainer::setNewsBlockActivated ( $a_val )

Set news block activated.

Parameters

bool $a_val news block activated

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

    {
        $this->news_block_activated = $a_val;
    }

Referenced by readContainerSettings().

Here is the caller graph for this function:

◆ setNewsTimeline()

ilContainer::setNewsTimeline ( $a_val )

Set news timeline.

Parameters

bool $a_val activate news timeline

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

    {
        $this->news_timeline = $a_val;
    }

Referenced by readContainerSettings().

Here is the caller graph for this function:

◆ setNewsTimelineAutoEntries()

ilContainer::setNewsTimelineAutoEntries ( $a_val )

Set news timeline auto entries.

Parameters

bool $a_val include automatically created entries

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

    {
        $this->news_timeline_auto_entries = $a_val;
    }

Referenced by readContainerSettings().

Here is the caller graph for this function:

◆ setNewsTimelineLandingPage()

ilContainer::setNewsTimelineLandingPage ( $a_val )

Set news timline is landing page.

Parameters

bool $a_val is news timline landing page?

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

    {
        $this->news_timeline_landing_page = $a_val;
    }

Referenced by readContainerSettings().

Here is the caller graph for this function:

◆ setObjectTranslation()

ilContainer::setObjectTranslation ( ilObjectTranslation $obj_trans )

Get object translation.

Parameters

ilObjectTranslation $obj_trans

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

    {
        $this->obj_trans = $obj_trans;
    }

References $obj_trans.

◆ setOrderType()

ilContainer::setOrderType ( $a_value )

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

    {
        $this->order_type = $a_value;
    }

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

Here is the caller graph for this function:

◆ setStyleSheetId()

ilContainer::setStyleSheetId ( $a_style_id )

set ID of assigned style sheet object

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

    {
        $this->style_id = $a_style_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setUseNews()

ilContainer::setUseNews ( $a_val )

Set use news.

Parameters

bool $a_val use news system?

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

    {
        $this->use_news = $a_val;
    }

Referenced by readContainerSettings().

Here is the caller graph for this function:

◆ update()

ilContainer::update ( )

Update.

Reimplemented from ilObject.

Reimplemented in ilObjCourse, ilObjGroup, ilObjLearningSequence, ilObjOrgUnit, and ilObjStudyProgramme.

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

    {
        $ret = parent::update();
 
        $trans = $this->getObjectTranslation();
        $trans->setDefaultTitle($this->getTitle());
        $trans->setDefaultDescription($this->getLongDescription());
        $trans->save();
 
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
 
        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("Update Container, id: " . $this->getId());
 
        self::_writeContainerSetting($this->getId(), "news_timeline", (int) $this->getNewsTimeline());
        self::_writeContainerSetting($this->getId(), "news_timeline_incl_auto", (int) $this->getNewsTimelineAutoEntries());
        self::_writeContainerSetting($this->getId(), "news_timeline_landing_page", (int) $this->getNewsTimelineLandingPage());
        include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::NEWS_VISIBILITY, (int) $this->getNewsBlockActivated());
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, (int) $this->getUseNews());
 
        return $ret;
    }

References $log, $ret, _writeContainerSetting(), ilObject\getId(), ilLoggerFactory\getLogger(), ilObject\getLongDescription(), getNewsBlockActivated(), getNewsTimeline(), getNewsTimelineAutoEntries(), getNewsTimelineLandingPage(), getObjectTranslation(), getStyleSheetId(), ilObject\getTitle(), getUseNews(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, League\Flysystem\Adapter\Polyfill\update(), ilObjectServiceSettingsGUI\USE_NEWS, and ilObjStyleSheet\writeStyleUsage().

Here is the call graph for this function:

Field Documentation

◆ $access

ilContainer::$access

protected

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

Referenced by cloneAllObject(), ilObjFolder\downloadFolder(), and ilObjCourse\getSubItems().

◆ $data_preloaded

ilContainer::$data_preloaded = false

static

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

◆ $db

ilContainer::$db

protected

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

Referenced by ilObjCategory\delete(), ilObjLearningSequence\deletePostConditionsForSubObjects(), ilObjLearningSequence\getCurrentItemForLearner(), ilObjLearningSequence\getGlobalSettings(), ilObjLearningSequence\getLSItems(), ilObjLearningSequence\getLSLearnerItems(), and ilObjLearningSequence\storeLSItems().

◆ $error

ilContainer::$error

protected

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

Referenced by cloneAllObject(), and ilObjCourse\validateInfoSettings().

◆ $hiddenfilesfound

ilContainer::$hiddenfilesfound = false

protected

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

Referenced by getHiddenFilesFound().

◆ $log

ilContainer::$log

protected

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

Referenced by _writeContainerSetting(), cloneAllObject(), cloneDependencies(), create(), and update().

◆ $news_timeline

ilContainer::$news_timeline = false

protected

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

Referenced by getNewsTimeline().

◆ $news_timeline_auto_entries

ilContainer::$news_timeline_auto_entries = false

protected

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

Referenced by getNewsTimelineAutoEntries().

◆ $obj_definition

ilObjectDefinition ilContainer::$obj_definition

protected

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

Referenced by getGroupedObjTypes(), and getSubItems().

◆ $obj_trans

ilContainer::$obj_trans = null

protected

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

Referenced by getObjectTranslation(), and setObjectTranslation().

◆ $order_type

ilContainer::$order_type = 0

protected

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

◆ $rbacsystem

ilContainer::$rbacsystem

protected

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

Referenced by cloneAllObject(), ilObjGroup\initGroupStatus(), and ilObjGroup\readGroupStatus().

◆ $setting

ilContainer::$setting

protected

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

Referenced by enablePageEditing().

◆ $tree

ilContainer::$tree

protected

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

Referenced by ilObjGroup\__construct(), cloneAllObject(), ilObjGroup\cloneDependencies(), ilObjCourse\findCoursesWithNotEnoughMembers(), ilObjGroup\findGroupsWithNotEnoughMembers(), getSubItems(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilObjFolder\putInTree(), ilObjFolder\read(), ilObjFolder\recurseFolder(), ilObjCourse\register(), and ilObjGroup\translateViewMode().

◆ $user

ilContainer::$user

protected

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

Referenced by cloneAllObject().

◆ SORT_ACTIVATION

const ilContainer::SORT_ACTIVATION = 2

Definition at line 100 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 102 of file class.ilContainer.php.

Referenced by ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilObjRootFolderGUI\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 104 of file class.ilContainer.php.

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

◆ SORT_DIRECTION_DESC

const ilContainer::SORT_DIRECTION_DESC = 1

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

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

◆ SORT_INHERIT

const ilContainer::SORT_INHERIT = 3

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

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

◆ SORT_MANUAL

const ilContainer::SORT_MANUAL = 1

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

Referenced by ilObjCourse\__createDefaultSettings(), ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjLinkResourceGUI\activateTabs(), ilObjStudyProgrammeGUI\afterSave(), ilObjLearningSequenceGUI\afterSave(), ilLSItemsDB\getLSItems(), ilObjCourse\getOrderType(), ilWebLinkXmlParser\handlerBeginTag(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerGUI\initSortingForm(), ilContainerGUI\isActiveItemOrdering(), ilContainerGUI\saveSortingSettings(), ilLinkResourceItems\sortItems(), ilContainerSorting\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 112 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 111 of file class.ilContainer.php.

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

◆ SORT_NEW_ITEMS_ORDER_TITLE

const ilContainer::SORT_NEW_ITEMS_ORDER_TITLE = 0

Definition at line 110 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 108 of file class.ilContainer.php.

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

◆ SORT_NEW_ITEMS_POSITION_TOP

const ilContainer::SORT_NEW_ITEMS_POSITION_TOP = 0

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

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

◆ SORT_TITLE

const ilContainer::SORT_TITLE = 0

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

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

◆ VIEW_ARCHIVE

const ilContainer::VIEW_ARCHIVE = 3

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

◆ VIEW_BY_TYPE

const ilContainer::VIEW_BY_TYPE = 5

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

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

◆ VIEW_DEFAULT

const ilContainer::VIEW_DEFAULT = self::VIEW_BY_TYPE

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

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

◆ VIEW_INHERIT

const ilContainer::VIEW_INHERIT = 6

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

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

◆ VIEW_OBJECTIVE

const ilContainer::VIEW_OBJECTIVE = 1

Definition at line 88 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 87 of file class.ilContainer.php.

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

◆ VIEW_SIMPLE

const ilContainer::VIEW_SIMPLE = 4

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

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

◆ VIEW_TIMING

const ilContainer::VIEW_TIMING = 2

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

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

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

Services/Container/classes/class.ilContainer.php

Static Public Member Functions
static	_getContainerDirectory ($a_id)
	Get the container directory. More...

static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...

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

static	_getContainerSettings ($a_id)

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

static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)

static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

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

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

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

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

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

	$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

Protected Attributes
	$db

	$log

	$access

	$error

	$rbacsystem

	$tree

	$user

	$obj_definition

	$order_type = 0

	$hiddenfilesfound = false

	$news_timeline = false

	$news_timeline_auto_entries = false

	$setting

	$obj_trans = null

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteContainerSettings()

◆ _exportContainerSettings()

◆ _getContainerDirectory()

◆ _getContainerSettings()

◆ _lookupContainerSetting()

◆ _writeContainerSetting()

◆ addAdditionalSubItemInformation()

◆ addTranslation()

◆ cloneAllObject()

◆ cloneDependencies()

◆ create()

◆ createContainerDirectory()

◆ delete()

◆ deleteTranslation()

◆ enablePageEditing()

◆ getCompleteDescriptions()

◆ getContainerDirectory()

◆ getGroupedObjTypes()

◆ getHiddenFilesFound()

◆ getNewsBlockActivated()

◆ getNewsTimeline()

◆ getNewsTimelineAutoEntries()

◆ getNewsTimelineLandingPage()

◆ getObjectTranslation()

◆ getOrderType()

◆ getStyleSheetId()

◆ getSubItems()

◆ getUseNews()

◆ getViewMode()

◆ gotItems()

◆ isNewsTimelineEffective()

◆ isNewsTimelineLandingPageEffective()

◆ putInTree()

◆ read()

◆ readContainerSettings()

◆ removeTranslations()

◆ setHiddenFilesFound()

◆ setNewsBlockActivated()

◆ setNewsTimeline()

◆ setNewsTimelineAutoEntries()

◆ setNewsTimelineLandingPage()

◆ setObjectTranslation()

◆ setOrderType()

◆ setStyleSheetId()

◆ setUseNews()

◆ update()

Field Documentation

◆ $access

◆ $data_preloaded

◆ $db

◆ $error

◆ $hiddenfilesfound

◆ $log

◆ $news_timeline

◆ $news_timeline_auto_entries

◆ $obj_definition

◆ $obj_trans

◆ $order_type

◆ $rbacsystem

◆ $setting

◆ $tree

◆ $user

◆ 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