ILIAS\UI\Implementation\DefaultRenderer Class Reference

Renderer that dispatches rendering of UI components to a Renderer found in the same namespace as the component to be rendered. More...

Inheritance diagram for ILIAS\UI\Implementation\DefaultRenderer:

Collaboration diagram for ILIAS\UI\Implementation\DefaultRenderer:

Public Member Functions
	__construct (Render\Loader $component_renderer_loader)
	render ($component, ?Renderer $root=null)
	Render given component.If an array of components is passed, this method returns a concatenated output of each rendered component, in the same order as given in the array Parameters Component | Component[] $component ?Renderer $root of renderers in the chain to be used for rendering sub components. Returns string More...
	renderAsync ($component, ?Renderer $root=null)
	Same as render, except that this version also returns any javascript code bound to the on load event, wrapped in a script tag.All javascript code stored for rendering will be removed after this output so it will not be rendered twice if render async is called multiple times. Parameters Component | Component[] $component ?Renderer $root of renderers in the chain to be used for rendering sub components. Returns string More...
	withAdditionalContext (Component $context)
	Get a new renderer with an additional context.A context makes it possible to use another renderer for (some) components when they are renderer as subcomponents of a certain components. The use case that spawned this functionality is the observation, that e.g. items representing repository objects are renderer in different lists, where the individual items look different every time but are morally the same item. Another use case could be a special rendering of input fields in filters over tables.If a component wants to render itself differently in different contexts, it must implement a RendererFactory. The class \ILIAS\UI\Implementation\Render\FSLoader contains directions how to do that. More...
	render ($component, ?Renderer $root=null)
	Render given component. More...
	renderAsync ($component, ?Renderer $root=null)
	Same as render, except that this version also returns any javascript code bound to the on load event, wrapped in a script tag. More...
	withAdditionalContext (Component $context)
	Get a new renderer with an additional context. More...

Protected Member Functions
	getRendererFor (Component $component)
	Get a renderer for a certain Component class. More...
	getJSCodeForAsyncRenderingFor (Component $component)
	Get JS-Code for asynchronous rendering of component. More...
	getContexts ()
	Get the contexts that are added via withAdditionalContext where most recently added contexts come last. More...

Private Attributes
Render Loader	$component_renderer_loader
array	$contexts = []

Detailed Description

Renderer that dispatches rendering of UI components to a Renderer found in the same namespace as the component to be rendered.

Definition at line 32 of file DefaultRenderer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\UI\Implementation\DefaultRenderer::__construct

(

Render\Loader

$component_renderer_loader

)

Definition at line 41 of file DefaultRenderer.php.

    {
        $this->component_renderer_loader = $component_renderer_loader;
    }

References ILIAS\UI\Implementation\DefaultRenderer\$component_renderer_loader.

Member Function Documentation

getContexts()

ILIAS\UI\Implementation\DefaultRenderer::getContexts ( )

protected

Get the contexts that are added via withAdditionalContext where most recently added contexts come last.

Returns

Component[]

Definition at line 128 of file DefaultRenderer.php.

                                    : array
    {
        return $this->contexts;
    }

References ILIAS\UI\Implementation\DefaultRenderer\$contexts.

Referenced by TestDefaultRenderer\_getContexts(), and ILIAS\UI\Implementation\DefaultRenderer\getRendererFor().

Here is the caller graph for this function:

getJSCodeForAsyncRenderingFor()

ILIAS\UI\Implementation\DefaultRenderer::getJSCodeForAsyncRenderingFor ( Component  $component )

protected

Get JS-Code for asynchronous rendering of component.

Parameters

Component

$component

Returns

string

Definition at line 104 of file DefaultRenderer.php.

    {
        return $this->component_renderer_loader
            ->getRendererFactoryFor($component)
            ->getJSBinding()
            ->getOnLoadCodeAsync();
    }

Referenced by ILIAS\UI\Implementation\DefaultRenderer\renderAsync().

Here is the caller graph for this function:

getRendererFor()

ILIAS\UI\Implementation\DefaultRenderer::getRendererFor ( Component  $component )

protected

Get a renderer for a certain Component class.

Either initializes a new renderer or uses a cached one initialized before.

Exceptions

LogicException

if no renderer could be found for component.

Definition at line 93 of file DefaultRenderer.php.

                                                           : ComponentRenderer
    {
        return $this->component_renderer_loader->getRendererFor($component, $this->getContexts());
    }

References ILIAS\UI\Implementation\DefaultRenderer\getContexts().

Referenced by ILIAS\UI\Implementation\DefaultRenderer\render().

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ILIAS\UI\Implementation\DefaultRenderer::render	(		$component,
		?Renderer	$root = null
	)

Render given component.If an array of components is passed, this method returns a concatenated output of each rendered component, in the same order as given in the array

Parameters

Component | Component[]	$component
	?Renderer	$root of renderers in the chain to be used for rendering sub components.

Returns

string

Implements ILIAS\UI\Renderer.

Definition at line 49 of file DefaultRenderer.php.

    {
        $root = $root ?? $this;
 
        $out = '';
        if (is_array($component)) {
            foreach ($component as $_component) {
                $out .= $root->render($_component);
            }
        } else {
            $renderer = $this->getRendererFor($component);
            $out = $renderer->render($component, $root);
        }
 
        return $out;
    }

References $out, and ILIAS\UI\Implementation\DefaultRenderer\getRendererFor().

Referenced by ILIAS\UI\Implementation\DefaultRenderer\renderAsync().

Here is the call graph for this function:

Here is the caller graph for this function:

renderAsync()

ILIAS\UI\Implementation\DefaultRenderer::renderAsync	(		$component,
		?Renderer	$root = null
	)

Same as render, except that this version also returns any javascript code bound to the on load event, wrapped in a script tag.All javascript code stored for rendering will be removed after this output so it will not be rendered twice if render async is called multiple times.

Parameters

Component | Component[]	$component
	?Renderer	$root of renderers in the chain to be used for rendering sub components.

Returns

string

Implements ILIAS\UI\Renderer.

Definition at line 69 of file DefaultRenderer.php.

    {
        $root = $root ?? $this;
 
        $out = '';
        if (is_array($component)) {
            foreach ($component as $_component) {
                $out .= $root->renderAsync($_component);
            }
        } else {
            $out = $this->render($component, $root) .
            $this->getJSCodeForAsyncRenderingFor($component);
        }
        return $out;
    }

References $out, ILIAS\UI\Implementation\DefaultRenderer\getJSCodeForAsyncRenderingFor(), and ILIAS\UI\Implementation\DefaultRenderer\render().

Here is the call graph for this function:

withAdditionalContext()

ILIAS\UI\Implementation\DefaultRenderer::withAdditionalContext

(

Component

$context

)

Get a new renderer with an additional context.A context makes it possible to use another renderer for (some) components when they are renderer as subcomponents of a certain components. The use case that spawned this functionality is the observation, that e.g. items representing repository objects are renderer in different lists, where the individual items look different every time but are morally the same item. Another use case could be a special rendering of input fields in filters over tables.If a component wants to render itself differently in different contexts, it must implement a RendererFactory. The class \ILIAS\UI\Implementation\Render\FSLoader contains directions how to do that.

Implements ILIAS\UI\Renderer.

Definition at line 115 of file DefaultRenderer.php.

                                                             : Renderer
    {
        $clone = clone $this;
        $clone->contexts[] = $context;
        return $clone;
    }

References $context.

Field Documentation

$component_renderer_loader

Render Loader ILIAS\UI\Implementation\DefaultRenderer::$component_renderer_loader

private

Definition at line 34 of file DefaultRenderer.php.

Referenced by ILIAS\UI\Implementation\DefaultRenderer\__construct(), and TestDefaultRenderer\__construct().

$contexts

array ILIAS\UI\Implementation\DefaultRenderer::$contexts = []

private

Definition at line 39 of file DefaultRenderer.php.

Referenced by ILIAS\UI\Implementation\DefaultRenderer\getContexts().

---

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

• src/UI/Implementation/DefaultRenderer.php