ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\UI\Implementation\Component\Panel\Listing\Renderer Class Reference
+ Inheritance diagram for ILIAS\UI\Implementation\Component\Panel\Listing\Renderer:
+ Collaboration diagram for ILIAS\UI\Implementation\Component\Panel\Listing\Renderer:

Public Member Functions

 render (C\Component $component, RendererInterface $default_renderer)
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Render\AbstractComponentRenderer
 __construct (private Factory $ui_factory, private TemplateFactory $tpl_factory, private ilLanguage $lng, private JavaScriptBinding $js_binding, private \ILIAS\Refinery\Factory $refinery, 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)
 
- 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...
 
- 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

 renderStandard (C\Panel\Listing\Listing $component, RendererInterface $default_renderer)
 
 parseHeader (C\Panel\Listing\Standard $component, RendererInterface $default_renderer, Template $tpl)
 
 getComponentInterfaceName ()
 
- Protected Member Functions inherited from ILIAS\UI\Implementation\Render\AbstractComponentRenderer
 getUIFactory ()
 Get a UI factory. More...
 
 getDataFactory ()
 
 getRefinery ()
 
 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...
 
 checkComponent (Component $component)
 Check if a given component fits this renderer and throw if that is not the case. More...
 
 getComponentInterfaceName ()
 Get the name of the component-interface this renderer is supposed to render. More...
 
 getTooltipRenderer ()
 

Additional Inherited Members

- Protected Attributes inherited from ILIAS\UI\Implementation\Render\AbstractComponentRenderer
TooltipRenderer $tooltip_renderer = null
 

Detailed Description

Definition at line 29 of file Renderer.php.

Member Function Documentation

◆ getComponentInterfaceName()

ILIAS\UI\Implementation\Component\Panel\Listing\Renderer::getComponentInterfaceName ( )
protected

Definition at line 91 of file Renderer.php.

91  : array
92  {
93  return array(C\Panel\Listing\Standard::class);
94  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ parseHeader()

ILIAS\UI\Implementation\Component\Panel\Listing\Renderer::parseHeader ( C\Panel\Listing\Standard  $component,
RendererInterface  $default_renderer,
Template  $tpl 
)
protected

Definition at line 61 of file Renderer.php.

Referenced by ILIAS\UI\Implementation\Component\Panel\Listing\Renderer\renderStandard().

65  : Template {
66  $title = $component->getTitle();
67  $actions = $component->getActions();
68  $view_controls = $component->getViewControls();
69 
70  if ($title !== "" || $actions || $view_controls) {
71  $tpl->setVariable("TITLE", $title);
72  if ($actions) {
73  $tpl->setVariable("ACTIONS", $default_renderer->render($actions));
74  }
75  if ($view_controls) {
76  foreach ($view_controls as $view_control) {
77  $tpl->setCurrentBlock("view_controls");
78  $tpl->setVariable("VIEW_CONTROL", $default_renderer->render($view_control));
79  $tpl->parseCurrentBlock();
80  }
81  }
82  $tpl->setCurrentBlock("heading");
83  $tpl->parseCurrentBlock();
84  }
85  return $tpl;
86  }
+ Here is the caller graph for this function:

◆ render()

ILIAS\UI\Implementation\Component\Panel\Listing\Renderer::render ( C\Component  $component,
RendererInterface  $default_renderer 
)

Definition at line 34 of file Renderer.php.

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\checkComponent(), and ILIAS\UI\Implementation\Component\Panel\Listing\Renderer\renderStandard().

34  : string
35  {
36  $this->checkComponent($component);
37 
38  if ($component instanceof C\Panel\Listing\Standard) {
39  return $this->renderStandard($component, $default_renderer);
40  }
41  return '';
42  }
checkComponent(Component $component)
Check if a given component fits this renderer and throw if that is not the case. ...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
renderStandard(C\Panel\Listing\Listing $component, RendererInterface $default_renderer)
Definition: Renderer.php:44
+ Here is the call graph for this function:

◆ renderStandard()

ILIAS\UI\Implementation\Component\Panel\Listing\Renderer::renderStandard ( C\Panel\Listing\Listing  $component,
RendererInterface  $default_renderer 
)
protected

Definition at line 44 of file Renderer.php.

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate(), and ILIAS\UI\Implementation\Component\Panel\Listing\Renderer\parseHeader().

Referenced by ILIAS\UI\Implementation\Component\Panel\Listing\Renderer\render().

44  : string
45  {
46  $tpl = $this->getTemplate("tpl.listing_standard.html", true, true);
47 
48  $tpl = $this->parseHeader($component, $default_renderer, $tpl);
49 
50  foreach ($component->getItemGroups() as $group) {
51  if ($group instanceof Group) {
52  $tpl->setCurrentBlock("group");
53  $tpl->setVariable("ITEM_GROUP", $default_renderer->render($group));
54  $tpl->parseCurrentBlock();
55  }
56  }
57 
58  return $tpl->get();
59  }
parseHeader(C\Panel\Listing\Standard $component, RendererInterface $default_renderer, Template $tpl)
Definition: Renderer.php:61
getTemplate(string $name, bool $purge_unfilled_vars, bool $purge_unused_blocks)
Get template of component this renderer is made for.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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