ilSubmitButton Class Reference

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

Inheritance diagram for ilSubmitButton:

Collaboration diagram for ilSubmitButton:

Public Member Functions
	setCommand (string $a_value)
	Set submit command. More...
	getCommand ()
	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...
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Static Public Member Functions
static	getInstance ()
static	getInstance ()

Protected Attributes
string	$cmd = ""
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
Data Fields inherited from ilButtonBase
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2
const	TYPE_SPLIT = 3
const	TYPE_BUTTON = 4
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 Submit Button GUI

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Deprecated:

with ILIAS 12. Use KS Buttons instead

Definition at line 25 of file class.ilSubmitButton.php.

Member Function Documentation

getCommand()

ilSubmitButton::getCommand

(

)

Definition at line 47 of file class.ilSubmitButton.php.

                                : string
    {
        return $this->cmd;
    }

References $cmd.

Referenced by render().

Here is the caller graph for this function:

getInstance()

static ilSubmitButton::getInstance ( )

static

Reimplemented from ilButtonBase.

Definition at line 29 of file class.ilSubmitButton.php.

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

References ilButtonBase\TYPE_SUBMIT.

Referenced by ilToolbarGUI\addFormButton(), ilToolbarGUI\applyAutoStickyToSingleElement(), ilConfirmationGUI\getHTML(), and ilSearchBaseGUI\renderSearch().

Here is the caller graph for this function:

render()

ilSubmitButton::render

(

)

Reimplemented from ilButtonBase.

Definition at line 57 of file class.ilSubmitButton.php.

                            : string
    {
        $this->prepareRender();
 
        $attr = array();
        $attr["type"] = "submit";
        $attr["name"] = "cmd[" . $this->getCommand() . "]";
        $attr["value"] = $this->getCaption();
 
        return '<input' . $this->renderAttributes($attr) . ' />';
    }

References ilButtonBase\getCaption(), getCommand(), ilButtonBase\prepareRender(), and ilButtonBase\renderAttributes().

Here is the call graph for this function:

setCommand()

ilSubmitButton::setCommand

(

string

$a_value

)

Set submit command.

Definition at line 42 of file class.ilSubmitButton.php.

                                               : void
    {
        $this->cmd = trim($a_value);
    }

Field Documentation

$cmd

string ilSubmitButton::$cmd = ""

protected

Definition at line 27 of file class.ilSubmitButton.php.

Referenced by getCommand().

---

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

• components/ILIAS/UIComponent/Button/classes/class.ilSubmitButton.php