class.ilButton.php

Go to the documentation of this file.

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

require_once 'Services/UIComponent/Button/classes/class.ilButtonBase.php';

class ilButton extends ilButtonBase
{
        const BUTTON_TYPE_BUTTON = 'button';

        const BUTTON_TYPE_SUBMIT = 'submit';

        const BUTTON_TYPE_RESET = 'reset';

        const FORM_ENC_TYPE_APPLICATION = 'application/x-www-form-urlencoded';

        const FORM_ENC_TYPE_MULTI_PART = 'multipart/form-data';

        const FORM_ENC_TYPE_PLAIN = 'text/plain';

        const FORM_METHOD_POST = 'POST';

        const FORM_METHOD_GET = 'GET';

        const FORM_TARGET_SELF = '_self';

        const FORM_TARGET_BLANK = '_blank';

        const FORM_TARGET_PARENT = '_parent';

        const FORM_TARGET_TOP = '_top';

        protected $button_type = self::BUTTON_TYPE_SUBMIT;

        protected $name = null;

        protected $value = null;

        protected $form = null;

        protected $form_action = null;

        protected $form_enc_type = null;

        protected $form_method = null;

        protected $form_target = null;

        protected $form_novalidate = null;

        public static function getInstance()
        {
                return new self(self::TYPE_BUTTON);
        }

        public static function getValidFormTargets()
        {
                return array(
                        self::FORM_TARGET_BLANK,
                        self::FORM_TARGET_PARENT,
                        self::FORM_TARGET_SELF,
                        self::FORM_TARGET_TOP
                );
        }

        public static function getValidFormMethods()
        {
                return array(
                        self::FORM_METHOD_POST,
                        self::FORM_METHOD_GET
                );
        }

        public static function getValidFormEncTypes()
        {
                return array(
                        self::FORM_ENC_TYPE_APPLICATION,
                        self::FORM_ENC_TYPE_MULTI_PART,
                        self::FORM_ENC_TYPE_PLAIN
                );
        }

        public static function getValidButtonTypes()
        {
                return array(
                        self::BUTTON_TYPE_SUBMIT,
                        self::BUTTON_TYPE_BUTTON,
                        self::BUTTON_TYPE_RESET
                );
        }

        public function isFormNovalidate()
        {
                return $this->form_novalidate;
        }

        public function setFormNovalidate($form_novalidate)
        {
                if(!is_bool($form_novalidate))
                {
                        throw new InvalidArgumentException(
                                sprintf("Please pass a value of type 'boolean' to specify whether the form is not to be validated when it is submitted")
                        );
                }

                $this->form_novalidate = $form_novalidate;
                return $this;
        }

        public function getFormTarget()
        {
                return $this->form_target;
        }

        public function setFormTarget($form_target)
        {
                if(!in_array($form_target, self::getValidFormTargets()))
                {
                        throw new InvalidArgumentException(
                                sprintf(
                                        "Invalid form target passed, must be one of these: %s",
                                        implode(', ', self::getValidFormTargets())
                                )
                        );
                }

                $this->form_target = $form_target;
                return $this;
        }

        public function getFormMethod()
        {
                return $this->form_method;
        }

        public function setFormMethod($form_method)
        {
                if(!in_array($form_method, self::getValidFormMethods()))
                {
                        throw new InvalidArgumentException(
                                sprintf(
                                        "Invalid form method passed, must be one of these: %s",
                                        implode(', ', self::getValidFormMethods())
                                )
                        );
                }

                $this->form_method = $form_method;
                return $this;
        }

        public function getFormEncType()
        {
                return $this->form_enc_type;
        }

        public function setFormEncType($form_enc_type)
        {
                if(!in_array($form_enc_type, self::getValidFormEncTypes()))
                {
                        throw new InvalidArgumentException(
                                sprintf(
                                        "Invalid form enc type passed, must be one of these: %s",
                                        implode(', ', self::getValidFormEncTypes())
                                )
                        );
                }

                $this->form_enc_type = $form_enc_type;
                return $this;
        }

        public function getFormAction()
        {
                return $this->form_action;
        }

        public function setFormAction($form_action)
        {
                if(!is_string($form_action))
                {
                        throw new InvalidArgumentException(
                                sprintf("The form action must be of type 'string'")
                        );
                }

                $this->form_action = $form_action;
                return $this;
        }

        public function getForm()
        {
                return $this->form;
        }

        public function setForm($form)
        {
                if(!is_string($form))
                {
                        throw new InvalidArgumentException(
                                sprintf("The form id must be of type 'string'")
                        );
                }

                $this->form = $form;
                return $this;
        }

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

        public function setValue($value)
        {
                if(!is_string($value))
                {
                        throw new InvalidArgumentException(
                                sprintf("The initial value of the button must be of type 'string'")
                        );
                }

                $this->value = $value;
                return $this;
        }

        public function getName()
        {
                return $this->name;
        }

        public function setName($name, $is_command = true)
        {
                if(!is_string($name))
                {
                        throw new InvalidArgumentException(
                                sprintf("The name of the button must be of type 'string'")
                        );
                }

                $this->name = $is_command ? 'cmd[' . $name . ']' : $name;
                return $this;
        }

        public function getButtonType()
        {
                return $this->button_type;
        }

        public function setButtonType($button_type)
        {
                if(!in_array($button_type, self::getValidButtonTypes()))
                {
                        throw new InvalidArgumentException(
                                sprintf(
                                        "Invalid button type passed, must be one of these: %s",
                                        implode(', ', self::getValidButtonTypes())
                                )
                        );
                }

                $this->button_type = $button_type;
                return $this;
        }

        public function render()
        {
                $this->prepareRender();

                $attr                   = array();
                $attr['type']           = $this->getButtonType();
                $attr['name']           = $this->getName();
                $attr['value']          = $this->getValue();
                $attr['form']           = $this->getForm();
                $attr['formaction']     = $this->getFormAction();
                $attr['formmethod']     = $this->getFormMethod();
                $attr['formenctype']    = $this->getFormEncType();
                $attr['formtarget']     = $this->getFormTarget();
                $attr['formnovalidate'] = $this->isFormNovalidate() ? var_export($this->isFormNovalidate(), 1) : null;

                if (self::FORM_TARGET_BLANK === $this->getFormTarget()) {
                        $attr['rel'] = 'noopener';
                }

                return '<button' . $this->renderAttributes(array_filter($attr)) . '>' . $this->getCaption() . '</button>';
        }
}