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

Inheritance diagram for ILIAS\UI\Implementation\DefaultRenderer:

Collaboration diagram for ILIAS\UI\Implementation\DefaultRenderer:

Public Member Functions
	__construct (RootFactory $ui_factory, TemplateFactory $tpl_factory, ResourceRegistry $resource_registry, \ilLanguage $lng, JavaScriptBinding $js_binding)

	render (Component $component)
	@inheritdocs More...

	getRendererFor ($class)
	Get a renderer for a certain Component class. More...

	instantiateRendererFor ($class)
	Instantiate a renderer for a certain Component class. More...

	getRendererNameFor ($class)
	Get the class name for the renderer of Component class. More...

Public Member Functions inherited from ILIAS\UI\Renderer
	render (Component\Component $component)
	Render given component. More...

Private Attributes
	$ui_factory

	$cache = array()

	$tpl_factory

	$resource_registry

	$lng

	$js_binding

Detailed Description

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

Definition at line 19 of file DefaultRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\DefaultRenderer::__construct	(	RootFactory	$ui_factory,
		TemplateFactory	$tpl_factory,
		ResourceRegistry	$resource_registry,
		\ilLanguage	$lng,
		JavaScriptBinding	$js_binding
	)

Definition at line 50 of file DefaultRenderer.php.

                                                                                                                                                                                 {
                $this->ui_factory = $ui_factory;
                $this->tpl_factory = $tpl_factory;
                $this->resource_registry = $resource_registry;
                $this->lng = $lng;
                $this->js_binding = $js_binding;
        }

References ILIAS\UI\Implementation\DefaultRenderer\$js_binding, ILIAS\UI\Implementation\DefaultRenderer\$lng, ILIAS\UI\Implementation\DefaultRenderer\$resource_registry, ILIAS\UI\Implementation\DefaultRenderer\$tpl_factory, and ILIAS\UI\Implementation\DefaultRenderer\$ui_factory.

Member Function Documentation

◆ getRendererFor()

ILIAS\UI\Implementation\DefaultRenderer::getRendererFor ( $class )

Get a renderer for a certain Component class.

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

Parameters

string $class

Exceptions

LogicException if no renderer could be found for component.

Returns: ComponentRenderer

Definition at line 76 of file DefaultRenderer.php.

                                               {
                if (array_key_exists($class, $this->cache)) {
                        return $this->cache[$class];
                }
                $renderer = $this->instantiateRendererFor($class);
                $renderer->registerResources($this->resource_registry);
                $this->cache[$class] = $renderer;
                return $renderer;
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRendererNameFor()

ILIAS\UI\Implementation\DefaultRenderer::getRendererNameFor ( $class )

Get the class name for the renderer of Component class.

Parameters

string $class

Returns: string

Definition at line 109 of file DefaultRenderer.php.

                                                   {
                $parts = explode("\\", $class);
                $parts[count($parts)-1] = "Renderer";
                return implode("\\", $parts);
        }

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

Here is the caller graph for this function:

◆ instantiateRendererFor()

ILIAS\UI\Implementation\DefaultRenderer::instantiateRendererFor ( $class )

Instantiate a renderer for a certain Component class.

This will always create a fresh renderer for the component.

Parameters

string $class

Exceptions

LogicException if no renderer could be found for component.

Returns: ComponentRenderer

Definition at line 95 of file DefaultRenderer.php.

                                                       {
                $renderer_class = $this->getRendererNameFor($class);
                if (!class_exists($renderer_class)) {
                        throw new \LogicException("No rendered for '".$class."' found.");
                }
                return new $renderer_class($this->ui_factory, $this->tpl_factory, $this->lng, $this->js_binding);
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

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

@inheritdocs

Definition at line 61 of file DefaultRenderer.php.

                                                     {
                $renderer = $this->getRendererFor(get_class($component));
                return $renderer->render($component, $this);
        }

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

Here is the call graph for this function:

Field Documentation

◆ $cache

ILIAS\UI\Implementation\DefaultRenderer::$cache = array()

private

Definition at line 28 of file DefaultRenderer.php.

◆ $js_binding

ILIAS\UI\Implementation\DefaultRenderer::$js_binding

private

Definition at line 48 of file DefaultRenderer.php.

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

◆ $lng

ILIAS\UI\Implementation\DefaultRenderer::$lng

private

Definition at line 43 of file DefaultRenderer.php.

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

◆ $resource_registry

ILIAS\UI\Implementation\DefaultRenderer::$resource_registry

private

Definition at line 38 of file DefaultRenderer.php.

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

◆ $tpl_factory

ILIAS\UI\Implementation\DefaultRenderer::$tpl_factory

private

Definition at line 33 of file DefaultRenderer.php.

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

◆ $ui_factory

ILIAS\UI\Implementation\DefaultRenderer::$ui_factory

private

Definition at line 23 of file DefaultRenderer.php.

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

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

src/UI/Implementation/DefaultRenderer.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getRendererFor()

◆ getRendererNameFor()

◆ instantiateRendererFor()

◆ render()

Field Documentation

◆ $cache

◆ $js_binding

◆ $lng

◆ $resource_registry

◆ $tpl_factory

◆ $ui_factory