Preloader for object list GUIs. More...

Collaboration diagram for ilObjectListGUIPreloader:

Public Member Functions
	__construct (int $context)

	addItem (int $obj_id, string $type, ?int $ref_id=null)

	preload ()

Protected Attributes
ilObjectDefinition	$obj_definition

ilTree	$tree

ilObjectDataCache	$obj_data_cache

ilObjUser	$user

ilRbacSystem	$rbacsystem

ilFavouritesManager	$fav_manager

int	$context

array	$obj_ids = []

array	$obj_ids_by_type = []

array	$ref_ids = []

array	$ref_ids_by_type = []

array	$types = []

Detailed Description

Preloader for object list GUIs.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilObjectListGUIPreloader.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectListGUIPreloader::__construct ( int $context )

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

References $context, $DIC, and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->obj_definition = $DIC["objDefinition"];
         $this->tree = $DIC->repositoryTree();
         $this->obj_data_cache = $DIC["ilObjDataCache"];
         $this->user = $DIC->user();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->fav_manager = new ilFavouritesManager();
         $this->context = $context;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

ilObjectListGUIPreloader::addItem	(	int	$obj_id,
		string	$type,
		?int	$ref_id = `null`
	)

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

References $ref_id.

                                                                            : void
     {
         $this->obj_ids[] = $obj_id;
         $this->obj_ids_by_type[$type][] = $obj_id;
         $this->types[] = $type;
 
         if ($ref_id) {
             $this->ref_ids[] = $ref_id;
             $this->ref_ids_by_type[$type][] = $ref_id;
         }
     }

◆ preload()

ilObjectListGUIPreloader::preload ( )

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

References $location, $ref_ids, ANONYMOUS_USER_ID, ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilObjectListGUI\CONTEXT_REPOSITORY, ilObjectListGUI\CONTEXT_SEARCH, ilAdvancedMDValues\preloadByObjIds(), ilObjectListGUI\preloadCommonProperties(), ilObjectActivation\preloadData(), ilRating\preloadListGUIData(), ilLPStatus\preloadListGUIData(), ilConditionHandler\preloadPersistedConditionsForTargetRecords(), and ILIAS\Repository\user().

                              : void
     {
         if (!$this->obj_ids) {
             return;
         }
 
         $this->obj_ids = array_unique($this->obj_ids);
         $this->types = array_unique($this->types);
         if ($this->ref_ids) {
             $this->ref_ids = array_unique($this->ref_ids);
         }
 
         // type specific preloads
         foreach ($this->types as $type) {
             $this->obj_ids_by_type[$type] = array_unique($this->obj_ids_by_type[$type]);
 
             if (isset($this->ref_ids_by_type[$type])) {
                 $this->ref_ids_by_type[$type] = array_unique($this->ref_ids_by_type[$type]);
             }
 
             if ($this->context == ilObjectListGUI::CONTEXT_REPOSITORY ||
                 $this->context == ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP ||
                 $this->context == ilObjectListGUI::CONTEXT_SEARCH) {
                 ilConditionHandler::preloadPersistedConditionsForTargetRecords(
                     $type,
                     $this->obj_ids_by_type[$type]
                 );
             }
 
             $class = $this->obj_definition->getClassName($type);
             $location = $this->obj_definition->getLocation($type);
             if ($class && $location) { // #12775
                 $full_class = "ilObj" . $class . "Access";
                 if (class_exists($full_class)) {
                     call_user_func(
                         [$full_class, "_preloadData"],
                         $this->obj_ids_by_type[$type] ?? [],
                         $this->ref_ids_by_type[$type] ?? []
                     );
                 }
             }
         }
 
         if ($this->ref_ids) {
             $this->tree->preloadDeleted($this->ref_ids);
             $this->tree->preloadDepthParent($this->ref_ids);
             $this->obj_data_cache->preloadReferenceCache($this->ref_ids, false);
             $this->rbacsystem->preloadRbacPaCache($this->ref_ids, $this->user->getId());
 
             if ($this->user->getId() != ANONYMOUS_USER_ID &&
                 $this->context != ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP) {
                 $this->fav_manager->loadData($this->user->getId(), $this->ref_ids);
             }
 
             ilObjectActivation::preloadData($this->ref_ids);
         }
 
         ilObjectListGUI::preloadCommonProperties($this->obj_ids, $this->context);
 
         if ($this->context == ilObjectListGUI::CONTEXT_REPOSITORY) {
             ilRating::preloadListGUIData($this->obj_ids);
 
             ilAdvancedMDValues::preloadByObjIds($this->obj_ids);
         }
 
         if ($this->context == ilObjectListGUI::CONTEXT_REPOSITORY ||
             $this->context == ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP ||
             $this->context == ilObjectListGUI::CONTEXT_SEARCH) {
             ilLPStatus::preloadListGUIData($this->obj_ids);
         }
     }