This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilButton:

Collaboration diagram for ilButton:

Public Member Functions
	isFormNovalidate ()

	setFormNovalidate (bool $form_novalidate)
	If the button is a submit button, this Boolean attribute specifies that the form is not to be validated when it is submitted. More...

	getFormTarget ()

	setFormTarget (string $form_target)
	If the button is a submit button, this attribute is a name or keyword indicating where to display the response that is received after submitting the form. More...

	getFormMethod ()

	setFormMethod (string $form_method)
	If the button is a submit button, this attribute specifies the HTTP method that the browser uses to submit the form. More...

	getFormEncType ()

	setFormEncType (string $form_enc_type)
	If this attribute is specified, it overrides the enctype attribute of the button's form owner. More...

	getFormAction ()

	setFormAction (string $form_action)
	The URI of a program that processes the information submitted by the button. More...

	getForm ()

	setForm (string $form)
	The form element that the button is associated with (its form owner). More...

	getValue ()

	setValue (string $value)
	The initial value of the button. More...

	getName ()

	setName (string $name, bool $is_command=true)
	The name of the button, which is submitted with the form data. More...

	getButtonType ()

	setButtonType (string $button_type)

	render ()

Public Member Functions inherited from ilButtonBase
	__clone ()

	getType ()

	setId (?string $a_value)

	getId ()

	setCaption (string $a_value, bool $a_is_lng_id=true)

	getCaption (bool $a_translate=true)

	setPrimary (bool $a_value)

	isPrimary ()

	setOmitPreventDoubleSubmission (bool $a_value)
	Toggle double submission prevention status. More...

	getOmitPreventDoubleSubmission ()

	setOnClick (string $a_value)

	getOnClick ()

	setDisabled (bool $a_value)

	isDisabled ()

	addCSSClass (string $a_value)

	getCSSClasses ()

	applyDefaultCss (?bool $apply_default_css=null)

	render ()

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Static Public Member Functions
static	getInstance ()

static	getValidFormTargets ()

static	getValidFormMethods ()

static	getValidFormEncTypes ()

static	getValidButtonTypes ()

Static Public Member Functions inherited from ilButtonBase
static	getInstance ()

Data Fields
const	BUTTON_TYPE_BUTTON = 'button'
	The button has no default behavior. More...

const	BUTTON_TYPE_SUBMIT = 'submit'
	The button submits the form data to the server. More...

const	BUTTON_TYPE_RESET = 'reset'
	The button resets all the controls to their initial values. More...

const	FORM_ENC_TYPE_APPLICATION = 'application/x-www-form-urlencoded'
	The default value if the attribute is not specified. More...

const	FORM_ENC_TYPE_MULTI_PART = 'multipart/form-data'
	Use this value if you are using an <input> element with the type attribute set to file. More...

const	FORM_ENC_TYPE_PLAIN = 'text/plain'

const	FORM_METHOD_POST = 'POST'

const	FORM_METHOD_GET = 'GET'

const	FORM_TARGET_SELF = '_self'
	Load the response into the same browsing context as the current one. More...

const	FORM_TARGET_BLANK = '_blank'
	Load the response into a new unnamed browsing context. More...

const	FORM_TARGET_PARENT = '_parent'
	Load the response into the parent browsing context of the current one. More...

const	FORM_TARGET_TOP = '_top'
	Load the response into the top-level browsing context (that is, the browsing context that is an ancestor of the current one, and has no parent). More...

Data Fields inherited from ilButtonBase
const	TYPE_SUBMIT = 1

const	TYPE_LINK = 2

const	TYPE_SPLIT = 3

const	TYPE_BUTTON = 4

Protected Attributes
string	$button_type = self::BUTTON_TYPE_SUBMIT

string	$name = null

string	$value = null

string	$form = null

string	$form_action = null

string	$form_enc_type = null

string	$form_method = null

string	$form_target = null

bool	$form_novalidate = false

Protected Attributes inherited from ilButtonBase
ilLanguage	$lng

int	$type = 0

string	$id = ""

string	$caption = ""

bool	$caption_is_lng_id = false

bool	$primary = false

bool	$omit_prevent_double_submission = false

string	$onclick = ""

int	$acc_key = 0

bool	$disabled = false

array	$css = array()

bool	$apply_default_css = true

Additional Inherited Members
Protected Member Functions inherited from ilButtonBase
	__construct (int $a_type)

	setType (int $a_value)

	gatherCssClasses ()

	renderAttributesHelper (array $a_attr)

	renderAttributes (?array $a_additional_attr=null)
	Render current HTML attributes. More...

	prepareRender ()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Description: <button> (https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button) by Mozilla Contributors is licensed under CC-BY-SA 2.5.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Deprecated:: 9 Use KS Buttons instead

Definition at line 24 of file class.ilButton.php.

Member Function Documentation

◆ getButtonType()

ilButton::getButtonType ( )

Definition at line 319 of file class.ilButton.php.

References $button_type.

Referenced by render().

                                    : string
     {
         return $this->button_type;
     }

Here is the caller graph for this function:

◆ getForm()

ilButton::getForm ( )

Definition at line 251 of file class.ilButton.php.

References ILIAS\Repository\form().

Referenced by render().

                              : string
     {
         return $this->form ?? '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormAction()

ilButton::getFormAction ( )

Definition at line 229 of file class.ilButton.php.

References $form_action.

Referenced by render().

                                    : ?string
     {
         return $this->form_action;
     }

Here is the caller graph for this function:

◆ getFormEncType()

ilButton::getFormEncType ( )

Definition at line 205 of file class.ilButton.php.

References $form_enc_type.

Referenced by render().

                                     : ?string
     {
         return $this->form_enc_type;
     }

Here is the caller graph for this function:

◆ getFormMethod()

ilButton::getFormMethod ( )

Definition at line 181 of file class.ilButton.php.

References $form_method.

Referenced by render().

                                    : ?string
     {
         return $this->form_method;
     }

Here is the caller graph for this function:

◆ getFormTarget()

ilButton::getFormTarget ( )

Definition at line 154 of file class.ilButton.php.

References $form_target.

Referenced by render().

                                    : ?string
     {
         return $this->form_target;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilButton::getInstance ( )

static

Definition at line 91 of file class.ilButton.php.

                                         : self
     {
         return new self(self::TYPE_BUTTON);
     }

◆ getName()

ilButton::getName ( )

Definition at line 297 of file class.ilButton.php.

References $name.

Referenced by ilJsLinkButton\render(), and render().

                              : ?string
     {
         return $this->name;
     }

Here is the caller graph for this function:

◆ getValidButtonTypes()

static ilButton::getValidButtonTypes ( )

static

Definition at line 123 of file class.ilButton.php.

                                                 : array
     {
         return array(
             self::BUTTON_TYPE_SUBMIT,
             self::BUTTON_TYPE_BUTTON,
             self::BUTTON_TYPE_RESET
         );
     }

◆ getValidFormEncTypes()

static ilButton::getValidFormEncTypes ( )

static

Definition at line 114 of file class.ilButton.php.

                                                  : array
     {
         return array(
             self::FORM_ENC_TYPE_APPLICATION,
             self::FORM_ENC_TYPE_MULTI_PART,
             self::FORM_ENC_TYPE_PLAIN
         );
     }

◆ getValidFormMethods()

static ilButton::getValidFormMethods ( )

static

Definition at line 106 of file class.ilButton.php.

                                                 : array
     {
         return array(
             self::FORM_METHOD_POST,
             self::FORM_METHOD_GET
         );
     }

◆ getValidFormTargets()

static ilButton::getValidFormTargets ( )

static

Definition at line 96 of file class.ilButton.php.

                                                 : array
     {
         return array(
             self::FORM_TARGET_BLANK,
             self::FORM_TARGET_PARENT,
             self::FORM_TARGET_SELF,
             self::FORM_TARGET_TOP
         );
     }

◆ getValue()

ilButton::getValue ( )

Definition at line 276 of file class.ilButton.php.

References $value.

Referenced by render().

                               : ?string
     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ isFormNovalidate()

ilButton::isFormNovalidate ( )

Definition at line 132 of file class.ilButton.php.

References $form_novalidate.

Referenced by render().

                                       : ?bool
     {
         return $this->form_novalidate;
     }

Here is the caller graph for this function:

◆ render()

ilButton::render ( )

Definition at line 342 of file class.ilButton.php.

References getButtonType(), ilButtonBase\getCaption(), getForm(), getFormAction(), getFormEncType(), getFormMethod(), getFormTarget(), getName(), getValue(), isFormNovalidate(), null, ilButtonBase\prepareRender(), and ilButtonBase\renderAttributes().

                             : string
     {
         $this->prepareRender();
 
         $attr = [];
         $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>';
     }

Here is the call graph for this function:

◆ setButtonType()

ilButton::setButtonType ( string $button_type )

Exceptions

InvalidArgumentException

Definition at line 327 of file class.ilButton.php.

References $button_type.

                                                       : self
     {
         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;
     }

◆ setForm()

ilButton::setForm ( string $form )

The form element that the button is associated with (its form owner).

The value of the attribute must be the id attribute of a <form> element in the same document. If this attribute is not specified, the <button> element must be a descendant of a form element. This attribute enables you to place <button> elements anywhere within a document, not just as descendants of their <form> elements.

Exceptions

InvalidArgumentException

Definition at line 264 of file class.ilButton.php.

References $form, and ILIAS\Repository\form().

                                          : self
     {
         if (!is_string($form)) {
             throw new InvalidArgumentException(
                 "The form id must be of type 'string'"
             );
         }
 
         $this->form = $form;
         return $this;
     }

Here is the call graph for this function:

◆ setFormAction()

ilButton::setFormAction ( string $form_action )

The URI of a program that processes the information submitted by the button.

If specified, it overrides the action attribute of the button's form owner.

Exceptions

InvalidArgumentException

Definition at line 239 of file class.ilButton.php.

References $form_action.

                                                       : self
     {
         if (!is_string($form_action)) {
             throw new InvalidArgumentException(
                 "The form action must be of type 'string'"
             );
         }
 
         $this->form_action = $form_action;
         return $this;
     }

◆ setFormEncType()

ilButton::setFormEncType ( string $form_enc_type )

If this attribute is specified, it overrides the enctype attribute of the button's form owner.

Exceptions

InvalidArgumentException

Definition at line 214 of file class.ilButton.php.

References $form_enc_type.

                                                          : self
     {
         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;
     }

◆ setFormMethod()

ilButton::setFormMethod ( string $form_method )

If the button is a submit button, this attribute specifies the HTTP method that the browser uses to submit the form.

Exceptions

InvalidArgumentException

Definition at line 190 of file class.ilButton.php.

References $form_method.

                                                       : self
     {
         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;
     }

◆ setFormNovalidate()

ilButton::setFormNovalidate ( bool $form_novalidate )

If the button is a submit button, this Boolean attribute specifies that the form is not to be validated when it is submitted.

If this attribute is specified, it overrides the novalidate attribute of the button's form owner.

Exceptions

InvalidArgumentException

Definition at line 142 of file class.ilButton.php.

References $form_novalidate.

                                                             : self
     {
         if (!is_bool($form_novalidate)) {
             throw new InvalidArgumentException(
                 "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;
     }

◆ setFormTarget()

ilButton::setFormTarget ( string $form_target )

If the button is a submit button, this attribute is a name or keyword indicating where to display the response that is received after submitting the form.

This is a name of, or keyword for, a browsing context (for example, tab, window, or inline frame). If this attribute is specified, it overrides the target attribute of the button's form owner.

Exceptions

InvalidArgumentException

Definition at line 166 of file class.ilButton.php.

References $form_target.

                                                       : self
     {
         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;
     }

◆ setName()

ilButton::setName	(	string	$name,
		bool	$is_command = `true`
	)

The name of the button, which is submitted with the form data.

Parameters

bool $is_command if true, a cmd[] is wrapped around the passed name

Exceptions

InvalidArgumentException

Definition at line 307 of file class.ilButton.php.

References $name.

                                                                   : self
     {
         if (!is_string($name)) {
             throw new InvalidArgumentException(
                 "The name of the button must be of type 'string'"
             );
         }
 
         $this->name = $is_command ? 'cmd[' . $name . ']' : $name;
         return $this;
     }

◆ setValue()

ilButton::setValue ( string $value )

The initial value of the button.

Exceptions

InvalidArgumentException

Definition at line 285 of file class.ilButton.php.

References $value.

                                            : self
     {
         if (!is_string($value)) {
             throw new InvalidArgumentException(
                 "The initial value of the button must be of type 'string'"
             );
         }
 
         $this->value = $value;
         return $this;
     }

Field Documentation

◆ $button_type

string ilButton::$button_type = self::BUTTON_TYPE_SUBMIT

protected

Definition at line 81 of file class.ilButton.php.

Referenced by getButtonType(), and setButtonType().

◆ $form

string ilButton::$form = null

protected

Definition at line 84 of file class.ilButton.php.

Referenced by setForm().

◆ $form_action

string ilButton::$form_action = null

protected

Definition at line 85 of file class.ilButton.php.

Referenced by getFormAction(), and setFormAction().

◆ $form_enc_type

string ilButton::$form_enc_type = null

protected

Definition at line 86 of file class.ilButton.php.

Referenced by getFormEncType(), and setFormEncType().

◆ $form_method

string ilButton::$form_method = null

protected

Definition at line 87 of file class.ilButton.php.

Referenced by getFormMethod(), and setFormMethod().

◆ $form_novalidate

bool ilButton::$form_novalidate = false

protected

Definition at line 89 of file class.ilButton.php.

Referenced by isFormNovalidate(), and setFormNovalidate().

◆ $form_target

string ilButton::$form_target = null

protected

Definition at line 88 of file class.ilButton.php.

Referenced by getFormTarget(), and setFormTarget().

◆ $name

string ilButton::$name = null

protected

Definition at line 82 of file class.ilButton.php.

Referenced by getName(), and setName().

◆ $value

string ilButton::$value = null

protected

Definition at line 83 of file class.ilButton.php.

Referenced by getValue(), and setValue().

◆ BUTTON_TYPE_BUTTON

const ilButton::BUTTON_TYPE_BUTTON = 'button'

The button has no default behavior.

It can have client-side scripts associated with the element's events, which are triggered when the events occur.

Definition at line 30 of file class.ilButton.php.

◆ BUTTON_TYPE_RESET

const ilButton::BUTTON_TYPE_RESET = 'reset'

The button resets all the controls to their initial values.

Definition at line 41 of file class.ilButton.php.

◆ BUTTON_TYPE_SUBMIT

const ilButton::BUTTON_TYPE_SUBMIT = 'submit'

The button submits the form data to the server.

This is the default if the attribute is not specified, or if the attribute is dynamically changed to an empty or invalid value.

Definition at line 36 of file class.ilButton.php.

◆ FORM_ENC_TYPE_APPLICATION

const ilButton::FORM_ENC_TYPE_APPLICATION = 'application/x-www-form-urlencoded'

The default value if the attribute is not specified.

Definition at line 46 of file class.ilButton.php.

◆ FORM_ENC_TYPE_MULTI_PART

const ilButton::FORM_ENC_TYPE_MULTI_PART = 'multipart/form-data'

Use this value if you are using an <input> element with the type attribute set to file.

Definition at line 51 of file class.ilButton.php.

◆ FORM_ENC_TYPE_PLAIN

const ilButton::FORM_ENC_TYPE_PLAIN = 'text/plain'

Definition at line 53 of file class.ilButton.php.

◆ FORM_METHOD_GET

const ilButton::FORM_METHOD_GET = 'GET'

Definition at line 55 of file class.ilButton.php.

◆ FORM_METHOD_POST

const ilButton::FORM_METHOD_POST = 'POST'

Definition at line 54 of file class.ilButton.php.

◆ FORM_TARGET_BLANK

const ilButton::FORM_TARGET_BLANK = '_blank'

Load the response into a new unnamed browsing context.

Definition at line 66 of file class.ilButton.php.

◆ FORM_TARGET_PARENT

const ilButton::FORM_TARGET_PARENT = '_parent'

Load the response into the parent browsing context of the current one.

If there is no parent, this option behaves the same way as self::FORM_TARGET_SELF.

Definition at line 72 of file class.ilButton.php.

◆ FORM_TARGET_SELF

const ilButton::FORM_TARGET_SELF = '_self'

Load the response into the same browsing context as the current one.

This value is the default if the attribute is not specified.

Definition at line 61 of file class.ilButton.php.

◆ FORM_TARGET_TOP

const ilButton::FORM_TARGET_TOP = '_top'

Load the response into the top-level browsing context (that is, the browsing context that is an ancestor of the current one, and has no parent).

If there is no parent, this option behaves the same way as self::FORM_TARGET_SELF.

Definition at line 79 of file class.ilButton.php.

The documentation for this class was generated from the following file:

components/ILIAS/UIComponent/Button/classes/class.ilButton.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getButtonType()

◆ getForm()

◆ getFormAction()

◆ getFormEncType()

◆ getFormMethod()

◆ getFormTarget()

◆ getInstance()

◆ getName()

◆ getValidButtonTypes()

◆ getValidFormEncTypes()

◆ getValidFormMethods()

◆ getValidFormTargets()

◆ getValue()

◆ isFormNovalidate()

◆ render()

◆ setButtonType()

◆ setForm()

◆ setFormAction()

◆ setFormEncType()

◆ setFormMethod()

◆ setFormNovalidate()

◆ setFormTarget()

◆ setName()

◆ setValue()

Field Documentation

◆ $button_type

◆ $form

◆ $form_action

◆ $form_enc_type

◆ $form_method

◆ $form_novalidate

◆ $form_target

◆ $name

◆ $value

◆ BUTTON_TYPE_BUTTON

◆ BUTTON_TYPE_RESET

◆ BUTTON_TYPE_SUBMIT

◆ FORM_ENC_TYPE_APPLICATION

◆ FORM_ENC_TYPE_MULTI_PART

◆ FORM_ENC_TYPE_PLAIN

◆ FORM_METHOD_GET

◆ FORM_METHOD_POST

◆ FORM_TARGET_BLANK

◆ FORM_TARGET_PARENT

◆ FORM_TARGET_SELF

◆ FORM_TARGET_TOP