ILIAS\Containter\Content\ItemRenderer Class Reference

Collaboration diagram for ILIAS\Containter\Content\ItemRenderer:

Public Member Functions
	renderItem (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="", string $item_group_list_presentation="", int $checkbox=self::CHECKBOX_NONE, bool $item_ordering=false, int $details_level=\ilObjectListGUI::DETAILS_ALL)
	setItemModifierClosure (\Closure $f)
	renderCard (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="")
	getItemGUI (array $item_data)

Data Fields
const	CHECKBOX_NONE = 0
const	CHECKBOX_ADMIN = 1
const	CHECKBOX_DOWNLOAD = 2

Protected Attributes
ilContainerGUI	$container_gui
ilContainer	$container
string	$view_mode
InternalGUIService	$gui
InternalDomainService	$domain
Closure	$item_modifier_closure = null
array	$list_gui = []

Detailed Description

Todo:

currently too fat for a renderer, more a GUI class

Author

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

Definition at line 31 of file class.ItemRenderer.php.

Member Function Documentation

getItemGUI()

ILIAS\Containter\Content\ItemRenderer::getItemGUI

(

array

$item_data

)

Definition at line 276 of file class.ItemRenderer.php.

                                                : \ilObjectListGUI
    {
        // get item list gui object
        if (!isset($this->list_gui[$item_data["type"]])) {
            $item_list_gui = \ilObjectListGUIFactory::_getListGUIByType($item_data["type"]);
            $item_list_gui->setContainerObject($this->container_gui);
            $this->list_gui[$item_data["type"]] = $item_list_gui;
        } else {
            $item_list_gui = $this->list_gui[$item_data["type"]];
        }
 
        // unique js-ids
        $item_list_gui->setParentRefId((int) ($item_data["parent"] ?? 0));
 
        $item_list_gui->setDefaultCommandParameters(array());
        $item_list_gui->disableTitleLink(false);
        $item_list_gui->resetConditionTarget();
 
        if ($this->container->isClassificationFilterActive()) {
            $item_list_gui->enablePath(
                true,
                $this->container->getRefId(),
                new \ilSessionClassificationPathGUI()
            );
        }
 
        // show administration command buttons (or not)
        /*
        if (!$this->container_gui->isActiveAdministrationPanel()) {
            //                  $item_list_gui->enableDelete(false);
//                      $item_list_gui->enableLink(false);
//                      $item_list_gui->enableCut(false);
        }*/
 
        // activate common social commands
        $item_list_gui->enableComments(true);
        $item_list_gui->enableNotes(true);
        $item_list_gui->enableTags(true);
        $item_list_gui->enableRating(true);
 
        // reset
        $item_list_gui->forceVisibleOnly(false);
 
        // container specific modifications
        $this->container_gui->modifyItemGUI($item_list_gui, $item_data);
 
        return $item_list_gui;
    }

References ilObjectListGUIFactory\_getListGUIByType().

Here is the call graph for this function:

renderCard()

ILIAS\Containter\Content\ItemRenderer::renderCard	(	array	$a_item_data,
		int	$a_position = 0,
		bool	$a_force_icon = false,
		string	$a_pos_prefix = ""
	)

Definition at line 246 of file class.ItemRenderer.php.

     : ?RepositoryObject {
        $item_list_gui = $this->getItemGUI($a_item_data);
        $item_list_gui->setAjaxHash(\ilCommonActionDispatcherGUI::buildAjaxHash(
            \ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            (int) $a_item_data['ref_id'],
            $a_item_data['type'],
            (int) $a_item_data['obj_id']
        ));
        $item_list_gui->initItem(
            (int) $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            $a_item_data['type'],
            $a_item_data['title'],
            $a_item_data['description']
        );
 
        return $item_list_gui->getAsCard(
            (int) $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            (string) $a_item_data['type'],
            (string) $a_item_data['title'],
            (string) $a_item_data['description']
        );
    }

renderItem()

ILIAS\Containter\Content\ItemRenderer::renderItem	(	array	$a_item_data,
		int	$a_position = 0,
		bool	$a_force_icon = false,
		string	$a_pos_prefix = "",
		string	$item_group_list_presentation = "",
		int	$checkbox = self::CHECKBOX_NONE,
		bool	$item_ordering = false,
		int	$details_level = \ilObjectListGUI::DETAILS_ALL
	)

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

     : RepositoryObject|string|null {
        $ilSetting = $this->domain->settings();
        $ilAccess = $this->domain->access();
        $ilCtrl = $this->gui->ctrl();
 
        // Pass type, obj_id and tree to checkAccess method to improve performance
        /* deactivated, this should have been checked before
        if (!$ilAccess->checkAccess('visible', '', $a_item_data['ref_id'], $a_item_data['type'], $a_item_data['obj_id'], $a_item_data['tree'])) {
            return '';
        }*/
        $view_mode = $this->view_mode;
        if ($item_group_list_presentation != "") {
            $view_mode = ($item_group_list_presentation === "tile")
                ? \ilContainerContentGUI::VIEW_MODE_TILE
                : \ilContainerContentGUI::VIEW_MODE_LIST;
        }
 
        if ($view_mode == \ilContainerContentGUI::VIEW_MODE_TILE) {
            return $this->renderCard($a_item_data, $a_position, $a_force_icon, $a_pos_prefix);
        }
 
        $item_list_gui = $this->getItemGUI($a_item_data);
        if ($ilSetting->get("icon_position_in_lists") === "item_rows" ||
            $a_item_data["type"] === "sess" || $a_force_icon) {
            $item_list_gui->enableIcon(true);
        }
        if ($checkbox === self::CHECKBOX_ADMIN) {
            $item_list_gui->enableCheckbox(true);
        } elseif ($checkbox === self::CHECKBOX_DOWNLOAD) {
            // display multi download checkboxes
            $item_list_gui->enableDownloadCheckbox((int) $a_item_data["ref_id"]);
        }
 
        if ($item_ordering) {
            $item_list_gui->setPositionInputField(
                $a_pos_prefix . "[" . $a_item_data["ref_id"] . "]",
                sprintf('%d', $a_position * 10)
            );
        }
 
        if ($a_item_data['type'] === 'sess') {
            switch ($details_level) {
                case \ilContainerContentGUI::DETAILS_TITLE:
                    $item_list_gui->setDetailsLevel(\ilObjectListGUI::DETAILS_MINIMAL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->setExpanded(false);
                    $item_list_gui->enableDescription(false);
                    $item_list_gui->enableProperties(true);
                    break;
 
                case \ilContainerContentGUI::DETAILS_ALL:
                    $item_list_gui->setDetailsLevel(\ilObjectListGUI::DETAILS_ALL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->setExpanded(true);
                    $item_list_gui->enableDescription(true);
                    $item_list_gui->enableProperties(true);
                    break;
 
                case \ilContainerContentGUI::DETAILS_DEACTIVATED:
                    break;
 
                default:
                    $item_list_gui->setDetailsLevel(\ilObjectListGUI::DETAILS_ALL);
                    $item_list_gui->enableExpand(true);
                    $item_list_gui->enableDescription(true);
                    $item_list_gui->enableProperties(true);
                    break;
            }
        }
 
        if ($this->item_modifier_closure instanceof \Closure) {
            $c = $this->item_modifier_closure;
            $c($item_list_gui, $a_item_data);
        }
 
        // show subitems of sessions
        if ($a_item_data['type'] === 'sess' and (
            $details_level !== \ilContainerContentGUI::DETAILS_TITLE or
            $this->container_gui->isActiveAdministrationPanel() or
            $this->container_gui->isActiveItemOrdering()
        )
        ) {
            $pos = 1;
 
            $items = \ilObjectActivation::getItemsByEvent((int) $a_item_data['obj_id']);
            $items = \ilContainerSorting::_getInstance($this->container->getId())->sortSubItems('sess', (int) $a_item_data['obj_id'], $items);
            $items = \ilContainer::getCompleteDescriptions($items);
 
            $item_readable = $ilAccess->checkAccess('read', '', (int) $a_item_data['ref_id']);
 
            foreach ($items as $item) {
                // TODO: this should be removed and be handled by if(strlen($sub_item_html))
                //      see mantis: 0003944
                if (!$ilAccess->checkAccess('visible', '', (int) $item['ref_id'])) {
                    continue;
                }
 
                $item_list_gui2 = $this->getItemGUI($item);
                $item_list_gui2->enableIcon(true);
                $item_list_gui2->enableItemDetailLinks(false);
 
                // unique js-ids
                $item_list_gui2->setParentRefId((int) ($a_item_data['ref_id'] ?? 0));
 
                // @see mantis 10488
                if (!$item_readable and !$ilAccess->checkAccess('write', '', $item['ref_id'])) {
                    $item_list_gui2->forceVisibleOnly(true);
                }
 
                if ($checkbox === self::CHECKBOX_ADMIN) {
                    $item_list_gui2->enableCheckbox(true);
                } elseif ($checkbox === self::CHECKBOX_DOWNLOAD) {
                    // display multi download checkbox
                    $item_list_gui2->enableDownloadCheckbox((int) $item['ref_id']);
                }
 
                if ($this->container_gui->isActiveItemOrdering()) {
                    $item_list_gui2->setPositionInputField(
                        "[sess][" . $a_item_data['obj_id'] . "][" . $item["ref_id"] . "]",
                        sprintf('%d', $pos * 10)
                    );
                    $pos++;
                }
 
                // #10611
                \ilObjectActivation::addListGUIActivationProperty($item_list_gui2, $item);
 
                $sub_item_html = $item_list_gui2->getListItemHTML(
                    (int) $item['ref_id'],
                    (int) $item['obj_id'],
                    $item['title'],
                    $item['description']
                );
 
                if (strlen($sub_item_html)) {
                    $item_list_gui->addSubItemHTML($sub_item_html);
                }
            }
        }
 
        $asynch = false;
        $asynch_url = '';
        if ($ilSetting->get("item_cmd_asynch")) {
            $asynch = true;
            $ilCtrl->setParameter($this->container_gui, "cmdrefid", $a_item_data['ref_id']);
            $asynch_url = $ilCtrl->getLinkTarget(
                $this->container_gui,
                "getAsynchItemList",
                "",
                true,
                false
            );
            $ilCtrl->setParameter($this->container_gui, "cmdrefid", "");
        }
 
        \ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_item_data);
 
        $html = $item_list_gui->getListItemHTML(
            (int) $a_item_data['ref_id'],
            (int) $a_item_data['obj_id'],
            (string) $a_item_data['title'],
            (string) $a_item_data['description'],
            $asynch,
            false,
            $asynch_url
        );
 
        return $html;
    }

References ILIAS\Containter\Content\ItemRenderer\$view_mode, ilContainerContentGUI\VIEW_MODE_LIST, and ilContainerContentGUI\VIEW_MODE_TILE.

setItemModifierClosure()

ILIAS\Containter\Content\ItemRenderer::setItemModifierClosure

(

\Closure

$f

)

Definition at line 241 of file class.ItemRenderer.php.

                                                       : void
    {
        $this->item_modifier_closure = $f;
    }

References Vendor\Package\$f.

Field Documentation

$container

ilContainer ILIAS\Containter\Content\ItemRenderer::$container

protected

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

$container_gui

ilContainerGUI ILIAS\Containter\Content\ItemRenderer::$container_gui

protected

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

$domain

InternalDomainService ILIAS\Containter\Content\ItemRenderer::$domain

protected

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

$gui

InternalGUIService ILIAS\Containter\Content\ItemRenderer::$gui

protected

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

$item_modifier_closure

Closure ILIAS\Containter\Content\ItemRenderer::$item_modifier_closure = null

protected

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

$list_gui

array ILIAS\Containter\Content\ItemRenderer::$list_gui = []

protected

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

$view_mode

string ILIAS\Containter\Content\ItemRenderer::$view_mode

protected

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

Referenced by ILIAS\Containter\Content\ItemRenderer\renderItem().

CHECKBOX_ADMIN

const ILIAS\Containter\Content\ItemRenderer::CHECKBOX_ADMIN = 1

Definition at line 34 of file class.ItemRenderer.php.

CHECKBOX_DOWNLOAD

const ILIAS\Containter\Content\ItemRenderer::CHECKBOX_DOWNLOAD = 2

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

CHECKBOX_NONE

const ILIAS\Containter\Content\ItemRenderer::CHECKBOX_NONE = 0

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

---

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

• components/ILIAS/Container/Content/class.ItemRenderer.php