ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\UI\Implementation\Render\Template Interface Reference

Interface to templating as it is used in the UI framework. More...

+ Inheritance diagram for ILIAS\UI\Implementation\Render\Template:
+ Collaboration diagram for ILIAS\UI\Implementation\Render\Template:

Public Member Functions

 setCurrentBlock (string $name)
 Set the block to work on. More...
 
 parseCurrentBlock ()
 Parse the block that is currently worked on. More...
 
 touchBlock (string $name)
 Touch a block without working further on it. More...
 
 setVariable (string $name, $value)
 Set a variable in the current block. More...
 
 get (string $block=null)
 Get the rendered template or a specific block. More...
 
 addOnLoadCode (string $code)
 Add some javascript to be executed on_load of the rendered page. More...
 

Detailed Description

Interface to templating as it is used in the UI framework.

This deliberately is much smaller than ilTemplate, there is a lot of stuff in there we should not be using here.

Definition at line 28 of file Template.php.

Member Function Documentation

◆ addOnLoadCode()

ILIAS\UI\Implementation\Render\Template::addOnLoadCode ( string  $code)

Add some javascript to be executed on_load of the rendered page.

TODO: This seems to be no rendering, but a javascript concern. We should revise this when introducing patterns for javascript.

Implemented in NullTemplate, and ILIAS\UI\Implementation\Render\ilTemplateWrapper.

◆ get()

ILIAS\UI\Implementation\Render\Template::get ( string  $block = null)

Get the rendered template or a specific block.

Implemented in NullTemplate, and ILIAS\UI\Implementation\Render\ilTemplateWrapper.

Referenced by ILIAS\UI\Implementation\Component\Link\Renderer\maybeRenderWithTooltip().

+ Here is the caller graph for this function:

◆ parseCurrentBlock()

ILIAS\UI\Implementation\Render\Template::parseCurrentBlock ( )

Parse the block that is currently worked on.

Implemented in NullTemplate, and ILIAS\UI\Implementation\Render\ilTemplateWrapper.

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\additionalRenderBulky(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\addPostURL(), ILIAS\UI\Implementation\Component\Table\Renderer\appendTableRows(), ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Renderer\getDefaultGraphicByComponent(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\maybeAddError(), ILIAS\UI\Implementation\Component\Button\Renderer\maybeRenderId(), ILIAS\UI\Implementation\Component\Link\Renderer\maybeRenderWithTooltip(), ILIAS\UI\Implementation\Component\Deck\Renderer\parseRow(), ILIAS\UI\Implementation\Component\Symbol\Glyph\Renderer\renderAction(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderApplyAndReset(), ILIAS\UI\Implementation\Component\Item\Renderer\renderAudioPlayer(), ILIAS\UI\Implementation\Component\Item\Renderer\renderDescription(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderExpandAndCollapse(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\renderFilePreview(), ILIAS\UI\Implementation\Component\Table\Renderer\renderFullWidthDataCell(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderId(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderInputs(), ILIAS\UI\Implementation\Component\Listing\CharacteristicValue\Renderer\renderItem(), ILIAS\UI\Implementation\Component\Dropdown\Renderer\renderItems(), ILIAS\UI\Implementation\Component\Modal\Renderer\renderPage(), ILIAS\UI\Implementation\Component\Item\Renderer\renderProperties(), ILIAS\UI\Implementation\Component\Listing\CharacteristicValue\Renderer\renderRow(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderSectionButton(), ILIAS\UI\Implementation\Component\Table\Renderer\renderTableHeader(), and ILIAS\UI\Implementation\Component\Layout\Page\Renderer\setHeaderVars().

+ Here is the caller graph for this function:

◆ setCurrentBlock()

ILIAS\UI\Implementation\Render\Template::setCurrentBlock ( string  $name)

Set the block to work on.

Implemented in NullTemplate, and ILIAS\UI\Implementation\Render\ilTemplateWrapper.

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\additionalRenderBulky(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\addPostURL(), ILIAS\UI\Implementation\Component\Table\Renderer\appendTableRows(), ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Renderer\getDefaultGraphicByComponent(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\maybeAddError(), ILIAS\UI\Implementation\Component\Button\Renderer\maybeRenderId(), ILIAS\UI\Implementation\Component\Link\Renderer\maybeRenderWithTooltip(), ILIAS\UI\Implementation\Component\Deck\Renderer\parseRow(), ILIAS\UI\Implementation\Component\Symbol\Glyph\Renderer\renderAction(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderApplyAndReset(), ILIAS\UI\Implementation\Component\Item\Renderer\renderAudioPlayer(), ILIAS\UI\Implementation\Component\Item\Renderer\renderDescription(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderExpandAndCollapse(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\renderFilePreview(), ILIAS\UI\Implementation\Component\Table\Renderer\renderFullWidthDataCell(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderId(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderInputs(), ILIAS\UI\Implementation\Component\Listing\CharacteristicValue\Renderer\renderItem(), ILIAS\UI\Implementation\Component\Dropdown\Renderer\renderItems(), ILIAS\UI\Implementation\Component\Modal\Renderer\renderPage(), ILIAS\UI\Implementation\Component\Item\Renderer\renderProperties(), ILIAS\UI\Implementation\Component\Listing\CharacteristicValue\Renderer\renderRow(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderSectionButton(), ILIAS\UI\Implementation\Component\Table\Renderer\renderTableHeader(), and ILIAS\UI\Implementation\Component\Layout\Page\Renderer\setHeaderVars().

+ Here is the caller graph for this function:

◆ setVariable()

ILIAS\UI\Implementation\Render\Template::setVariable ( string  $name,
  $value 
)

Set a variable in the current block.

Parameters
mixed$valueshould be possible to be cast to string.

Implemented in NullTemplate, and ILIAS\UI\Implementation\Render\ilTemplateWrapper.

Referenced by ILIAS\UI\Implementation\Component\Button\Renderer\additionalRenderBulky(), ILIAS\UI\Implementation\Component\Button\Renderer\additionalRenderTag(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\addPostURL(), ILIAS\UI\Implementation\Component\Table\Renderer\appendTableRows(), ILIAS\UI\Implementation\Component\Input\Field\FilterContextRenderer\applyName(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\applyName(), ILIAS\UI\Implementation\Component\Input\Field\FilterContextRenderer\applyValue(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\applyValue(), ILIAS\UI\Implementation\Component\Dropzone\File\Renderer\bindAndApplyJavaScript(), ILIAS\UI\Implementation\Component\Input\Field\FilterContextRenderer\bindJSandApplyId(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\bindJSandApplyId(), ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Renderer\getDefaultGraphicByComponent(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\maybeAddError(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\maybeAddRequired(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\maybeDisable(), ILIAS\UI\Implementation\Component\Button\Renderer\maybeRenderId(), ILIAS\UI\Implementation\Component\Link\Renderer\maybeRenderWithTooltip(), ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Renderer\modifyVisibleValues(), ILIAS\UI\Implementation\Component\Deck\Renderer\parseRow(), ILIAS\UI\Implementation\Component\Symbol\Glyph\Renderer\renderAction(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderApplyAndReset(), ILIAS\UI\Implementation\Component\Item\Renderer\renderAudioPlayer(), ILIAS\UI\Implementation\Component\Chart\Bar\Renderer\renderBasics(), ILIAS\UI\Implementation\Component\Item\Renderer\renderDescription(), ILIAS\UI\Implementation\Component\Table\Renderer\renderEmptyPresentationRow(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderExpandAndCollapse(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\renderFilePreview(), ILIAS\UI\Implementation\Component\Table\Renderer\renderFullWidthDataCell(), ILIAS\UI\Implementation\Component\Dropdown\Renderer\renderId(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderId(), ILIAS\UI\Implementation\Component\Input\Container\Filter\Renderer\renderInputs(), ILIAS\UI\Implementation\Component\Listing\CharacteristicValue\Renderer\renderItem(), ILIAS\UI\Implementation\Component\Dropdown\Renderer\renderItems(), ILIAS\UI\Implementation\Component\Symbol\Glyph\ButtonContextRenderer\renderLabel(), ILIAS\UI\Implementation\Component\Symbol\Glyph\Renderer\renderLabel(), ILIAS\UI\Implementation\Component\Symbol\Icon\Renderer\renderLabel(), ILIAS\UI\Implementation\Component\Modal\Renderer\renderPage(), ILIAS\UI\Implementation\Component\Item\Renderer\renderProperties(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\renderSectionButton(), ILIAS\UI\Implementation\Component\Table\Renderer\renderTableHeader(), ILIAS\UI\Implementation\Component\Item\Renderer\renderTitle(), ILIAS\UI\Implementation\Component\Layout\Page\Renderer\setHeaderVars(), ILIAS\UI\Implementation\Component\ViewControl\Renderer\setPaginationBrowseControls(), and ILIAS\UI\Implementation\Component\ViewControl\Renderer\setPaginationFirstLast().

+ Here is the caller graph for this function:

◆ touchBlock()


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