ILIAS  trunk Revision v11.0_alpha-1761-g6dbbfa7b760
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
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,)
 
 getRendererFor (Component $component, array $contexts)
 
 getRendererFactoryFor (Component $component)
 

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 41 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 
)

Definition at line 45 of file FSLoader.php.

51  {
52  }

Member Function Documentation

◆ getRendererFactoryFor()

ILIAS\UI\Implementation\Render\FSLoader::getRendererFactoryFor ( Component  $component)

Implements ILIAS\UI\Implementation\Render\Loader.

Definition at line 67 of file FSLoader.php.

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

67  : RendererFactory
68  {
69  if ($component instanceof Glyph) {
70  return $this->glyph_renderer_factory;
71  }
72  if ($component instanceof FormInput) {
73  return $this->field_renderer_factory;
74  }
75  if ($component instanceof MessageBox) {
76  return $this->message_box_renderer_factory;
77  }
78  if ($component instanceof Form) {
79  return $this->form_renderer_factory;
80  }
81 
82  return $this->default_renderer_factory;
83  }
+ Here is the caller graph for this function:

◆ getRendererFor()

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

Implements ILIAS\UI\Implementation\Render\Loader.

Definition at line 57 of file FSLoader.php.

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

57  : ComponentRenderer
58  {
59  $context_names = $this->getContextNames($contexts);
60  $factory = $this->getRendererFactoryFor($component);
61  return $factory->getRendererInContext($component, $context_names);
62  }
getRendererFactoryFor(Component $component)
Definition: FSLoader.php:67
+ Here is the call graph for this function:

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