ilContainer Class Reference

Class ilContainer. More...

Inheritance diagram for ilContainer:

Collaboration diagram for ilContainer:

Public Member Functions
	getTileSizes ()
	getObjectTranslation ()
	setObjectTranslation (?Translations $obj_trans)
	createContainerDirectory ()
	getContainerDirectory ()
	setHiddenFilesFound (bool $a_hiddenfilesfound)
	getHiddenFilesFound ()
	getStyleSheetId ()
	setStyleSheetId (int $a_style_id)
	setNewsTimeline (bool $a_val)
	getNewsTimeline ()
	setNewsTimelineAutoEntries (bool $a_val)
	getNewsTimelineAutoEntries ()
	setNewsTimelineLandingPage (bool $a_val)
	getNewsTimelineLandingPage ()
	isNewsTimelineEffective ()
	isNewsTimelineLandingPageEffective ()
	setNewsBlockActivated (bool $a_val)
	getNewsBlockActivated ()
	setUseNews (bool $a_val)
	getUseNews ()
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)
	delete ()
	delete category and all related data More...
	getViewMode ()
	getOrderType ()
	setOrderType (int $a_value)
	isClassificationFilterActive ()
	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...
	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ?ilContainerUserFilter $container_user_filter=null)
	gotItems ()
	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	enablePageEditing ()
	create ()
	putInTree (int $parent_ref_id)
	update ()
	read ()
	readContainerSettings ()
	removeTranslations ()
	deleteTranslation (string $a_lang)
	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getContainerDirectory (int $a_id)
static	_lookupContainerSetting (int $a_id, string $a_keyword, ?string $a_default_value=null)
static	_hasContainerSetting (int $a_id, string $a_keyword)
static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)
static	_getContainerSettings (int $a_id)
static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, int $a_obj_id)
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

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
const	TILE_NORMAL = 0
const	TILE_SMALL = 1
const	TILE_LARGE = 2
const	TILE_EXTRA_LARGE = 3
const	TILE_FULL = 4
array	$items = []
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Static Public Attributes
static bool	$data_preloaded = false

Protected Member Functions
	getInitialSubitems ()
	applyContainerUserFilter (array $objects, ?ilContainerUserFilter $container_user_filter=null)
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
News	$news
ILIAS Style Content DomainService	$content_style_domain
ILIAS Container InternalDomainService	$domain
ilAccessHandler	$access
ilRbacSystem	$rbacsystem
ilObjUser	$user
ilObjectDefinition	$obj_definition
int	$order_type = 0
bool	$hiddenfilesfound = false
bool	$news_timeline = false
bool	$news_timeline_auto_entries = false
ilSetting	$setting
Translations	$obj_trans = null
int	$style_id = 0
bool	$news_timeline_landing_page = false
bool	$news_block_activated = false
bool	$use_news = false
ilRecommendedContentManager	$recommended_content_manager
array	$type_grps = null
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

Class ilContainer.

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

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

_deleteContainerSettings()

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

static

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

References $DIC, and $ilDB.

Referenced by ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\delete(), ilObjCategoryGUI\hideTaxAsSideBlockObject(), and ilObjCategoryGUI\updateObject().

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

Here is the caller graph for this function:

_exportContainerSettings()

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

static

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

References ilObject\$log, ilContainerSortingSettings\_cloneSettings(), ilPageObject\_exists(), ilBlockSetting\cloneSettingsOfBlock(), ilLogger\debug(), ilObject\getId(), ilLoggerFactory\getLogger(), getNewsBlockActivated(), getNewsTimeline(), getNewsTimelineAutoEntries(), getNewsTimelineLandingPage(), ilObject\getObjectProperties(), ilObject\getRefId(), getUseNews(), ilXmlWriter\xmlData(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

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

     : void {
        // container settings
        $settings = self::_getContainerSettings($a_obj_id);
        if (count($settings)) {
            $a_xml->xmlStartTag("ContainerSettings");

            foreach ($settings as $keyword => $value) {
                // :TODO: proper custom icon export/import
                if (
                    stripos($keyword, "icon") !== false
                    && $keyword !== 'hide_header_icon_and_title'
                ) {
                    continue;
                }

                $a_xml->xmlStartTag(
                    'ContainerSetting',
                    [
                        'id' => $keyword,
                    ]
                );

                $a_xml->xmlData((string) $value);
                $a_xml->xmlEndTag("ContainerSetting");
            }

            $a_xml->xmlEndTag("ContainerSettings");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getContainerDirectory()

static ilContainer::_getContainerDirectory ( int  $a_id )

static

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

References ilFileUtils\getWebspaceDir().

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

Here is the call graph for this function:

_getContainerSettings()

static ilContainer::_getContainerSettings ( int  $a_id )

static

Parameters

int

$a_id

Returns

array<string, string>

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

References $DIC, $ilDB, and $res.

Referenced by ilObjPortfolioBase\cloneBasics(), ilObjCategoryGUI\getActiveBlocks(), ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), and ilObjExercise\saveData().

                                                           : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = [];

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

        return $res;
    }

Here is the caller graph for this function:

_hasContainerSetting()

static ilContainer::_hasContainerSetting ( int  $a_id, string  $a_keyword  )

static

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

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

Referenced by ilObjectDataSet\getTypes().

     : string {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT value 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);

        return (bool) $rec;
    }

Here is the caller graph for this function:

_lookupContainerSetting()

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

static

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

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

Referenced by ilObjCategoryGUI\__construct(), ILIAS\UI\Component\Legacy\Content\ItemBlock\ItemBlockSequenceGenerator\__construct(), ilObjContentPageGUI\__construct(), ilAdvancedMDRecord\_getSelectedRecordsByObject(), ILIAS\Container\Skills\ContSkillMemberTableBuilder\activeAction(), ILIAS\Repository\Form\addAdditionalFeatures(), ilLocatorGUI\addRepositoryItems(), ILIAS\UI\Component\Legacy\Content\ItemSetManager\applyUserFilter(), ILIAS\Container\Skills\ContSkillMemberTableBuilder\build(), ilObjWiki\cloneObject(), ilObjSession\cloneSettings(), ilObjContentPage\doCloneObject(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\exists(), ilMailMemberSearchGUI\generateContextArray(), ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId(), ilObjPortfolioTemplateGUI\getEditFormCustomValues(), ilObjExerciseGUI\getEditFormCustomValues(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\getHeaderActionVisibility(), ilObjContentPageListGUI\getInfoScreenStatus(), ilObjCategoryListGUI\getInfoScreenStatus(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\getInfoTabVisibility(), ilCourseMembershipGUI\getMailContextOptions(), ilGroupMembershipGUI\getMailContextOptions(), ilNewsItem\getNewsForRefId(), ilTaxMDGUI\getSelectableTaxonomies(), ilObjGroupGUI\getTabs(), ilObjSessionGUI\getTabs(), ilObjCourseGUI\getTabs(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\getTitleAndIconVisibility(), ilObjectDataSet\getTypes(), ilObjectMetaDataGUI\hasAdvancedMDSettings(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilContainerGUI\initFilter(), ilContainerGUI\initListPresentationForm(), ilGroupMembershipMailNotification\initMail(), ilCourseMembershipMailNotification\initMail(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilContSkillAdminGUI\initSettingsForm(), ilObjectGUI\insertHeaderAction(), ilContSkillPresentationGUI\isAccessible(), ILIAS\Taxonomy\Settings\SettingsManager\isActivated(), ilTaggingClassificationProvider\isActive(), ilMembershipNotifications\isActiveForRefId(), ilColumnGUI\isGloballyActivated(), ilObjFileBasedLMAccess\isInfoEnabled(), ilObjContentObjectAccess\isInfoEnabled(), ilBadgeHandler\isObjectActive(), ilCalendarSettings\lookupCalendarActivated(), ilCalendarSettings\lookupCalendarContentPresentationEnabled(), ilContentPageDataSet\readData(), ilContainerRenderer\renderHelperGeneric(), ilContSkillAdminGUI\saveCompetenceAssignment(), ilObject\selfOrParentWithRatingEnabled(), ilObjCategoryGUI\setEditTabs(), ilObjRootFolderGUI\setTitleAndDescription(), ilContainerGUI\setTitleAndDescription(), ilContainerGUI\showContainerFilter(), and ilAdvancedMDRecordObjectOrderings\sortRecords().

     : string {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT value 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"];
        }

        return $a_default_value ?? '';
    }

Here is the caller graph for this function:

_writeContainerSetting()

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

static

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

References $DIC, $ilDB, ilObject\$log, ilLogger\debug(), and ilLoggerFactory\getLogger().

Referenced by ilObjEmployeeTalkSeries\__construct(), ilObjPortfolioBase\cloneBasics(), ilObjWiki\cloneObject(), ilObjSession\cloneSettings(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\copy(), ilObjTalkTemplate\create(), ilObjContentPage\doCloneObject(), ilObjectDataSet\getDependencies(), ilLearningSequenceXMLParser\handleEndTag(), ilCategoryXmlParser\handlerEndTag(), ilGroupXMLParser\handlerEndTag(), ilCourseXMLParser\handlerEndTag(), ilContentPageDataSet\importRecord(), ilAdvancedMetaDataImporter\importXmlRepresentation(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\persistIconState(), ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom\remove(), ILIAS\Repository\Form\saveAdditionalFeatures(), ilObjExercise\saveData(), ilContainerGUI\saveListPresentation(), ilContSkillAdminGUI\saveSettings(), ilObjCategoryGUI\showTaxAsSideBlockObject(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\storeHeaderActionVisibility(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\storeInfoTabVisibility(), ILIAS\ILIASObject\Properties\AdditionalProperties\LegacyRepository\storeTitleAndIconVisibility(), ilObjCourseGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "DELETE FROM container_settings WHERE " .
            "id = " . $ilDB->quote($a_id, 'integer') . " " .
            "AND keyword = " . $ilDB->quote($a_keyword, 'text');
        $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') .
            ")";

        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addAdditionalSubItemInformation()

ilContainer::addAdditionalSubItemInformation

(

array &

$object

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

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

Referenced by getSubItems().

                                                                   : void
    {
    }

Here is the caller graph for this function:

addTranslation()

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

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

References ilObject\getObjectProperties().

Referenced by create().

     : void {
        if (empty($a_title)) {
            $a_title = "NO TITLE";
        }

        $this->obj_trans = $this->obj_trans->withLanguage(
            new Language(
                $a_lang,
                $a_title,
                $a_desc,
                (bool) $a_lang_default
            )
        );
        $this->getObjectProperties()->storePropertyTranslations($this->obj_trans);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

applyContainerUserFilter()

ilContainer::applyContainerUserFilter ( array  $objects, ?ilContainerUserFilter  $container_user_filter = null  )

protected

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

References ilObject\getId().

Referenced by getSubItems().

     : array {
        $filter = $this->domain->content()->filter(
            $objects,
            $container_user_filter,
            !self::_lookupContainerSetting($this->getId(), "filter_show_empty", false)
        );
        return $filter->apply();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneAllObject()

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

Parameters

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

Returns

array

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

References ilObject\$log, $res, $user, ilCopyWizardOptions\_allocateCopyId(), ilSession\_duplicate(), ilCopyWizardOptions\_getInstance(), ilLoggerFactory\getLogger(), ilSoapFunctions\ilClone(), ILIAS\Repository\int(), and ilObjectCopyGUI\SUBMODE_CONTENT_ONLY.

     : array {
        $ilLog = $this->log;
        $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);

        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
        $soap_client = new ilSoapClient();
        $soap_client->setResponseTimeout($soap_client->getResponseTimeout());
        $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', [$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();
            $res = ilSoapFunctions::ilClone($new_session_id . '::' . $client_id, $copy_id);
        }
        return [
                'copy_id' => $copy_id,
                'ref_id' => (int) $res
        ];
    }

Here is the call graph for this function:

cloneDependencies()

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

Clone object dependencies (container sorting)

public

Parameters

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

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

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

                                                                   : bool
    {
        $ilLog = $this->log;

        parent::cloneDependencies($target_id, $copy_id);

        ilContainerSorting::_getInstance($this->getId())->cloneSorting($target_id, $copy_id);

        // fix internal links to other objects
        self::fixInternalLinksAfterCopy($target_id, $copy_id, $this->getRefId());

        // fix item group references in page content
        ilObjItemGroup::fixContainerItemGroupRefsAfterCloning($this, $copy_id);

        $olp = ilObjectLP::getInstance($this->getId());
        $collection = $olp->getCollectionInstance();
        if ($collection) {
            $collection->cloneCollection($target_id, $copy_id);
        }

        return true;
    }

Here is the call graph for this function:

create()

ilContainer::create

(

)

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

References $DIC, ilObject\$lng, ilObject\$log, addTranslation(), ilLogger\debug(), ilLanguage\getDefaultLanguage(), ilObject\getDescription(), ilObject\getId(), ilLoggerFactory\getLogger(), getNewsBlockActivated(), getNewsTimeline(), getNewsTimelineAutoEntries(), getNewsTimelineLandingPage(), ilObject\getObjectProperties(), getStyleSheetId(), ilObject\getTitle(), getUseNews(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, and ilObjectServiceSettingsGUI\USE_NEWS.

Referenced by ilObjEmployeeTalkSeries\__construct().

                            : int
    {
        global $DIC;

        $lng = $DIC->language();

        $ret = parent::create();

        // set translation object, since we have an object id now
        $this->obj_trans = $this->getObjectProperties()->getPropertyTranslations();

        // add default translation
        $this->addTranslation(
            $this->getTitle(),
            $this->getDescription(),
            $lng->getDefaultLanguage(),
            '1'
        );

        if (($this->getStyleSheetId()) > 0) {
            //ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
        }

        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("Create Container, id: " . $this->getId());

        self::_writeContainerSetting($this->getId(), "news_timeline", (string) ((int) $this->getNewsTimeline()));
        self::_writeContainerSetting($this->getId(), "news_timeline_incl_auto", (string) ((int) $this->getNewsTimelineAutoEntries()));
        self::_writeContainerSetting($this->getId(), "news_timeline_landing_page", (string) ((int) $this->getNewsTimelineLandingPage()));
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::NEWS_VISIBILITY, (string) ((int) $this->getNewsBlockActivated()));
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, (string) ((int) $this->getUseNews()));

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createContainerDirectory()

ilContainer::createContainerDirectory

(

)

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

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

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

Here is the call graph for this function:

delete()

ilContainer::delete

(

)

delete category and all related data

Returns

bool true if all object data were removed; false if only a references were removed

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

References ilObject\getObjectProperties().

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

        return true;
    }

Here is the call graph for this function:

deleteTranslation()

ilContainer::deleteTranslation

(

string

$a_lang

)

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

References ilObject\getObjectProperties().

                                                     : void
    {
        $this->obj_trans = $this->obj_trans->withoutLanguage($a_lang);
        $this->getObjectProperties()->storePropertyTranslations($this->obj_trans);
    }

Here is the call graph for this function:

enablePageEditing()

ilContainer::enablePageEditing

(

)

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

References $ilSetting, and $setting.

                                       : bool
    {
        $ilSetting = $this->setting;

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

filteredSubtree()

ilContainer::filteredSubtree

(

)

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

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

References ilObject\getType(), and isClassificationFilterActive().

Referenced by getInitialSubitems(), and ILIAS\UI\Component\Legacy\Content\DomainService\view().

                                     : bool
    {
        if ($this->isClassificationFilterActive() && in_array($this->getType(), ["grp", "crs"])) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCompleteDescriptions()

static ilContainer::getCompleteDescriptions ( array  $objects )

static

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

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

References $DIC, $ilSetting, ilObject\$long_desc, ilObject\$type, ilPageObject\_exists(), ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObject\DESC_LENGTH, ilObjectDefinition\getClassName(), ilPageObjectFactory\getInstance(), ilObjectDefinition\getLocation(), ilObject\getLongDescriptions(), and ilStr\shortenTextExtended().

Referenced by ILIAS\Containter\Content\ItemRenderer\renderItem(), ilContainerContentGUI\renderItem(), and ilContainerContentGUI\renderItemGroup().

                                                                  : array
    {
        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 || (int) $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"] = ilStr::shortenTextExtended(
                        $object["description"],
                        (int) $short_desc_max_length,
                        true
                    );
                }
            }
            // using (part of) long description
            else {
                $obj_ids = [];
                foreach ($objects as $key => $object) {
                    $obj_ids[] = $object["obj_id"];
                }
                if (count($obj_ids)) {
                    $long_desc = ilObject::getLongDescriptions($obj_ids);
                    foreach ($objects as $key => $object) {
                        // #12166 - keep translation, ignore long description
                        if ($ilObjDataCache->isTranslatedDescription((int) $object["obj_id"])) {
                            $long_desc[$object["obj_id"]] = $object["description"];
                        }
                        if ($short_desc && $short_desc_max_length) {
                            $long_desc[$object["obj_id"]] = ilStr::shortenTextExtended(
                                $long_desc[$object["obj_id"]] ?? '',
                                (int) $short_desc_max_length,
                                true
                            );
                        }
                        $objects[$key]["description"] = $long_desc[$object["obj_id"]] ?? '';
                    }
                }
            }
        }
        return $objects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContainerDirectory()

ilContainer::getContainerDirectory

(

)

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

References ilObject\getId().

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

Here is the call graph for this function:

getGroupedObjTypes()

ilContainer::getGroupedObjTypes

(

)

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

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

                                        : array
    {
        $objDefinition = $this->obj_definition;

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

Here is the call graph for this function:

getHiddenFilesFound()

ilContainer::getHiddenFilesFound

(

)

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

References $hiddenfilesfound.

                                         : bool
    {
        return $this->hiddenfilesfound;
    }

getInitialSubitems()

ilContainer::getInitialSubitems ( )

protected

Deprecated:

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

References ilObject\$tree, filteredSubtree(), ilTree\getChilds(), ilTree\getNodeData(), ilObject\getRefId(), and ilTree\getSubTree().

Referenced by getSubItems().

                                           : array
    {
        $tree = $this->tree;
        if ($this->filteredSubtree()) {
            $objects = $tree->getSubTree($tree->getNodeData($this->getRefId()));
        } else {
            $objects = $tree->getChilds($this->getRefId(), "title");
        }
        return $objects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewsBlockActivated()

ilContainer::getNewsBlockActivated

(

)

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

References $news_block_activated.

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

                                           : bool
    {
        return $this->news_block_activated;
    }

Here is the caller graph for this function:

getNewsTimeline()

ilContainer::getNewsTimeline

(

)

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

References $news_timeline.

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

                                     : bool
    {
        return $this->news_timeline;
    }

Here is the caller graph for this function:

getNewsTimelineAutoEntries()

ilContainer::getNewsTimelineAutoEntries

(

)

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

References $news_timeline_auto_entries.

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

                                                : bool
    {
        return $this->news_timeline_auto_entries;
    }

Here is the caller graph for this function:

getNewsTimelineLandingPage()

ilContainer::getNewsTimelineLandingPage

(

)

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

References $news_timeline_landing_page.

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

                                                : bool
    {
        return $this->news_timeline_landing_page;
    }

Here is the caller graph for this function:

getObjectTranslation()

ilContainer::getObjectTranslation

(

)

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

References $obj_trans.

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

                                          : ?Translations
    {
        return $this->obj_trans;
    }

Here is the caller graph for this function:

getOrderType()

ilContainer::getOrderType

(

)

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

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

getStyleSheetId()

ilContainer::getStyleSheetId

(

)

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

References $style_id.

Referenced by create().

                                     : int
    {
        return $this->style_id;
    }

Here is the caller graph for this function:

getSubItems()

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

Deprecated:

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

References $classification, $id, $obj_definition, ilObject\$type, ilContainerSorting\_getInstance(), ilObjFileAccess\_isFileHidden(), addAdditionalSubItemInformation(), applyContainerUserFilter(), ilObjectListGUI\CONTEXT_REPOSITORY, ilObject\getId(), getInitialSubitems(), ilObjectActivation\getItemsByEvent(), ilObject\getRefId(), ilObject\getType(), ilClassificationProvider\getValidProviders(), ILIAS\Repository\int(), isClassificationFilterActive(), null, and setHiddenFilesFound().

Referenced by ilEmployeeTalkAppointmentGUI\getPendingTalksInSeries().

     : array {
        $objDefinition = $this->obj_definition;

        // Caching
        if (
            isset($this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block]) &&
            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];
        }

        $objects = $this->getInitialSubitems();
        $objects = $this->applyContainerUserFilter($objects, $container_user_filter);
        $objects = self::getCompleteDescriptions($objects);

        // apply container classification filters
        $classification = $this->domain->classification($this->getRefId());
        foreach (ilClassificationProvider::getValidProviders($this->getRefId(), $this->getId(), $this->getType()) as $class_provider) {
            $id = get_class($class_provider);
            $current = $classification->getSelectionOfProvider($id);
            if ($current) {
                $class_provider->setSelection($current);
                $filtered = $class_provider->getFilteredObjects();
                $objects = array_filter($objects, static function (array $i) use ($filtered): bool {
                    return (is_array($filtered) && in_array($i["obj_id"], $filtered));
                });
            }
        }

        $found = false;
        $all_ref_ids = [];

        $preloader = null;
        if (!self::$data_preloaded) {
            $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);
        }

        $sort = ilContainerSorting::_getInstance($this->getId());

        // TODO: check this
        // get items attached to a session

        $classification_filter_active = $this->isClassificationFilterActive();
        foreach ($objects as $key => $object) {
            // see #41377, this ensures session materials to be preloaded
            if (!self::$data_preloaded) {
                if ($object["type"] === "sess") {
                    $ev_items = ilObjectActivation::getItemsByEvent((int) $object["obj_id"]);
                    foreach ($ev_items as $ev_item) {
                        $preloader->addItem((int) $ev_item["obj_id"], $ev_item["type"], $ev_item["ref_id"]);
                    }
                }
            }
            if ($a_get_single > 0 && $object["child"] != $a_get_single) {
                continue;
            }

            // hide object types in devmode
            if ($object["type"] === "adm" || $object["type"] === "rolf" || $objDefinition->getDevMode($object["type"])) {
                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'],
                ['file', 'fold', 'cat'],
                true
            ) && ilObjFileAccess::_isFileHidden((string) $object['title'])) {
                $this->setHiddenFilesFound(true);
                if (!$a_admin_panel_enabled) {
                    continue;
                }
            }
            // END WebDAV: Don't display hidden Files, Folders and Categories

            if (!self::$data_preloaded) {
                $preloader->addItem((int) $object["obj_id"], $object["type"], $object["child"]);
            }

            // filter side block items
            if (!$a_include_side_block && $objDefinition->isSideBlock($object['type'])) {
                continue;
            }

            $all_ref_ids[] = (int) $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:

Here is the caller graph for this function:

getTileSizes()

ilContainer::getTileSizes

(

)

Returns

array<int,string>

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

References ilObject\$lng, and ilLanguage\txt().

                                  : array
    {
        $lng = $this->lng;
        return [
            self::TILE_SMALL => $lng->txt("cont_tile_size_1"),
            self::TILE_NORMAL => $lng->txt("cont_tile_size_0"),
            self::TILE_LARGE => $lng->txt("cont_tile_size_2"),
            self::TILE_EXTRA_LARGE => $lng->txt("cont_tile_size_3"),
            self::TILE_FULL => $lng->txt("cont_tile_size_4")
        ];
    }

Here is the call graph for this function:

getUseNews()

ilContainer::getUseNews

(

)

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

References $use_news.

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

                                : bool
    {
        return $this->use_news;
    }

Here is the caller graph for this function:

getViewMode()

ilContainer::getViewMode

(

)

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

Referenced by ILIAS\UI\Component\Legacy\Content\DomainService\view().

                                 : int
    {
        return self::VIEW_BY_TYPE;
    }

Here is the caller graph for this function:

gotItems()

ilContainer::gotItems

(

)

Deprecated:

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

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

isClassificationFilterActive()

ilContainer::isClassificationFilterActive

(

)

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

References $classification, $id, ilObject\getId(), ilObject\getRefId(), ilObject\getType(), and ilClassificationProvider\getValidProviders().

Referenced by filteredSubtree(), and getSubItems().

                                                  : bool
    {
        // apply container classification filters
        $classification = $this->domain->classification($this->getRefId());
        foreach (ilClassificationProvider::getValidProviders($this->getRefId(), $this->getId(), $this->getType()) as $class_provider) {
            $id = get_class($class_provider);
            $current = $classification->getSelectionOfProvider($id);
            if ($current) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isNewsTimelineEffective()

ilContainer::isNewsTimelineEffective

(

)

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

References getNewsTimeline(), and getUseNews().

                                             : bool
    {
        if (!$this->news->isGloballyActivated()) {
            return false;
        }
        if ($this->getUseNews() && $this->getNewsTimeline()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

isNewsTimelineLandingPageEffective()

ilContainer::isNewsTimelineLandingPageEffective

(

)

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

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

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

Here is the call graph for this function:

putInTree()

ilContainer::putInTree

(

int

$parent_ref_id

)

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

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

Referenced by ilECSCourseCreationHandler\createCourseReference().

                                                 : void
    {
        parent::putInTree($parent_ref_id);

        // copy title, icon actions visibilities
        if (self::_lookupContainerSetting(ilObject::_lookupObjId($parent_ref_id), "hide_header_icon_and_title")) {
            self::_writeContainerSetting($this->getId(), "hide_header_icon_and_title", '1');
        }
        if (self::_lookupContainerSetting(ilObject::_lookupObjId($parent_ref_id), "hide_top_actions")) {
            self::_writeContainerSetting($this->getId(), "hide_top_actions", '1');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilContainer::read

(

)

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

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

Referenced by ilObjOrgUnit\__construct().

                          : void
    {
        parent::read();

        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));

        //$this->setStyleSheetId(ilObjStyleSheet::lookupObjectStyle($this->getId()));

        $this->readContainerSettings();
        $this->obj_trans = $this->getObjectProperties()->getPropertyTranslations();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readContainerSettings()

ilContainer::readContainerSettings

(

)

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

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

Referenced by read().

                                           : void
    {
        $this->setNewsTimeline((bool) self::_lookupContainerSetting($this->getId(), "news_timeline"));
        $this->setNewsTimelineAutoEntries((bool) self::_lookupContainerSetting($this->getId(), "news_timeline_incl_auto"));
        $this->setNewsTimelineLandingPage((bool) self::_lookupContainerSetting($this->getId(), "news_timeline_landing_page"));
        $this->setNewsBlockActivated((bool) self::_lookupContainerSetting(
            $this->getId(),
            ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
            $this->setting->get('block_activated_news', '1')
        ));
        $this->setUseNews((bool) self::_lookupContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, '1') &&
        $this->news->isGloballyActivated());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeTranslations()

ilContainer::removeTranslations

(

)

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

References ilObject\getObjectProperties().

                                        : void
    {
        $this->getObjectProperties()->deletePropertyTranslations();
    }

Here is the call graph for this function:

setHiddenFilesFound()

ilContainer::setHiddenFilesFound

(

bool

$a_hiddenfilesfound

)

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

Referenced by getSubItems().

                                                                 : void
    {
        $this->hiddenfilesfound = $a_hiddenfilesfound;
    }

Here is the caller graph for this function:

setNewsBlockActivated()

ilContainer::setNewsBlockActivated

(

bool

$a_val

)

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

Referenced by readContainerSettings().

                                                      : void
    {
        $this->news_block_activated = $a_val;
    }

Here is the caller graph for this function:

setNewsTimeline()

ilContainer::setNewsTimeline

(

bool

$a_val

)

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

Referenced by readContainerSettings().

                                                : void
    {
        $this->news_timeline = $a_val;
    }

Here is the caller graph for this function:

setNewsTimelineAutoEntries()

ilContainer::setNewsTimelineAutoEntries

(

bool

$a_val

)

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

Referenced by readContainerSettings().

                                                           : void
    {
        $this->news_timeline_auto_entries = $a_val;
    }

Here is the caller graph for this function:

setNewsTimelineLandingPage()

ilContainer::setNewsTimelineLandingPage

(

bool

$a_val

)

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

Referenced by readContainerSettings().

                                                           : void
    {
        $this->news_timeline_landing_page = $a_val;
    }

Here is the caller graph for this function:

setObjectTranslation()

ilContainer::setObjectTranslation

(

?Translations

$obj_trans

)

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

References $obj_trans.

                                                                  : void
    {
        $this->obj_trans = $obj_trans;
    }

setOrderType()

ilContainer::setOrderType

(

int

$a_value

)

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

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

                                              : void
    {
        $this->order_type = $a_value;
    }

Here is the caller graph for this function:

setStyleSheetId()

ilContainer::setStyleSheetId

(

int

$a_style_id

)

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

                                                    : void
    {
        $this->style_id = $a_style_id;
    }

setUseNews()

ilContainer::setUseNews

(

bool

$a_val

)

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

Referenced by readContainerSettings().

                                           : void
    {
        $this->use_news = $a_val;
    }

Here is the caller graph for this function:

update()

ilContainer::update

(

)

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

References ilObject\$log, ilLogger\debug(), ilObject\getId(), ilLoggerFactory\getLogger(), ilObject\getLongDescription(), getNewsBlockActivated(), getNewsTimeline(), getNewsTimelineAutoEntries(), getNewsTimelineLandingPage(), ilObject\getObjectProperties(), ilObject\getTitle(), getUseNews(), ilLogger\logStack(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, and ilObjectServiceSettingsGUI\USE_NEWS.

Referenced by ilObjEmployeeTalkSeries\__construct(), and ilObjEmployeeTalkSeriesGUI\copyTemplateValues().

                            : bool
    {
        $ret = parent::update();

        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("**5**" . count($this->getObjectProperties()->getPropertyTranslations()->getLanguages()));

        $this->getObjectProperties()->storePropertyTranslations(
            $this->getObjectProperties()->getPropertyTranslations()
                ->withDefaultTitle($this->getTitle())
                ->withDefaultDescription($this->getLongDescription())
        );

        $log = ilLoggerFactory::getLogger("cont");
        $log->debug(":::::::::::::::::::::::::::");
        $log->logStack(10);

        //ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());

        $log = ilLoggerFactory::getLogger("cont");
        $log->debug("Update Container, id: " . $this->getId());

        self::_writeContainerSetting($this->getId(), "news_timeline", (string) ((int) $this->getNewsTimeline()));
        self::_writeContainerSetting($this->getId(), "news_timeline_incl_auto", (string) (int) $this->getNewsTimelineAutoEntries());
        self::_writeContainerSetting($this->getId(), "news_timeline_landing_page", (string) ((int) ($this->getNewsTimelineLandingPage())));
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::NEWS_VISIBILITY, (string) ((int) $this->getNewsBlockActivated()));
        self::_writeContainerSetting($this->getId(), ilObjectServiceSettingsGUI::USE_NEWS, (string) ((int) $this->getUseNews()));

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilContainer::$access

protected

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

$content_style_domain

ILIAS Style Content DomainService ilContainer::$content_style_domain

protected

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

$data_preloaded

bool ilContainer::$data_preloaded = false

static

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

$domain

ILIAS Container InternalDomainService ilContainer::$domain

protected

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

$hiddenfilesfound

bool ilContainer::$hiddenfilesfound = false

protected

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

Referenced by getHiddenFilesFound().

$items

array ilContainer::$items = []

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

$news

News ilContainer::$news

protected

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

$news_block_activated

bool ilContainer::$news_block_activated = false

protected

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

Referenced by getNewsBlockActivated().

$news_timeline

bool ilContainer::$news_timeline = false

protected

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

Referenced by getNewsTimeline().

$news_timeline_auto_entries

bool ilContainer::$news_timeline_auto_entries = false

protected

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

Referenced by getNewsTimelineAutoEntries().

$news_timeline_landing_page

bool ilContainer::$news_timeline_landing_page = false

protected

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

Referenced by getNewsTimelineLandingPage().

$obj_definition

ilObjectDefinition ilContainer::$obj_definition

protected

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

Referenced by getGroupedObjTypes(), and getSubItems().

$obj_trans

Translations ilContainer::$obj_trans = null

protected

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

Referenced by getObjectTranslation(), and setObjectTranslation().

$order_type

int ilContainer::$order_type = 0

protected

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

$rbacsystem

ilRbacSystem ilContainer::$rbacsystem

protected

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

$recommended_content_manager

ilRecommendedContentManager ilContainer::$recommended_content_manager

protected

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

$setting

ilSetting ilContainer::$setting

protected

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

Referenced by enablePageEditing().

$style_id

int ilContainer::$style_id = 0

protected

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

Referenced by getStyleSheetId().

$type_grps

array ilContainer::$type_grps = null

protected

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

Referenced by getGroupedObjTypes().

$use_news

bool ilContainer::$use_news = false

protected

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

Referenced by getUseNews().

$user

ilObjUser ilContainer::$user

protected

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

Referenced by cloneAllObject().

SORT_ACTIVATION

const ilContainer::SORT_ACTIVATION = 2

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

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

SORT_DIRECTION_ASC

const ilContainer::SORT_DIRECTION_ASC = 0

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

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

SORT_INHERIT

const ilContainer::SORT_INHERIT = 3

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

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

SORT_MANUAL

const ilContainer::SORT_MANUAL = 1

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

Referenced by ilObjCourse\__createDefaultSettings(), ilCourseObjective\__getOrderColumn(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilContainerSortingSettings\_importContainerSortingSettings(), ilObjLinkResourceGUI\activateTabs(), ilContainerGUI\addHeaderRow(), ilObjStudyProgrammeGUI\afterSave(), ilObjLearningSequenceGUI\afterSave(), ILIAS\UI\Component\Legacy\Content\ItemPresentationManager\canOrderItems(), ILIAS\UI\Component\Legacy\Content\ItemPresentationManager\forceSessionOrderingByDate(), ilLSItemsDB\getLSItems(), ilObjCourse\getOrderType(), ilWebLinkXmlParser\handlerBeginTag(), ilObjFolderGUI\initEditForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjLinkResourceGUI\initFormSettings(), ilContainerGUI\initSortingForm(), ILIAS\UI\Component\Legacy\Content\ModeManager\isActiveItemOrdering(), ilContainerGUI\isActiveItemOrdering(), ilContainerGUI\saveSortingSettings(), ilWebLinkItemsContainer\sort(), ilContainerSorting\sortItems(), ilContainerSortingSettings\sortModeToString(), ilContainerSorting\sortSubItems(), ilLSItemsDBTest\testGetLSItemsWithData(), ilLSItemsDBTest\testGetLSItemsWithoutData(), ilWebResourceItemsContainerTest\testSortManual(), ilObjLinkResource\toXML(), and ilObjLinkResourceGUI\view().

SORT_NEW_ITEMS_ORDER_ACTIVATION

const ilContainer::SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Definition at line 59 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 58 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 57 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 55 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 54 of file class.ilContainer.php.

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

SORT_TITLE

const ilContainer::SORT_TITLE = 0

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

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

TILE_EXTRA_LARGE

const ilContainer::TILE_EXTRA_LARGE = 3

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

Referenced by ilContainerRenderer\renderHelperGeneric().

TILE_FULL

const ilContainer::TILE_FULL = 4

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

Referenced by ilContainerRenderer\renderHelperGeneric().

TILE_LARGE

const ilContainer::TILE_LARGE = 2

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

Referenced by ilContainerRenderer\renderHelperGeneric().

TILE_NORMAL

const ilContainer::TILE_NORMAL = 0

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

TILE_SMALL

const ilContainer::TILE_SMALL = 1

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

Referenced by ilContainerRenderer\renderHelperGeneric().

VIEW_ARCHIVE

const ilContainer::VIEW_ARCHIVE = 3

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

VIEW_BY_TYPE

const ilContainer::VIEW_BY_TYPE = 5

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

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

VIEW_DEFAULT

const ilContainer::VIEW_DEFAULT = self::VIEW_BY_TYPE

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

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

VIEW_INHERIT

const ilContainer::VIEW_INHERIT = 6

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

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

VIEW_OBJECTIVE

const ilContainer::VIEW_OBJECTIVE = 1

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

Referenced by ilObjCourseGUI\_modifyItemGUI(), ilContainerGUI\getContentGUI(), ILIAS\UI\Component\Legacy\Content\ModeManager\isActiveItemOrdering(), ilObjCourseGUI\renderObject(), and ilObjCourseGUI\showPossibleSubObjects().

VIEW_SESSIONS

const ilContainer::VIEW_SESSIONS = 0

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

Referenced by ILIAS\UI\Component\Legacy\Content\ItemPresentationManager\forceSessionOrderingByDate(), ilContainerGUI\getContentGUI(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilObjGroupGUI\initForm(), ILIAS\UI\Component\Legacy\Content\ItemPresentationManager\isActiveItemOrdering(), ilObjCourseGUI\renderObject(), and ilObjGroup\translateViewMode().

VIEW_SIMPLE

const ilContainer::VIEW_SIMPLE = 4

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

Referenced by ilContainerGUI\getContentGUI(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilObjGroupGUI\initForm(), ilObjCourseGUI\renderObject(), ilObjGroup\translateViewMode(), and ILIAS\UI\Component\Legacy\Content\DomainService\view().

VIEW_TIMING

const ilContainer::VIEW_TIMING = 2

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

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

---

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

• components/ILIAS/Container/classes/class.ilContainer.php