ExampleRenderer Class Reference

Inheritance diagram for ExampleRenderer:

Collaboration diagram for ExampleRenderer:

Protected Member Functions
	manipulateRendering ($component, Renderer $root)
	Manipulates the rendering of one or multiple components by appending, prepending or exchanging their rendered content with custom adjustments. More...
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...

Additional Inherited Members
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 \ILIAS\UI\Implementation\Render\FSLoader 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...
	render ($component, ?Renderer $root=null)
	Render given component. 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. More...
	withAdditionalContext (Component $context)
	Get a new renderer with an additional context. More...

Detailed Description

Definition at line 9 of file ExampleRenderer.php.

Member Function Documentation

manipulateRendering()

ExampleRenderer::manipulateRendering (   $component, Renderer  $root  )

protected

Manipulates the rendering of one or multiple components by appending, prepending or exchanging their rendered content with custom adjustments.

Returns

string|null Return the manipulated rendering of the component or NULL if the component should be rendered native

Reimplemented from ILIAS\UI\Implementation\Render\DecoratedRenderer.

Definition at line 12 of file ExampleRenderer.php.

                                                                       : ?string
    {
        //select the component you want to manipulate
        if ($component instanceof Bulky) {
            //if you need the origin rendering (e.g. for append or prepend) you can access it by calling renderDefault()
            return "A" . $this->renderDefault($component, $root);
        }
 
        //skip components that are not important to you with returning null
        return null;
    }

References ILIAS\UI\Implementation\Render\DecoratedRenderer\renderDefault().

Here is the call graph for this function:

---

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

• docs/development/code-examples/ui-exchange/00_base_classes/ExampleRenderer.php