class.ilButton.php

Go to the documentation of this file.

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

abstract class ilButton
{
        protected $type; // [int]
        protected $id; // [string]
        protected $caption; // [string]
        protected $caption_is_lng_id; // [bool]
        protected $primary; // [bool]
        protected $omit_prevent_double_submission; // [bool]
        protected $onclick; // [string]
        protected $acc_key; // [string]
        protected $disabled; // [bool]
        protected $css = array(); // [array]
        
        const TYPE_SUBMIT = 1;
        const TYPE_LINK = 2;
        
        protected function __construct($a_type)
        {
                $this->setType($a_type);
        }
        
        public function __clone() 
        {
                $this->setId(null);
        }
        
        abstract public static function getInstance();
        
        
        //
        // properties
        //
        
        protected function setType($a_value)
        {
                $this->type = (int)$a_value;
        }
        
        public function getType()
        {
                return $this->type;
        }
                
        public function setId($a_value)
        {
                $this->id = $a_value;
        }
        
        public function getId()
        {
                return $this->id;
        }
        
        public function setCaption($a_value, $a_is_lng_id = true)
        {
                $this->caption = $a_value;
                $this->caption_is_lng_id = (bool)$a_is_lng_id;
        }
        
        public function getCaption($a_translate = true)
        {
                global $lng;
                
                $caption = $this->caption;
                
                if($this->caption_is_lng_id &&
                        (bool)$a_translate)
                {
                        $caption = $lng->txt($caption);
                }
        
                return $caption;
        }

        public function setPrimary($a_value)
        {
                $this->primary = (bool)$a_value;
        }
        
        public function isPrimary()
        {
                return $this->primary;
        }
        
        public function setOmitPreventDoubleSubmission($a_value)
        {
                $this->omit_prevent_double_submission = (bool)$a_value;
        }
        
        public function getOmitPreventDoubleSubmission()
        {
                return $this->omit_prevent_double_submission;
        }
        
        public function setOnClick($a_value)
        {
                $this->onclick = trim($a_value);
        }
        
        public function getOnClick()
        {
                return $this->onclick;
        }
        
        public function setAccessKey($a_value)
        {
                $this->acc_key = trim($a_value);
        }
        
        public function getAccessKey()
        {
                return $this->acc_key;
        }
        
        public function setDisabled($a_value)
        {
                $this->disabled = (bool)$a_value;
        }
        
        public function isDisabled()
        {
                return $this->disabled;
        }
        
        public function addCSSClass($a_value)
        {
                $this->css[] = $a_value;
        }
        
        public function getCSSClasses()
        {
                return $this->css;
        }               
        
        
        //
        // render
        //
        
        protected function gatherCssClasses()
        {
                $css = array_unique($this->getCSSClasses());
        
                if($this->isPrimary())
                {
                        $css[] = "btn-primary";
                }
                if($this->getOmitPreventDoubleSubmission())
                {
                        $css[] = "omitPreventDoubleSubmission";
                }
                
                return implode(" ", $css);
        }
        
        protected function renderAttributesHelper(array $a_attr)
        {
                $res = array();
                
                foreach($a_attr as $id => $value)
                {
                        if(trim($value))
                        {
                                $res[] = strtolower(trim($id)).'="'.$value.'"';
                        }
                }
                
                if(sizeof($res))
                {
                        return " ".implode(" ", $res);
                }
        }               
        
        protected function renderAttributes(array $a_additional_attr = null)
        {               
                $attr = array();
                $attr["id"] = $this->getId();
                $attr["class"] = $this->gatherCssClasses();
                $attr["onclick"] = $this->getOnClick();                         
                
                if($this->getAccessKey())
                {
                        include_once("./Services/Accessibility/classes/class.ilAccessKey.php");
                        $attr["accesskey"] = ilAccessKey::getKey($this->getAccessKey());
                }
                
                if($this->isDisabled())
                {
                        $attr["disabled"] = "disabled";
                }
                
                if(sizeof($a_additional_attr))
                {
                        $attr = array_merge($attr, $a_additional_attr);
                }
                
                return $this->renderAttributesHelper($attr);
        }
        
        protected function prepareRender()
        {               
                $this->addCSSClass("btn");
                $this->addCSSClass("btn-default");
        }
         
        abstract public function render();
}