class.ilContainerRenderer.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */
require_once('./Services/Repository/classes/class.ilObjectPlugin.php');

class ilContainerRenderer
{
    protected $lng;

    protected $settings;

    protected $obj_definition;

    // switches
    protected $enable_manage_select_all; // [bool]
    protected $enable_multi_download; // [bool]
    protected $active_block_ordering; // [bool]
    
    // properties
    protected $type_blocks = array(); // [array]
    protected $custom_blocks = array(); // [array]
    protected $items = array(); // [array]
    protected $hidden_items = array(); // [array]
    protected $block_items = array(); // [array]
    protected $details = array(); // [array]
    protected $item_ids = array(); // [array]
    
    // block (unique) ids
    protected $rendered_blocks = array(); // [array]
    protected $bl_cnt = 0; // [int]
    protected $cur_row_type; // [string]
    
    // ordering
    protected $block_pos = array(); // [array]
    protected $block_custom_pos = array(); // [array]
    protected $order_cnt = 0; // [int]
    
    const UNIQUE_SEPARATOR = "-";
        
    public function __construct($a_enable_manage_select_all = false, $a_enable_multi_download = false, $a_active_block_ordering = false, array $a_block_custom_positions = null)
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->obj_definition = $DIC["objDefinition"];
        $this->enable_manage_select_all = (bool) $a_enable_manage_select_all;
        $this->enable_multi_download = (bool) $a_enable_multi_download;
        $this->active_block_ordering = (bool) $a_active_block_ordering;
        $this->block_custom_pos = $a_block_custom_positions;
    }
    
    
    //
    // blocks
    //
    
    public function addTypeBlock($a_type, $a_prefix = null, $a_postfix = null)
    {
        if ($a_type != "itgr" &&
            !$this->hasTypeBlock($a_type)) {
            $this->type_blocks[$a_type] = array(
                "prefix" => $a_prefix
                ,"postfix" => $a_postfix
            );
            return true;
        }
        return false;
    }
    
    public function hasTypeBlock($a_type)
    {
        return array_key_exists($a_type, $this->type_blocks);
    }
    
    public function addCustomBlock($a_id, $a_caption, $a_actions = null, $a_data = array())
    {
        if (!$this->hasCustomBlock($a_id)) {
            $this->custom_blocks[$a_id] = array(
                "caption" => $a_caption
                ,"actions" => $a_actions
                ,"data" => $a_data
            );
            return true;
        }
        return false;
    }
    
    public function hasCustomBlock($a_id)
    {
        return array_key_exists($a_id, $this->custom_blocks);
    }
    
    public function isValidBlock($a_id)
    {
        return ($this->hasTypeBlock($a_id) ||
            $this->hasCustomBlock($a_id));
    }
    
    
    //
    // items
    //
    
    public function hideItem($a_id)
    {
        // see hasItem();
        $this->hidden_items[$a_id] = true;
        
        // #16629 - do not remove hidden items from other blocks
        // $this->removeItem($a_id);
    }
    
    public function removeItem($a_id)
    {
        if (!$this->hasItem($a_id)) {
            return;
        }
        
        unset($this->item_ids[$a_id]);
        unset($this->hidden_items[$a_id]);
        
        foreach (array_keys($this->items) as $item_id) {
            if (array_pop(explode(self::UNIQUE_SEPARATOR, $item_id)) == $a_id) {
                unset($this->items[$item_id]);
            }
        }

        foreach ($this->block_items as $block_id => $items) {
            foreach ($items as $idx => $item_id) {
                if (array_pop(explode(self::UNIQUE_SEPARATOR, $item_id)) == $a_id) {
                    unset($this->block_items[$block_id][$idx]);
                    if (!sizeof($this->block_items[$block_id])) {
                        unset($this->block_items[$block_id]);
                    }
                    break;
                }
            }
        }
    }
    
    public function hasItem($a_id)
    {
        return (array_key_exists($a_id, $this->item_ids) ||
            array_key_exists($a_id, $this->hidden_items));
    }
    
    public function addItemToBlock($a_block_id, $a_item_type, $a_item_id, $a_item_html, $a_force = false)
    {
        if ($this->isValidBlock($a_block_id) &&
            $a_item_type != "itgr" &&
            (!$this->hasItem($a_item_id) || $a_force) &&
            trim($a_item_html)) {
            // #16563 - item_id (== ref_id) is NOT unique, adding parent block id
            $uniq_id = $a_block_id . self::UNIQUE_SEPARATOR . $a_item_id;
        
            $this->items[$uniq_id] = array(
                "type" => $a_item_type
                ,"html" => $a_item_html
            );
            
            // #18326
            $this->item_ids[$a_item_id] = true;
            
            $this->block_items[$a_block_id][] = $uniq_id;
            return true;
        }
        return false;
    }
    
    public function addDetailsLevel($a_level, $a_url, $a_active = false)
    {
        $this->details[$a_level] = array(
            "url" => $a_url
            ,"active" => (bool) $a_active
        );
    }
    
    public function resetDetails()
    {
        $this->details = array();
    }
    
    
    //
    // render
    //
    
    public function setBlockPosition($a_block_id, $a_pos)
    {
        if ($this->isValidBlock($a_block_id)) {
            $this->block_pos[$a_block_id] = $a_pos;
        }
    }
    
    public function getHTML()
    {
        $valid = false;
        
        $block_tpl = $this->initBlockTemplate();
        
        foreach ($this->processBlockPositions() as $block_id) {
            if (array_key_exists($block_id, $this->custom_blocks)) {
                if ($this->renderHelperCustomBlock($block_tpl, $block_id)) {
                    $this->addSeparatorRow($block_tpl);
                    $valid = true;
                }
            }
            if (array_key_exists($block_id, $this->type_blocks)) {
                if ($this->renderHelperTypeBlock($block_tpl, $block_id)) {
                    $this->addSeparatorRow($block_tpl);
                    $valid = true;
                }
            }
        }
        
        if ($valid) {
            $this->renderDetails($block_tpl);
            
            return $block_tpl->get();
        }
    }
    
    public function renderSingleTypeBlock($a_type)
    {
        $block_tpl = $this->initBlockTemplate();

        if ($this->renderHelperTypeBlock($block_tpl, $a_type, true)) {
            return $block_tpl->get();
        }
    }
    
    public function renderSingleCustomBlock($a_id)
    {
        $block_tpl = $this->initBlockTemplate();

        if ($this->renderHelperCustomBlock($block_tpl, $a_id, true)) {
            return $block_tpl->get();
        }
    }
        
    
    //
    // render (helper)
    //
    
    protected function processBlockPositions()
    {
        // manual order
        if (is_array($this->block_custom_pos) && sizeof($this->block_custom_pos)) {
            $tmp = $this->block_pos;
            $this->block_pos = array();
            foreach ($this->block_custom_pos as $idx => $block_id) {
                if ($this->isValidBlock($block_id)) {
                    $this->block_pos[$block_id] = $idx;
                }
            }
            
            // at least some manual are valid
            if (sizeof($this->block_pos)) {
                // append missing blocks from default order
                $last = max($this->block_pos);
                foreach (array_keys($tmp) as $block_id) {
                    if (!array_key_exists($block_id, $this->block_pos)) {
                        $this->block_pos[$block_id] = ++$last;
                    }
                }
            }
            // all manual invalid, use default
            else {
                $this->block_pos = $tmp;
            }
        }
        
        // add missing blocks to order
        $last = sizeof($this->block_pos)
            ? max($this->block_pos)
            : 0;
        foreach (array_keys($this->custom_blocks) as $block_id) {
            if (!array_key_exists($block_id, $this->block_pos)) {
                $this->block_pos[$block_id] = ++$last;
            }
        }
        foreach (array_keys($this->type_blocks) as $block_id) {
            if (!array_key_exists($block_id, $this->block_pos)) {
                $this->block_pos[$block_id] = ++$last;
            }
        }
            
        asort($this->block_pos);
        
        return array_keys($this->block_pos);
    }
    
    protected function renderHelperCustomBlock(ilTemplate $a_block_tpl, $a_block_id, $a_is_single = false)
    {
        if ($this->hasCustomBlock($a_block_id)) {
            return $this->renderHelperGeneric($a_block_tpl, $a_block_id, $this->custom_blocks[$a_block_id], $a_is_single);
        }
        return false;
    }
    
    protected function renderHelperTypeBlock(ilTemplate $a_block_tpl, $a_type, $a_is_single = false)
    {
        if ($this->hasTypeBlock($a_type)) {
            $block = $this->type_blocks[$a_type];
            $block["type"] = $a_type;
            
            return $this->renderHelperGeneric($a_block_tpl, $a_type, $block, $a_is_single);
        }
        return false;
    }
        
    protected function renderHelperGeneric(ilTemplate $a_block_tpl, $a_block_id, array $a_block, $a_is_single = false)
    {
        if (!in_array($a_block_id, $this->rendered_blocks)) {
            $this->rendered_blocks[] = $a_block_id;
        
            $block_types = array();
            if (is_array($this->block_items[$a_block_id])) {
                foreach ($this->block_items[$a_block_id] as $item_id) {
                    if (isset($this->items[$item_id]["type"])) {
                        $block_types[] = $this->items[$item_id]["type"];
                    }
                }
            }
            
            // #14610 - manage empty item groups
            if (is_array($this->block_items[$a_block_id]) ||
                is_numeric($a_block_id)) {
                $order_id = (!$a_is_single && $this->active_block_ordering)
                    ? $a_block_id
                    : null;
                $this->addHeaderRow($a_block_tpl, $a_block["type"], $a_block["caption"], array_unique($block_types), $a_block["actions"], $order_id, $a_block["data"]);

                if ($a_block["prefix"]) {
                    $this->addStandardRow($a_block_tpl, $a_block["prefix"]);
                }

                if (is_array($this->block_items[$a_block_id])) {
                    foreach ($this->block_items[$a_block_id] as $item_id) {
                        $this->addStandardRow($a_block_tpl, $this->items[$item_id]["html"], $item_id);
                    }
                }

                if ($a_block["postfix"]) {
                    $this->addStandardRow($a_block_tpl, $a_block["postfix"]);
                }
                            
                return true;
            }
        }
        
        return false;
    }
    
    protected function initBlockTemplate()
    {
        // :TODO: obsolete?
        $this->cur_row_type = "row_type_1";
        
        return new ilTemplate(
            "tpl.container_list_block.html",
            true,
            true,
            "Services/Container"
        );
    }
    
    protected function addHeaderRow(ilTemplate $a_tpl, $a_type = "", $a_text = "", array $a_types_in_block = null, $a_commands_html = null, $a_order_id = null, $a_data = array())
    {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $objDefinition = $this->obj_definition;

        $a_tpl->setVariable("CB_ID", ' id="bl_cntr_' . (++$this->bl_cnt) . '"');

        if ($this->enable_manage_select_all) {
            $this->renderSelectAllBlock($a_tpl);
        } elseif ($this->enable_multi_download) {
            if ($a_type) {
                $a_types_in_block = array($a_type);
            }
            foreach ($a_types_in_block as $type) {
                if (in_array($type, $this->getDownloadableTypes())) {
                    $this->renderSelectAllBlock($a_tpl);
                    break;
                }
            }
        }
                
        if ($a_text == "" && $a_type != "") {
            if (!$objDefinition->isPlugin($a_type)) {
                $title = $lng->txt("objs_" . $a_type);
            } else {
                include_once("./Services/Component/classes/class.ilPlugin.php");
                $pl = ilObjectPlugin::getRepoPluginObjectByType($a_type);
                $title= $pl->txt("objs_" . $a_type);
            }
        } else {
            $title = $a_text;
        }

        include_once("./Modules/ItemGroup/classes/class.ilItemGroupBehaviour.php");
        if (is_array($a_data)) {
            foreach ($a_data as $k => $v) {
                $a_tpl->setCurrentBlock("cb_data");
                $a_tpl->setVariable("DATA_KEY", $k);
                $a_tpl->setVariable("DATA_VALUE", $v);
                $a_tpl->parseCurrentBlock();

                if ($k == "behaviour" && $v == ilItemGroupBehaviour::EXPANDABLE_CLOSED) {
                    $a_tpl->touchBlock("container_items_hide");
                }
            }
        }

        if ($ilSetting->get("icon_position_in_lists") != "item_rows" &&
            $a_type != "") {
            $icon = ilUtil::getImagePath("icon_" . $a_type . ".svg");

            $a_tpl->setCurrentBlock("container_header_row_image");
            $a_tpl->setVariable("HEADER_IMG", $icon);
            $a_tpl->setVariable("HEADER_ALT", $title);
        } else {
            $a_tpl->setCurrentBlock("container_header_row");
        }
    
        if ($a_order_id) {
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NAME", "position[blocks][" . $a_order_id . "]");
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NUM", (++$this->order_cnt)*10);
        }
        
        $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $title);
        $a_tpl->setVariable("CHR_COMMANDS", $a_commands_html);
        $a_tpl->parseCurrentBlock();
        
        //$a_tpl->touchBlock("container_row");
        
        $this->resetRowType();
    }
    
    protected function addStandardRow(ilTemplate $a_tpl, $a_html, $a_ref_id = 0)
    {
        // :TODO: obsolete?
        $this->cur_row_type = ($this->cur_row_type == "row_type_1")
            ? "row_type_2"
            : "row_type_1";

        if ($a_ref_id > 0) {
            $a_tpl->setCurrentBlock($this->cur_row_type);
            $a_tpl->setVariable("ROW_ID", 'id="item_row_' . $a_ref_id . '"');
            $a_tpl->parseCurrentBlock();
        } else {
            $a_tpl->touchBlock($this->cur_row_type);
        }
        
        $a_tpl->setCurrentBlock("container_standard_row");
        $a_tpl->setVariable("BLOCK_ROW_CONTENT", $a_html);
        $a_tpl->parseCurrentBlock();
        
        $a_tpl->touchBlock("container_row");
    }
    
    protected function renderSelectAllBlock(ilTemplate $a_tpl)
    {
        $lng = $this->lng;
        
        $a_tpl->setCurrentBlock("select_all_row");
        $a_tpl->setVariable("CHECKBOXNAME", "bl_cb_" . $this->bl_cnt);
        $a_tpl->setVariable("SEL_ALL_PARENT", "bl_cntr_" . $this->bl_cnt);
        $a_tpl->setVariable("SEL_ALL_PARENT", "bl_cntr_" . $this->bl_cnt);
        $a_tpl->setVariable("TXT_SELECT_ALL", $lng->txt("select_all"));
        $a_tpl->parseCurrentBlock();
    }
    
    protected function addSeparatorRow(ilTemplate $a_tpl)
    {
        $a_tpl->setCurrentBlock("container_block");
        $a_tpl->parseCurrentBlock();
    }
    
    protected function resetRowType()
    {
        // :TODO: obsolete?
        $this->cur_row_type = "";
    }
    
    protected function getDownloadableTypes()
    {
        return array("fold", "file");
    }
    
    public function renderDetails(ilTemplate $a_tpl)
    {
        $lng = $this->lng;
        
        if (sizeof($this->details)) {
            $a_tpl->setCurrentBlock('container_details_row');
            $a_tpl->setVariable('TXT_DETAILS', $lng->txt('details'));
            $a_tpl->parseCurrentBlock();
        }
    }
}