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

Protected Member Functions

 render_descriptive (Component\Listing\Descriptive $component, RendererInterface $default_renderer)
 
 render_simple (Component\Listing\Listing $component, RendererInterface $default_renderer)
 
 renderProperty (Component\Listing\Property $component, RendererInterface $default_renderer)
 
 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

- 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 Attributes inherited from ILIAS\UI\Implementation\Render\AbstractComponentRenderer
TooltipRenderer $tooltip_renderer = null
 

Detailed Description

Definition at line 31 of file Renderer.php.

Member Function Documentation

◆ getComponentInterfaceName()

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

Definition at line 129 of file Renderer.php.

129  : array
130  {
131  return [Component\Listing\Listing::class];
132  }

◆ render_descriptive()

ILIAS\UI\Implementation\Component\Listing\Renderer::render_descriptive ( Component\Listing\Descriptive  $component,
RendererInterface  $default_renderer 
)
protected

Definition at line 54 of file Renderer.php.

References ILIAS\LTI\ToolProvider\$key, and ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate().

57  : string {
58  $tpl = $this->getTemplate("tpl.descriptive.html", true, true);
59 
60  foreach ($component->getItems() as $key => $item) {
61  if (is_string($item)) {
62  $content = $item;
63  } else {
64  $content = $default_renderer->render($item);
65  }
66 
67  if (trim($content) != "") {
68  $tpl->setCurrentBlock("item");
69  $tpl->setVariable("DESCRIPTION", $key);
70  $tpl->setVariable("CONTENT", $content);
71  $tpl->parseCurrentBlock();
72  }
73  }
74  return $tpl->get();
75  }
getTemplate(string $name, bool $purge_unfilled_vars, bool $purge_unused_blocks)
Get template of component this renderer is made for.
string $key
Consumer key/client ID value.
Definition: System.php:193
+ Here is the call graph for this function:

◆ render_simple()

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

Definition at line 77 of file Renderer.php.

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate().

77  : string
78  {
79  $tpl_name = "";
80 
81  if ($component instanceof Component\Listing\Ordered) {
82  $tpl_name = "tpl.ordered.html";
83  }
84  if ($component instanceof Component\Listing\Unordered) {
85  $tpl_name = "tpl.unordered.html";
86  }
87 
88  $tpl = $this->getTemplate($tpl_name, true, true);
89 
90  if (count($component->getItems()) > 0) {
91  foreach ($component->getItems() as $item) {
92  $tpl->setCurrentBlock("item");
93  if (is_string($item)) {
94  $tpl->setVariable("ITEM", $item);
95  } else {
96  $tpl->setVariable("ITEM", $default_renderer->render($item));
97  }
98  $tpl->parseCurrentBlock();
99  }
100  }
101  return $tpl->get();
102  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
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:

◆ renderProperty()

ILIAS\UI\Implementation\Component\Listing\Renderer::renderProperty ( Component\Listing\Property  $component,
RendererInterface  $default_renderer 
)
protected

Definition at line 104 of file Renderer.php.

References ILIAS\UI\Implementation\Render\AbstractComponentRenderer\getTemplate().

107  : string {
108  $tpl = $this->getTemplate("tpl.propertylisting.html", true, true);
109 
110  foreach ($component->getItems() as $property) {
111  list($label, $value, $show_label) = $property;
112  if (! is_string($value)) {
113  $value = $default_renderer->render($value);
114  }
115 
116  $tpl->setCurrentBlock("property");
117  $tpl->setVariable("VALUE", $value);
118  if ($show_label) {
119  $tpl->setVariable("LABEL", $label);
120  }
121  $tpl->parseCurrentBlock();
122  }
123  return $tpl->get();
124  }
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:

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