ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
TestDecoratedRenderer Class Reference
+ Inheritance diagram for TestDecoratedRenderer:
+ Collaboration diagram for TestDecoratedRenderer:

Public Member Functions

 manipulate ()
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Render\DecoratedRenderer
 __construct (Renderer $default)
 
 withAdditionalContext (Component $context)
 Get a new renderer with an additional context.A context makes it possible to use another renderer for (some) components when they are renderer as subcomponents of a certain components. The use case that spawned this functionality is the observation, that e.g. items representing repository objects are renderer in different lists, where the individual items look different every time but are morally the same item. Another use case could be a special rendering of input fields in filters over tables.If a component wants to render itself differently in different contexts, it must implement a RendererFactory. The class contains directions how to do that.
Parameters
Component$context
Returns
Renderer
More...
 
 render ($component, ?Renderer $root=null)
 Render given component.If an array of components is passed, this method returns a concatenated output of each rendered component, in the same order as given in the array
Parameters
Component|Component[]$component
?Renderer$root of renderers in the chain to be used for rendering sub components.
Returns
string
More...
 
 renderAsync ($component, ?Renderer $root=null)
 Same as render, except that this version also returns any javascript code bound to the on load event, wrapped in a script tag.All javascript code stored for rendering will be removed after this output so it will not be rendered twice if render async is called multiple times.
Parameters
Component|Component[]$component
?Renderer$root of renderers in the chain to be used for rendering sub components.
Returns
string
More...
 

Protected Member Functions

 manipulateRendering ($component, Renderer $root)
 
- Protected Member Functions inherited from ILIAS\UI\Implementation\Render\DecoratedRenderer
 manipulateRendering ($component, Renderer $root)
 Manipulates the rendering of one or multiple components by appending, prepending or exchanging their rendered content with custom adjustments. More...
 
 manipulateAsyncRendering ($component, Renderer $root)
 Manipulates the async Rendering separately if needed. More...
 
 renderDefault ($component, ?Renderer $root=null)
 Renders the component by default. More...
 

Private Attributes

 $manipulate = false
 

Detailed Description

Definition at line 180 of file Base.php.

Member Function Documentation

◆ manipulate()

TestDecoratedRenderer::manipulate ( )

Definition at line 184 of file Base.php.

184  : void
185  {
186  $this->manipulate = true;
187  }

◆ manipulateRendering()

TestDecoratedRenderer::manipulateRendering (   $component,
Renderer  $root 
)
protected

Definition at line 189 of file Base.php.

189  : ?string
190  {
191  if ($this->manipulate) {
192  return "This content was manipulated";
193  } else {
194  return null;
195  }
196  }

Field Documentation

◆ $manipulate

TestDecoratedRenderer::$manipulate = false
private

Definition at line 182 of file Base.php.


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