class.ilToolbarGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */
 
class ilToolbarGUI
{
        var $items = array();
        var $open_form_tag = true;
        var $close_form_tag = true;
        var $form_target = "";
        var $form_name = "";
 
        protected $prevent_double_submission = false;
 
        function __construct()
        {
        
        }
 
        function setFormAction($a_val, $a_multipart = false, $a_target = "")
        {
                $this->form_action = $a_val;
                $this->multipart = $a_multipart;
                $this->form_target = $a_target;
        }
        
        function getFormAction()
        {
                return $this->form_action;
        }
 
        function setLeadingImage($a_img, $a_alt)
        {
                $this->lead_img = array("img" => $a_img, "alt" => $a_alt);
        }
        
        function setHidden($a_val)
        {
                $this->hidden = $a_val;
        }
        
        function getHidden()
        {
                return $this->hidden;
        }
        
        function setId($a_val)
        {
                $this->id = $a_val;
        }
        
        function getId()
        {
                return $this->id;
        }
 
        public function setPreventDoubleSubmission($a_val)
        {
                $this->prevent_double_submission = $a_val;
        }
 
        public function getPreventDoubleSubmission()
        {
                return $this->prevent_double_submission;
        }
        
        public function addButton($a_txt, $a_cmd, $a_target = "", $a_acc_key = "", $a_additional_attrs = '',
                $a_id = "", $a_class = 'submit')
        {
                $this->items[] = array("type" => "button", "txt" => $a_txt, "cmd" => $a_cmd,
                        "target" => $a_target, "acc_key" => $a_acc_key, 'add_attrs' => $a_additional_attrs,
                        "id" => $a_id, "class" => $a_class);
        }
 
        function addFormButton($a_txt, $a_cmd, $a_acc_key = "", $a_primary = false, $a_class = false)
        {
                $this->items[] = array("type" => "fbutton", "txt" => $a_txt, "cmd" => $a_cmd,
                        "acc_key" => $a_acc_key, "primary" => $a_primary, "class" => $a_class);
        }
        
        public function addInputItem(ilToolbarItem $a_item, $a_output_label = false)
        {
                $this->items[] = array("type" => "input", "input" => $a_item, "label" => $a_output_label);
        }
 
        public function addButtonInstance(ilButton $a_button)
        {
                $this->items[] = array("type" => "button_obj", "instance" => $a_button); 
        }
 
        // bs-patch start
        public function addDropDown($a_txt, $a_dd_html)
        {
                $this->items[] = array("type" => "dropdown", "txt" => $a_txt, "dd_html" => $a_dd_html);
        }
        // bs-patch end
 
        function addSeparator()
        {
                $this->items[] = array("type" => "separator");
        }
 
        function addText($a_text)
        {
                $this->items[] = array("type" => "text", "text" => $a_text);
        }
 
        function addSpacer($a_width = null)
        {
                $this->items[] = array("type" => "spacer", "width" => $a_width);
        }
 
 
        function addLink($a_caption, $a_url, $a_disabled = false)
        {
                $this->items[] = array("type" => "link", "txt" => $a_caption, "cmd" => $a_url, "disabled" => $a_disabled);
        }
 
        function setOpenFormTag($a_val)
        {
                $this->open_form_tag = $a_val;
        }
 
        function getOpenFormTag()
        {
                return $this->open_form_tag;
        }
 
        function setCloseFormTag($a_val)
        {
                $this->close_form_tag = $a_val;
        }
 
        function getCloseFormTag()
        {
                return $this->close_form_tag;
        }
 
        function setFormName($a_val)
        {
                $this->form_name = $a_val;
        }
 
        function getFormName()
        {
                return $this->form_name;
        }
 
        function getHTML()
        {
                global $lng;
                
                $tpl = new ilTemplate("tpl.toolbar.html", true, true, "Services/UIComponent/Toolbar");
                if (count($this->items) > 0)
                {
                        foreach($this->items as $item)
                        {
                                switch ($item["type"])
                                {
                                        case "button":                                          
                                                $tpl->setCurrentBlock("button");
                                                $tpl->setVariable("BTN_TXT", $item["txt"]);
                                                $tpl->setVariable("BTN_LINK", $item["cmd"]);
                                                if ($item["target"] != "")
                                                {
                                                        $tpl->setVariable("BTN_TARGET", 'target="'.$item["target"].'"');
                                                }
                                                if ($item["id"] != "")
                                                {
                                                        $tpl->setVariable("BID", 'id="'.$item["id"].'"');
                                                }
                                                if ($item["acc_key"] != "")
                                                {
                                                        include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
                                                        $tpl->setVariable("BTN_ACC_KEY",
                                                                ilAccessKeyGUI::getAttribute($item["acc_key"]));
                                                }
                                                if(($item['add_attrs']))
                                                {
                                                        $tpl->setVariable('BTN_ADD_ARG',$item['add_attrs']);
                                                }
                                                $tpl->setVariable('BTN_CLASS',$item['class']);
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                                break;
                                        
                                        case "fbutton":
                                                $tpl->setCurrentBlock("form_button");
                                                $tpl->setVariable("SUB_TXT", $item["txt"]);
                                                $tpl->setVariable("SUB_CMD", $item["cmd"]);
                                                if($item["primary"])
                                                {
                                                        $tpl->setVariable("SUB_CLASS", " emphsubmit");
                                                }
                                                else if($item["class"])
                                                {
                                                        $tpl->setVariable("SUB_CLASS", " ".$item["class"]);
                                                }
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                                break;
                                                
                                        case "button_obj":
                                                $tpl->setCurrentBlock("button_instance");
                                                $tpl->setVariable("BUTTON_OBJ", $item["instance"]->render());
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                                break;
                                                
                                        case "input":
                                                if ($item["label"])
                                                {
                                                        $tpl->setCurrentBlock("input_label");
                                                        $tpl->setVariable("TXT_INPUT", $item["input"]->getTitle());
                                                        $tpl->parseCurrentBlock();
                                                }
                                                $tpl->setCurrentBlock("input");
                                                $tpl->setVariable("INPUT_HTML", $item["input"]->getToolbarHTML());
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                                break;
 
                                        // bs-patch start
                                        case "dropdown":
                                                $tpl->setCurrentBlock("dropdown");
                                                $tpl->setVariable("TXT_DROPDOWN", $item["txt"]);
                                                $tpl->setVariable("DROP_DOWN", $item["dd_html"]);
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                                break;
                                        // bs-patch end
 
 
                                        case "separator":
                                                $tpl->touchBlock("separator");
                                                $tpl->touchBlock("item");
                                                break;
 
                                        case "text":
                                                $tpl->setCurrentBlock("text");
                                                $tpl->setVariable("VAL_TEXT", $item["text"]);
                                                $tpl->touchBlock("item");
                                                break;
 
                                        case "spacer":
                                                $tpl->touchBlock("spacer");
                                                if(!$item["width"])
                                                {
                                                        $item["width"] = 2;
                                                }
                                                $tpl->setVariable("SPACER_WIDTH", $item["width"]);
                                                $tpl->touchBlock("item");
                                                break;
 
                                        case "link":
                                                if ($item["disabled"] == false) {
                                                    $tpl->setCurrentBlock("link");
                                                    $tpl->setVariable("LINK_TXT", $item["txt"]);
                                                    $tpl->setVariable("LINK_URL", $item["cmd"]);
                                                    $tpl->parseCurrentBlock();
                                                    $tpl->touchBlock("item");
                                                    break;
                                                }
                                                else {
                                                    $tpl->setCurrentBlock("link_disabled");
                                                    $tpl->setVariable("LINK_DISABLED_TXT", $item["txt"]);
                                                    //$tpl->setVariable("LINK_URL", $item["cmd"]);
                                                    $tpl->parseCurrentBlock();
                                                    $tpl->touchBlock("item");
                                                    break;
                                                }
                                }
                        }
                        
                        $tpl->setVariable("TXT_FUNCTIONS", $lng->txt("functions"));
                        if ($this->lead_img["img"] != "")
                        {
                                $tpl->setCurrentBlock("lead_image");                            
                                $tpl->setVariable("IMG_SRC", $this->lead_img["img"]);
                                $tpl->setVariable("IMG_ALT", $this->lead_img["alt"]);
                                $tpl->parseCurrentBlock();
                        }
                        
                        // form?
                        if ($this->getFormAction() != "")
                        {
                                if ($this->getOpenFormTag())
                                {
                                        $tpl->setCurrentBlock("form_open");
                                        $tpl->setVariable("FORMACTION", $this->getFormAction());
                                        if($this->getPreventDoubleSubmission())
                                        {
                                                $tpl->setVariable("FORM_CLASS", "preventDoubleSubmission");
                                        }
                                        if ($this->multipart)
                                        {
                                                $tpl->setVariable("ENC_TYPE", 'enctype="multipart/form-data"');
                                        }
                                        if ($this->form_target != "")
                                        {
                                                $tpl->setVariable("TARGET", ' target="'.$this->form_target.'" ');
                                        }
                                        if ($this->form_name != "")
                                        {
                                                $tpl->setVariable("FORMNAME", 'name="'.$this->getFormName().'"');
                                        }
 
                                        $tpl->parseCurrentBlock();
                                }
                                if ($this->getCloseFormTag())
                                {
                                        $tpl->touchBlock("form_close");
                                }
                        }
                        
                        // id
                        if ($this->getId() != "")
                        {
                                $tpl->setVariable("ID", ' id="'.$this->getId().'" ');
                        }
                        
                        // hidden style
                        if ($this->getHidden())
                        {
                                $tpl->setVariable("HIDDEN_CLASS", 'ilNoDisplay');
                        }
                        
                        return $tpl->get();
                }
                return "";
        }
}