Base class for all component renderers. More...

Inheritance diagram for ILIAS\UI\Implementation\Render\AbstractComponentRenderer:

Collaboration diagram for ILIAS\UI\Implementation\Render\AbstractComponentRenderer:

Public Member Functions
	__construct (private FactoryInternal $ui_factory, private TemplateFactory $tpl_factory, private Language $lng, private JavaScriptBinding $js_binding, private ImagePathResolver $image_path_resolver, private DataFactory $data_factory, private HelpTextRetriever $help_text_retriever, private UploadLimitResolver $upload_limit_resolver,)

	registerResources (ResourceRegistry $registry)
	Announce resources this renderer requires. More...

	txt (string $id)
	Get a text from the language file. More...

	toJS ($key)
	Add language var to client side (il.Language) More...

	getLangKey ()
	Get current language key. More...

	getImagePathResolver ()

	getHelpText (Help\Purpose $purpose, Help\Topic ... $topics)

	getComponentCanonicalNameAttribute (Component $component)

Public Member Functions inherited from ILIAS\UI\Implementation\Render\ComponentRenderer
	render (Component $component, Renderer $default_renderer)
	Render the component if possible and delegate additional rendering to the default_renderer. More...

	registerResources (ResourceRegistry $registry)
	Announce resources this renderer requires. More...

Public Member Functions inherited from ILIAS\UI\HelpTextRetriever
	getHelpText (Help\Purpose $purpose, Help\Topic ... $topics)
	Try to find according help texts for the purpose an topics. More...

Protected Member Functions
	getUIFactory ()
	Get a UI factory. More...

	getDataFactory ()

	getUploadLimitResolver ()

	getJavascriptBinding ()

	getTemplate (string $name, bool $purge_unfilled_vars, bool $purge_unused_blocks)
	Get template of component this renderer is made for. More...

	getTemplatePath (string $name)
	Get the path to the template of this component. More...

	bindJavaScript (JavaScriptBindable $component)
	Bind the component to JavaScript. More...

	createId ()
	Get a fresh unique id. More...

	addTriggererOnLoadCode (Triggerer $triggerer)
	Add onload-code for triggerer. More...

	cannotHandleComponent (Component $component)
	This method MUST be called by derived component renderers, if. More...

	getTooltipRenderer ()

	convertSpecialCharacters (string $value)

Protected Attributes
TooltipRenderer	$tooltip_renderer = null

Private Member Functions
	getTemplateRaw (string $path, bool $purge_unfilled_vars, bool $purge_unused_blocks)
	Get a template from any path. More...

	bindOnloadCode (JavaScriptBindable $component)
	Bind the JavaScript onload-code. More...

	getMyComponent ()

Static Private Attributes
static array	$component_storage

Detailed Description

Base class for all component renderers.

Offers some convenience methods for renderes, users only needs to implement ComponentRenderer::render. Assumes that there is no special resource the component requires.

Definition at line 43 of file AbstractComponentRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::__construct	(	private FactoryInternal	$ui_factory,
		private TemplateFactory	$tpl_factory,
		private Language	$lng,
		private JavaScriptBinding	$js_binding,
		private ImagePathResolver	$image_path_resolver,
		private DataFactory	$data_factory,
		private HelpTextRetriever	$help_text_retriever,
		private UploadLimitResolver	$upload_limit_resolver
	)

final

Definition at line 47 of file AbstractComponentRenderer.php.

56 {

57 }

Member Function Documentation

◆ addTriggererOnLoadCode()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::addTriggererOnLoadCode ( Triggerer $triggerer )

finalprotected

Add onload-code for triggerer.

Definition at line 201 of file AbstractComponentRenderer.php.

                                                                         : Triggerer
    {
        $triggered_signals = $triggerer->getTriggeredSignals();
        if (count($triggered_signals) == 0) {
            return $triggerer;
        }
        return $triggerer->withAdditionalOnLoadCode(function ($id) use ($triggered_signals): string {
            $code = "";
            foreach ($triggered_signals as $triggered_signal) {
                $signal = $triggered_signal->getSignal();
                $event = $triggered_signal->getEvent();
                $options = json_encode($signal->getOptions());
                //Note this switch is necessary since $(#...).on('load', ...) could be fired before the binding of the event.
                //Same seems true fro ready, see: #27456
                if ($event == 'load' || $event == 'ready') {
                    $code .=
                            "$(document).trigger('$signal',
                                                        {
                                                                'id' : '$signal', 'event' : '$event',
                                                                'triggerer' : $('#$id'),
                                                                'options' : JSON.parse('$options')
                                                        }
                                                );";
                } else {
                    $code .=
                    "$('#$id').on('$event', function(event) {
                                                $(this).trigger('$signal',
                                                        {
                                                                'id' : '$signal', 'event' : '$event',
                                                                'triggerer' : $(this),
                                                                'options' : JSON.parse('$options')
                                                        }
                                                );
                                                return false;
                                        });";
                }
            }
            return $code;
        });
    }

References $id, ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\UI\Component\Triggerer\getTriggeredSignals(), and ILIAS\UI\Component\JavaScriptBindable\withAdditionalOnLoadCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bindJavaScript()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::bindJavaScript ( JavaScriptBindable $component )

finalprotected

Bind the component to JavaScript.

ATTENTION: If this returns an id, the returned id has to be included as id-attribute into the HTML of your component.

Definition at line 154 of file AbstractComponentRenderer.php.

                                                                          : ?string
    {
        return $this->bindOnloadCode($component);
    }

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\bindOnloadCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bindOnloadCode()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::bindOnloadCode ( JavaScriptBindable $component )

private

Bind the JavaScript onload-code.

Definition at line 179 of file AbstractComponentRenderer.php.

                                                                  : ?string
    {
        $binder = $component->getOnLoadCode();
        if ($binder === null) {
            return null;
        }
 
        $id = $this->js_binding->createId();
        $on_load_code = $binder($id);
        if (!is_string($on_load_code)) {
            throw new LogicException(
                "Expected JavaScript binder to return string" .
                " (used component: " . get_class($component) . ")"
            );
        }
        $this->js_binding->addOnLoadCode($on_load_code);
        return $id;
    }

References $id, and ILIAS\UI\Component\JavaScriptBindable\getOnLoadCode().

Referenced by ILIAS\UI\Implementation\Render\AbstractComponentRenderer\bindJavaScript().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cannotHandleComponent()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::cannotHandleComponent ( Component $component )

finalprotected

This method MUST be called by derived component renderers, if.

See also: ComponentRenderer::render() cannot handle the provided component.

Definition at line 246 of file AbstractComponentRenderer.php.

                                                                        : never
    {
        throw new LogicException(
            sprintf(
                "%s could not render component %s",
                static::class,
                get_class($component)
            )
        );
    }

Here is the caller graph for this function:

◆ convertSpecialCharacters()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::convertSpecialCharacters ( string $value )

protected

Definition at line 304 of file AbstractComponentRenderer.php.

                                                              : string
    {
        return htmlspecialchars($value, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8');
    }

Referenced by ILIAS\UI\Implementation\Component\Input\Field\Node\Renderer\addNodeCharacteristics(), ILIAS\UI\Implementation\Component\Symbol\Icon\Renderer\render(), and ILIAS\UI\Implementation\Component\Symbol\Icon\Renderer\renderLabel().

Here is the caller graph for this function:

◆ createId()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::createId ( )

finalprotected

Get a fresh unique id.

ATTENTION: This does not take care about any usage scenario of the provided id. If you want to use it to bind JS-code to a component, you most probably would want to use bindJavaScript instead, which returns an id that is used to bind js to a component.

However, there are cases (e.g radio-input) where an id is required even if there is no javascript involved (e.g. to connect a label with an option), this is where this method could come in handy.

Definition at line 171 of file AbstractComponentRenderer.php.

                                       : string
    {
        return $this->js_binding->createId();
    }

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\renderButton(), ILIAS\UI\Implementation\Component\Input\ViewControl\Renderer\renderFieldSelection(), ILIAS\UI\Implementation\Component\Dropdown\Renderer\renderId(), ILIAS\UI\Implementation\Component\Progress\Renderer\renderProgressBar(), ILIAS\UI\Implementation\Component\Button\Renderer\renderToggle(), and ILIAS\UI\Implementation\Component\Input\Field\Renderer\wrapInFormContext().

Here is the caller graph for this function:

◆ getComponentCanonicalNameAttribute()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getComponentCanonicalNameAttribute ( Component $component )

Definition at line 309 of file AbstractComponentRenderer.php.

                                                                            : string
    {
        return str_replace(' ', '-', strtolower($component->getCanonicalName()));
    }

References ILIAS\UI\Component\Component\getCanonicalName().

Here is the call graph for this function:

◆ getDataFactory()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getDataFactory ( )

finalprotected

Definition at line 77 of file AbstractComponentRenderer.php.

                                             : DataFactory
    {
        return $this->data_factory;
    }

◆ getHelpText()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getHelpText	(	Help\Purpose	$purpose,
		Help\Topic ...	$topics
	)

Definition at line 283 of file AbstractComponentRenderer.php.

                                                                             : array
    {
        return $this->help_text_retriever->getHelpText($purpose, ...$topics);
    }

References ILIAS\GlobalScreen\Scope\$topics.

◆ getImagePathResolver()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getImagePathResolver ( )

Definition at line 278 of file AbstractComponentRenderer.php.

                                          : ImagePathResolver
    {
        return $this->image_path_resolver;
    }

Referenced by ILIAS\UI\Implementation\Component\Symbol\Icon\Renderer\getStandardIconPath().

Here is the caller graph for this function:

◆ getJavascriptBinding()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getJavascriptBinding ( )

finalprotected

Definition at line 112 of file AbstractComponentRenderer.php.

                                                   : JavaScriptBinding
    {
        return $this->js_binding;
    }

Referenced by ILIAS\UI\Implementation\Component\Input\ViewControl\Renderer\renderFieldSelection().

Here is the caller graph for this function:

◆ getLangKey()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getLangKey ( )

Get current language key.

Definition at line 107 of file AbstractComponentRenderer.php.

                                : string
    {
        return $this->lng->getLangKey();
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getMyComponent()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getMyComponent ( )

private

Returns: mixed

Definition at line 260 of file AbstractComponentRenderer.php.

    {
        $class = get_class($this);
        if (isset(self::$component_storage[$class])) {
            return self::$component_storage[$class];
        }
        $matches = array();
        // Extract component
        $re = "%ILIAS\\\\UI\\\\Implementation\\\\Component\\\\(\\w+)\\\\(\\w+)%";
        preg_match($re, $class, $matches);
        if (preg_match($re, $class, $matches) !== 1) {
            throw new LogicException("The Renderer needs to be located in ILIAS\\UI\\Implementation\\Component\\*.");
        }
        self::$component_storage[$class] = $matches[1];
 
        return self::$component_storage[$class];
    }

Referenced by ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplatePath().

Here is the caller graph for this function:

◆ getTemplate()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getTemplate	(	string	$name,
		bool	$purge_unfilled_vars,
		bool	$purge_unused_blocks
	)

finalprotected

Get template of component this renderer is made for.

Serves as a wrapper around instantiation of ilTemplate, exposes a smaller interface.

Exceptions

InvalidArgumentException if there is no such template

Definition at line 125 of file AbstractComponentRenderer.php.

                                                                                                            : Template
    {
        $path = $this->getTemplatePath($name);
        return $this->getTemplateRaw($path, $purge_unfilled_vars, $purge_unused_blocks);
    }

References $path, ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplatePath(), and ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplateRaw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplatePath()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getTemplatePath ( string $name )

protected

Get the path to the template of this component.

Definition at line 134 of file AbstractComponentRenderer.php.

                                                    : string
    {
        $component = $this->getMyComponent();
        return "components/ILIAS/UI/src/templates/default/$component/$name";
    }

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getMyComponent().

Referenced by ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplateRaw()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getTemplateRaw	(	string	$path,
		bool	$purge_unfilled_vars,
		bool	$purge_unused_blocks
	)

private

Get a template from any path.

Definition at line 143 of file AbstractComponentRenderer.php.

                                                                                                       : Template
    {
        return $this->tpl_factory->getTemplate($path, $purge_unfilled_vars, $purge_unused_blocks);
    }

References $path.

Referenced by ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate(), and ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTooltipRenderer().

Here is the caller graph for this function:

◆ getTooltipRenderer()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getTooltipRenderer ( )

protected

Definition at line 293 of file AbstractComponentRenderer.php.

                                           : TooltipRenderer
    {
        if ($this->tooltip_renderer === null) {
            $this->tooltip_renderer = new TooltipRenderer(
                $this,
                fn($path, $f1, $f2) => $this->getTemplateRaw($path, $f1, $f2)
            );
        }
        return $this->tooltip_renderer;
    }

References $path, ILIAS\UI\Implementation\Render\AbstractComponentRenderer\$tooltip_renderer, and ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplateRaw().

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\renderButton(), and ILIAS\UI\Implementation\Component\Button\Renderer\renderToggle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUIFactory()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getUIFactory ( )

finalprotected

Get a UI factory.

This could be used to create and render subcomponents like close buttons, etc.

Definition at line 72 of file AbstractComponentRenderer.php.

                                           : FactoryInternal
    {
        return $this->ui_factory;
    }

Here is the caller graph for this function:

◆ getUploadLimitResolver()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::getUploadLimitResolver ( )

finalprotected

Definition at line 82 of file AbstractComponentRenderer.php.

                                                     : UploadLimitResolver
    {
        return $this->upload_limit_resolver;
    }

◆ registerResources()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::registerResources ( ResourceRegistry $registry )

Announce resources this renderer requires.

Implements ILIAS\UI\Implementation\Render\ComponentRenderer.

Definition at line 62 of file AbstractComponentRenderer.php.

                                                                 : void
    {
        $registry->register('assets/js/core.js');
    }

References ILIAS\UI\Implementation\Render\ResourceRegistry\register().

Here is the call graph for this function:

◆ toJS()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::toJS ( $key )

final

Add language var to client side (il.Language)

Parameters

mixed $key

Definition at line 99 of file AbstractComponentRenderer.php.

                                    : void
    {
        $this->lng->toJS($key);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ txt()

ILIAS\UI\Implementation\Render\AbstractComponentRenderer::txt ( string $id )

final

Get a text from the language file.

Definition at line 90 of file AbstractComponentRenderer.php.

                                         : string
    {
        return $this->lng->txt($id);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $component_storage

array ILIAS\UI\Implementation\Render\AbstractComponentRenderer::$component_storage

staticprivate

Definition at line 45 of file AbstractComponentRenderer.php.

◆ $tooltip_renderer

TooltipRenderer ILIAS\UI\Implementation\Render\AbstractComponentRenderer::$tooltip_renderer = null

protected

Definition at line 291 of file AbstractComponentRenderer.php.

Referenced by ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTooltipRenderer().

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

components/ILIAS/UI/src/Implementation/Render/AbstractComponentRenderer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTriggererOnLoadCode()

◆ bindJavaScript()

◆ bindOnloadCode()

◆ cannotHandleComponent()

◆ convertSpecialCharacters()

◆ createId()

◆ getComponentCanonicalNameAttribute()

◆ getDataFactory()

◆ getHelpText()

◆ getImagePathResolver()

◆ getJavascriptBinding()

◆ getLangKey()

◆ getMyComponent()

◆ getTemplate()

◆ getTemplatePath()

◆ getTemplateRaw()

◆ getTooltipRenderer()

◆ getUIFactory()

◆ getUploadLimitResolver()

◆ registerResources()

◆ toJS()

◆ txt()

Field Documentation

◆ $component_storage

◆ $tooltip_renderer