class.ilCheckboxListOverlayGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCheckboxListOverlayGUI
{
    protected $lng;

    private $items = array();
    
    public function __construct($a_id = "")
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->setId($a_id);
    }

    public function setId($a_val)
    {
        $this->id = $a_val;
    }
    
    public function getId()
    {
        return $this->id;
    }
    

    public function setLinkTitle($a_val)
    {
        $this->link_title = $a_val;
    }
    
    public function getLinkTitle()
    {
        return $this->link_title;
    }
    
    public function setItems($a_val)
    {
        $this->items = $a_val;
    }
    
    public function getItems()
    {
        return $this->items;
    }
    
    public function setSelectionHeaderClass($a_selectionheaderclass)
    {
        $this->selectionheaderclass = $a_selectionheaderclass;
    }

    public function getSelectionHeaderClass()
    {
        return $this->selectionheaderclass;
    }

    public function setFormCmd($a_val)
    {
        $this->form_cmd = $a_val;
    }
    
    public function getFormCmd()
    {
        return $this->form_cmd;
    }
    
    public function setFieldVar($a_val)
    {
        $this->field_var = $a_val;
    }
    
    public function getFieldVar()
    {
        return $this->field_var;
    }
    
    public function setHiddenVar($a_val)
    {
        $this->hidden_var = $a_val;
    }
    
    public function getHiddenVar()
    {
        return $this->hidden_var;
    }
    public function getHTML()
    {
        $lng = $this->lng;
        
        $items = $this->getItems();

        $tpl = new ilTemplate(
            "tpl.checkbox_list_overlay.html",
            true,
            true,
            "Services/UIComponent/CheckboxListOverlay",
            "DEFAULT",
            false,
            true
        );
                
        $tpl->setCurrentBlock("top_img");
        
        // do not repeat title (accessibility) -> empty alt
        $tpl->setVariable("TXT_SEL_TOP", $this->getLinkTitle());

        $tpl->parseCurrentBlock();
        
        reset($items);
        $cnt = 0;
        foreach ($items as $k => $v) {
            $tpl->setCurrentBlock("list_entry");
            $tpl->setVariable("VAR", $this->getFieldVar());
            $tpl->setVariable("VAL_ENTRY", $k);
            $tpl->setVariable("TXT_ENTRY", $v["txt"]);
            $tpl->setVariable("IDX_ENTRY", ++$cnt);
            if ($v["selected"]) {
                $tpl->setVariable("CHECKED", "checked='checked'");
            }
            $tpl->parseCurrentBlock();
        }
        
        $tpl->setVariable("ID", $this->getId());
        $tpl->setVariable("HIDDEN_VAR", $this->getHiddenVar());
        $tpl->setVariable("CMD_SUBMIT", $this->getFormCmd());
        $tpl->setVariable("VAL_SUBMIT", $lng->txt("refresh"));
        return $tpl->get();
    }
}