ILIAS\Container\StartObjects\Content\ObjectsContent Class Reference

Collaboration diagram for ILIAS\Container\StartObjects\Content\ObjectsContent:

Public Member Functions
	__construct (ilContainerGUI $a_parent_obj, ilContainerStartObjects $a_start_objects, UIFactory $ui_factory, UIRenderer $ui_renderer, bool $a_enable_desktop=true)
	render ()

Protected Member Functions
	getData ()
	getItemListGUI (string $a_type)
	getListItem (array $a_item)
	getItemAsSubPanel (array $item)

Protected Attributes
ilObjUser	$user
ilObjectDataCache	$obj_data_cache
ilAccessHandler	$access
ilObjectDefinition	$obj_definition
ilLanguage	$lng
ilCtrl	$ctrl
UIFactory	$ui_factory
UIRenderer	$ui_renderer
ilContainerStartObjects	$start_object
ilContainerGUI	$parent_obj
array	$item_list_guis
bool	$enable_desktop
ilFavouritesManager	$fav_manager

Detailed Description

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 41 of file ObjectsContent.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Container\StartObjects\Content\ObjectsContent::__construct	(	ilContainerGUI	$a_parent_obj,
		ilContainerStartObjects	$a_start_objects,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer,
		bool	$a_enable_desktop = true
	)

Definition at line 57 of file ObjectsContent.php.

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->access = $DIC->access();
        $this->obj_definition = $DIC["objDefinition"];
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
 
        $this->lng = $lng;
        $this->lng->loadLanguageModule('rep');
        $this->ctrl = $ilCtrl;
 
        $this->parent_obj = $a_parent_obj;
        $this->start_object = $a_start_objects;
        $this->enable_desktop = $a_enable_desktop;
 
        $this->fav_manager = new ilFavouritesManager();
    }

References $DIC, ILIAS\Container\StartObjects\Content\ObjectsContent\$lng, ILIAS\Container\StartObjects\Content\ObjectsContent\$ui_factory, ILIAS\Container\StartObjects\Content\ObjectsContent\$ui_renderer, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

getData()

ILIAS\Container\StartObjects\Content\ObjectsContent::getData ( )

protected

Definition at line 86 of file ObjectsContent.php.

                                : array
    {
        $ilUser = $this->user;
        $ilObjDataCache = $this->obj_data_cache;
        $ilAccess = $this->access;
 
        $lm_continue = new ilCourseLMHistory($this->start_object->getRefId(), $ilUser->getId());
        $continue_data = $lm_continue->getLMHistory();
 
        $items = [];
        $counter = 0;
        foreach ($this->start_object->getStartObjects() as $start) {
            $obj_id = $ilObjDataCache->lookupObjId((int) $start['item_ref_id']);
            $ref_id = $start['item_ref_id'];
            $type = $ilObjDataCache->lookupType($obj_id);
 
            if (!$ilAccess->checkAccess("visible", "", $ref_id)) {
                continue;
            }
 
            // start object status
            if ($this->start_object->isFullfilled($ilUser->getId(), $ref_id)) {
                $accomplished = 'accomplished';
            } else {
                $accomplished = 'not_accomplished';
            }
 
            // add/remove desktop
            $actions = [];
 
            if (isset($continue_data[$ref_id])) {
                $url = ilLink::_getLink($ref_id, '', [
                    'obj_id',
                    $continue_data[$ref_id]['lm_page_id']
                ]);
                $actions[$url] = $this->lng->txt('continue_work');
            }
 
            if ($this->enable_desktop) {
                $this->lng->loadLanguageModule('dash');
                // add to desktop link
                if (!$this->fav_manager->ifIsFavourite($ilUser->getId(), $ref_id)) {
                    if ($ilAccess->checkAccess('read', '', $ref_id)) {
                        $this->ctrl->setParameter($this->parent_obj, 'item_ref_id', $ref_id);
                        $this->ctrl->setParameter($this->parent_obj, 'item_id', $ref_id);
                        $this->ctrl->setParameter($this->parent_obj, 'type', $type);
                        $url = $this->ctrl->getLinkTarget($this->parent_obj, 'addToDesk');
                        $actions[$url] = $this->lng->txt("add_to_favourites");
                    }
                } else {
                    $this->ctrl->setParameter($this->parent_obj, 'item_ref_id', $ref_id);
                    $this->ctrl->setParameter($this->parent_obj, 'item_id', $ref_id);
                    $this->ctrl->setParameter($this->parent_obj, 'type', $type);
                    $url = $this->ctrl->getLinkTarget($this->parent_obj, 'removeFromDesk');
                    $actions[$url] = $this->lng->txt("remove_from_favourites");
                }
            }
 
            $default_params = null;
            if ($type === "tst") {
                $default_params["crs_show_result"] = $ref_id;
            }
            /* continue is currently inactive
            if(isset($continue_data[$ref_id]))
            {
                // :TODO: should "continue" be default or 2nd link/action?
                // $this->lng->txt('continue_work')
                $default_params["obj_id"] = $continue_data[$ref_id]['lm_page_id'];
            }
            */
 
            if ($accomplished === 'accomplished') {
                $icon = "assets/images/standard/icon_ok.svg";
            } else {
                $icon = "assets/images/standard/icon_not_ok.svg";
            }
 
            $items[] = [
                "nr" => ++$counter,
                "obj_id" => $obj_id,
                "ref_id" => $ref_id,
                "type" => $type,
                "append_default" => $default_params,
                "title" => $ilObjDataCache->lookupTitle($obj_id),
                "description" => $ilObjDataCache->lookupDescription($obj_id),
                "status" => $this->lng->txt('crs_objective_' . $accomplished),
                "status_img" => $icon,
                "actions" => $actions
            ];
        }
 
        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);
        foreach ($items as $item) {
            $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);
        }
        $preloader->preload();
        unset($preloader);
 
        return $items;
    }

References ILIAS\Container\StartObjects\Content\ObjectsContent\$access, $counter, ILIAS\Container\StartObjects\Content\ObjectsContent\$obj_data_cache, $ref_id, $url, ILIAS\Container\StartObjects\Content\ObjectsContent\$user, ilObjectListGUI\CONTEXT_REPOSITORY, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\render().

Here is the call graph for this function:

Here is the caller graph for this function:

getItemAsSubPanel()

ILIAS\Container\StartObjects\Content\ObjectsContent::getItemAsSubPanel ( array  $item )

protected

Definition at line 262 of file ObjectsContent.php.

                                                     : SubPanel
    {
        $status_icon = $this->ui_factory->symbol()->icon()->custom(
            $item['status_img'],
            $item['status']
        );
 
        $actions = [];
        foreach ($item['actions'] as $url => $caption) {
            $actions[] = $this->ui_factory->button()->shy($caption, $url);
        }
 
        $secondary_info = $this->ui_factory->listing()->property()->withItems([
            [$this->lng->txt('crs_objective_accomplished'), $status_icon],
            [$this->lng->txt('actions'), $this->ui_renderer->render($actions)]
        ]);
 
        return $this->ui_factory->panel()->sub(
            '',
            $this->ui_factory->legacy()->content($this->getListItem($item))
        )->withFurtherInformation(
            $this->ui_factory->panel()->secondary()->legacy(
                '',
                $this->ui_factory->legacy()->content($this->ui_renderer->render($secondary_info))
            )
        );
    }

References $url, and ILIAS\Repository\lng().

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\render().

Here is the call graph for this function:

Here is the caller graph for this function:

getItemListGUI()

ILIAS\Container\StartObjects\Content\ObjectsContent::getItemListGUI ( string  $a_type )

protected

Definition at line 187 of file ObjectsContent.php.

                                                     : ?ilObjectListGUI
    {
        $objDefinition = $this->obj_definition;
 
        if (!isset($this->item_list_guis[$a_type])) {
            $class = $objDefinition->getClassName($a_type);
            // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
            if (!$class) {
                return null;
            }
            // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
            $location = $objDefinition->getLocation($a_type);
            if (!$location) {
                return null;
            }
            $full_class = "ilObj" . $class . "ListGUI";
            $item_list_gui = new $full_class();
            $this->item_list_guis[$a_type] = $item_list_gui;
        } else {
            $item_list_gui = $this->item_list_guis[$a_type];
        }
 
        $item_list_gui->setDefaultCommandParameters([]);
 
        return $item_list_gui;
    }

References $location, ILIAS\Container\StartObjects\Content\ObjectsContent\$obj_definition, and ilObjectDefinition\getClassName().

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\getListItem().

Here is the call graph for this function:

Here is the caller graph for this function:

getListItem()

ILIAS\Container\StartObjects\Content\ObjectsContent::getListItem ( array  $a_item )

protected

Definition at line 215 of file ObjectsContent.php.

                                                 : string
    {
        $item_list_gui = $this->getItemListGUI($a_item["type"]);
        if (!$item_list_gui) {
            return "";
        }
 
        $item_list_gui->setContainerObject($this);
        $item_list_gui->enableCommands(true, true);
 
        // ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_item);
 
        // notes, comment currently do not work properly
        $item_list_gui->enableNotes(false);
        $item_list_gui->enableComments(false);
        $item_list_gui->enableTags(false);
 
        $item_list_gui->enableIcon(true);
        $item_list_gui->enableDelete(false);
        $item_list_gui->enableCut(false);
        $item_list_gui->enableCopy(false);
        $item_list_gui->enableLink(false);
        $item_list_gui->enableInfoScreen(true);
        $item_list_gui->enableSubscribe(false);
 
        $level = 3;
 
        if ($level < 3) {
            $item_list_gui->enableDescription(false);
            $item_list_gui->enableProperties(false);
            $item_list_gui->enablePreconditions(false);
        }
 
        if ($a_item["append_default"]) {
            $item_list_gui->setDefaultCommandParameters($a_item["append_default"]);
        }
        if (is_object($item_list_gui)) {
            return $item_list_gui->getListItemHTML(
                $a_item["ref_id"],
                $a_item["obj_id"],
                $a_item["title"],
                $a_item["description"]
            );
        }
        return "";
    }

References ILIAS\Container\StartObjects\Content\ObjectsContent\getItemListGUI().

Here is the call graph for this function:

render()

ILIAS\Container\StartObjects\Content\ObjectsContent::render

(

)

Definition at line 290 of file ObjectsContent.php.

                            : string
    {
        $info = $this->ui_factory->panel()->sub(
            '',
            $this->ui_factory->legacy()->content($this->lng->txt('crs_info_start'))
        );
        $items = [$info];
        foreach ($this->getData() as $datum) {
            $items[] = $this->getItemAsSubPanel($datum);
        }
 
        $panel = $this->ui_factory->panel()->standard(
            $this->lng->txt('crs_table_start_objects'),
            $items
        );
        return $this->ui_renderer->render($panel);
    }

References $info, ILIAS\Container\StartObjects\Content\ObjectsContent\getData(), ILIAS\Container\StartObjects\Content\ObjectsContent\getItemAsSubPanel(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ILIAS\Container\StartObjects\Content\ObjectsContent::$access

protected

Definition at line 45 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\getData().

$ctrl

ilCtrl ILIAS\Container\StartObjects\Content\ObjectsContent::$ctrl

protected

Definition at line 48 of file ObjectsContent.php.

$enable_desktop

bool ILIAS\Container\StartObjects\Content\ObjectsContent::$enable_desktop

protected

Definition at line 54 of file ObjectsContent.php.

$fav_manager

ilFavouritesManager ILIAS\Container\StartObjects\Content\ObjectsContent::$fav_manager

protected

Definition at line 55 of file ObjectsContent.php.

$item_list_guis

array ILIAS\Container\StartObjects\Content\ObjectsContent::$item_list_guis

protected

Definition at line 53 of file ObjectsContent.php.

$lng

ilLanguage ILIAS\Container\StartObjects\Content\ObjectsContent::$lng

protected

Definition at line 47 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\__construct().

$obj_data_cache

ilObjectDataCache ILIAS\Container\StartObjects\Content\ObjectsContent::$obj_data_cache

protected

Definition at line 44 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\getData().

$obj_definition

ilObjectDefinition ILIAS\Container\StartObjects\Content\ObjectsContent::$obj_definition

protected

Definition at line 46 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\getItemListGUI().

$parent_obj

ilContainerGUI ILIAS\Container\StartObjects\Content\ObjectsContent::$parent_obj

protected

Definition at line 52 of file ObjectsContent.php.

$start_object

ilContainerStartObjects ILIAS\Container\StartObjects\Content\ObjectsContent::$start_object

protected

Definition at line 51 of file ObjectsContent.php.

$ui_factory

UIFactory ILIAS\Container\StartObjects\Content\ObjectsContent::$ui_factory

protected

Definition at line 49 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\__construct().

$ui_renderer

UIRenderer ILIAS\Container\StartObjects\Content\ObjectsContent::$ui_renderer

protected

Definition at line 50 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\__construct().

$user

ilObjUser ILIAS\Container\StartObjects\Content\ObjectsContent::$user

protected

Definition at line 43 of file ObjectsContent.php.

Referenced by ILIAS\Container\StartObjects\Content\ObjectsContent\getData().

---

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

• components/ILIAS/Container/StartObjects/Content/ObjectsContent.php