ILIAS\UI\Implementation\Component\Button Namespace Reference

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

Data Structures
class	Bulky
	Bulky Button. More...
class	Button
	This implements commonalities between standard and primary buttons. More...
class	Close
class	Factory
class	Minimize
class	Month
class	Primary
class	Renderer
class	Shy
class	Standard
class	Tag
class	Toggle

Functions
	isEngageable ()
	withEngagedState (bool $state)
	isEngaged ()
	withLoadingAnimationOnClick (bool $loading_animation_on_click=true)
	hasLoadingAnimationOnClick ()

Variables
trait	Engageable
	Trait Engageable. More...
bool	$engaged = false
trait	LoadingAnimationOnClick
	Implements LoadingAnimationOnClick interface. More...

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

Function Documentation

hasLoadingAnimationOnClick()

ILIAS\UI\Implementation\Component\Button\hasLoadingAnimationOnClick

(

)

Definition at line 45 of file LoadingAnimationOnClick.php.

                                                : bool
    {
        return $this->loading_animation_on_click;
    }

isEngageable()

ILIAS\UI\Implementation\Component\Button\isEngageable

(

)

Definition at line 36 of file Engageable.php.

                                  : bool
    {
        return $this->is_engageable;
    }

isEngaged()

ILIAS\UI\Implementation\Component\Button\isEngaged

(

)

Definition at line 56 of file Engageable.php.

References ILIAS\UI\Implementation\Component\Button\$engaged.

                               : bool
    {
        return $this->engaged;
    }

withEngagedState()

ILIAS\UI\Implementation\Component\Button\withEngagedState

(

bool

$state

)

Returns

static

Definition at line 45 of file Engageable.php.

Referenced by ILIAS\GlobalScreen\Scope\Layout\Provider\PagePart\StandardPagePartProvider\getContent(), ilCalendarHeaderNavigationGUI\getHTML(), ilTestPlayerLayoutProvider\getMainBarModification(), ilLMHtmlExportViewLayoutProvider\getMainBarModification(), and ILIAS\UI\Implementation\Component\MainControls\Renderer\renderTriggerButtonsAndSlates().

    {
        $clone = clone $this;
        $clone->is_engageable = true;
        $clone->engaged = $state;
        return $clone;
    }

Here is the caller graph for this function:

withLoadingAnimationOnClick()

ILIAS\UI\Implementation\Component\Button\withLoadingAnimationOnClick

(

bool

$loading_animation_on_click = true

)

Returns

static

Definition at line 35 of file LoadingAnimationOnClick.php.

Referenced by ilLearningHistoryGUI\renderButton(), and ilContainerRenderer\renderHelperGeneric().

    {
        $clone = clone $this;
        $clone->loading_animation_on_click = $loading_animation_on_click;
        return $clone;
    }

Here is the caller graph for this function:

Variable Documentation

$engaged

bool ILIAS::UI::Implementation::Component::Button\$engaged = false

protected

Definition at line 31 of file Engageable.php.

Referenced by ILIAS\UI\Implementation\Component\Button\isEngaged(), and ILIAS\UI\Implementation\Component\MainControls\Renderer\renderTriggerButtonsAndSlates().

Engageable

trait ILIAS::UI::Implementation::Component::Button\Engageable

Initial value:

{
    protected bool $is_engageable = false

Trait Engageable.

Makes a Button stateful. By default, a button is NOT stateful.

Definition at line 29 of file Engageable.php.

LoadingAnimationOnClick

trait ILIAS::UI::Implementation::Component::Button\LoadingAnimationOnClick

Initial value:

{
    protected bool $loading_animation_on_click = false

Implements LoadingAnimationOnClick interface.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file LoadingAnimationOnClick.php.