class.ilCheckboxInputGUI.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2007 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

class ilCheckboxInputGUI extends ilSubEnabledFormPropertyGUI
{
        protected $value = "1";
        protected $checked;
        protected $optiontitle = "";
        protected $additional_attributes = '';
        
        function __construct($a_title = "", $a_postvar = "")
        {
                parent::__construct($a_title, $a_postvar);
                $this->setType("checkbox");
        }

        function setValue($a_value)
        {
                $this->value = $a_value;
        }

        function getValue()
        {
                return $this->value;
        }

        function setChecked($a_checked)
        {
                $this->checked = $a_checked;
        }

        function getChecked()
        {
                return $this->checked;
        }

        function setOptionTitle($a_optiontitle)
        {
                $this->optiontitle = $a_optiontitle;
        }

        function getOptionTitle()
        {
                return $this->optiontitle;
        }

        function setValueByArray($a_values)
        {
                $this->setChecked($a_values[$this->getPostVar()]);
                foreach($this->getSubItems() as $item)
                {
                        $item->setValueByArray($a_values);
                }
        }
        
        function setAdditionalAttributes($a_attrs)
        {
                $this->additional_attributes = $a_attrs;
        }
        
        function getAdditionalAttributes()
        {
                return $this->additional_attributes;
        }

        function checkInput()
        {
                global $lng;
                
                $_POST[$this->getPostVar()] = 
                        ilUtil::stripSlashes($_POST[$this->getPostVar()]);

                $ok = $this->checkSubItemsInput();
                return $ok;
        }
        
        public function hideSubForm()
        {
                return !$this->getChecked();
        }

        function render()
        {
                $tpl = new ilTemplate("tpl.prop_checkbox.html", true, true, "Services/Form");
                
                $tpl->setVariable("POST_VAR", $this->getPostVar());
                $tpl->setVariable("ID", $this->getFieldId());
                $tpl->setVariable("PROPERTY_VALUE", $this->getValue());
                $tpl->setVariable("OPTION_TITLE", $this->getOptionTitle());
                if(strlen($this->getAdditionalAttributes()))
                {
                        $tpl->setVariable('PROP_CHECK_ATTRS',$this->getAdditionalAttributes());
                }
                if ($this->getChecked())
                {
                        $tpl->setVariable("PROPERTY_CHECKED",
                                'checked="checked"');
                }
                if ($this->getDisabled())
                {
                        $tpl->setVariable("DISABLED",
                                'disabled="disabled"');
                }
                return $tpl->get();
        }

        function insert(&$a_tpl)
        {
                $html = $this->render();

                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $html);
                $a_tpl->parseCurrentBlock();
        }

        function getTableFilterHTML()
        {
                $html = $this->render();
                return $html;
        }

        function serializeData()
        {
                return serialize($this->getChecked());
        }
        
        function unserializeData($a_data)
        {
                $data = unserialize($a_data);

                if ($data)
                {
                        $this->setValue($data);
                        $this->setChecked(true);
                }
        }

}