ILIAS\UI\Implementation\Render\FSLoader Class Reference

Loads renderers for components from the file system. More...

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

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

Public Member Functions
	__construct (private RendererFactory $default_renderer_factory, private RendererFactory $glyph_renderer_factory, private RendererFactory $field_renderer_factory, private RendererFactory $message_box_renderer_factory, private RendererFactory $form_renderer_factory, private RendererFactory $menu_renderer_factory,)
	getRendererFor (Component $component, array $contexts)
	@inheritdocs More...
	getRendererFactoryFor (Component $component)
	@inheritdocs More...
	getRendererFor (Component $component, array $contexts)
	Get a renderer for a certain Component class. More...
	getRendererFactoryFor (Component $component)
	Get a factory for a renderer for a certain component class. More...

Detailed Description

Loads renderers for components from the file system.

To introduce a component that may react on the context of the rendering, you need to:

• create a new implementation of RendererFactory in the implementation folder of that component
• introduce it as a dependency of this loader (and load at ilInitialisation::initUIFramework)
• make a special case for the components the new factory may create renderers for in FSLoader::getRendererFactoryFor

Definition at line 42 of file FSLoader.php.

Constructor & Destructor Documentation

__construct()

ILIAS\UI\Implementation\Render\FSLoader::__construct	(	private RendererFactory	$default_renderer_factory,
		private RendererFactory	$glyph_renderer_factory,
		private RendererFactory	$field_renderer_factory,
		private RendererFactory	$message_box_renderer_factory,
		private RendererFactory	$form_renderer_factory,
		private RendererFactory	$menu_renderer_factory
	)

Definition at line 46 of file FSLoader.php.

      {
    }

Member Function Documentation

getRendererFactoryFor()

ILIAS\UI\Implementation\Render\FSLoader::getRendererFactoryFor

(

Component

$component

)

@inheritdocs

Implements ILIAS\UI\Implementation\Render\Loader.

Definition at line 69 of file FSLoader.php.

                                                               : RendererFactory
    {
        if ($component instanceof Glyph) {
            return $this->glyph_renderer_factory;
        }
        if ($component instanceof FormInput) {
            return $this->field_renderer_factory;
        }
        if ($component instanceof MessageBox) {
            return $this->message_box_renderer_factory;
        }
        if ($component instanceof Form) {
            return $this->form_renderer_factory;
        }
        if ($component instanceof Menu) {
            return $this->menu_renderer_factory;
        }
 
        return $this->default_renderer_factory;
    }

Referenced by ILIAS\UI\Implementation\Render\FSLoader\getRendererFor().

Here is the caller graph for this function:

getRendererFor()

ILIAS\UI\Implementation\Render\FSLoader::getRendererFor	(	Component	$component,
		array	$contexts
	)

@inheritdocs

Implements ILIAS\UI\Implementation\Render\Loader.

Definition at line 59 of file FSLoader.php.

                                                                         : ComponentRenderer
    {
        $context_names = $this->getContextNames($contexts);
        $factory = $this->getRendererFactoryFor($component);
        return $factory->getRendererInContext($component, $context_names);
    }

References ILIAS\UI\Implementation\Render\FSLoader\getRendererFactoryFor().

Here is the call graph for this function:

---

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

• components/ILIAS/UI/src/Implementation/Render/FSLoader.php