ExampleRenderer Class Reference

Extend the DecoratedRenderer to align your renderer with other potential renderers in ILIAS, and allow manipulations from different sources to be chained to one another. More...

Inheritance diagram for ExampleRenderer:

Collaboration diagram for ExampleRenderer:

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...

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 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...

Detailed Description

Extend the DecoratedRenderer to align your renderer with other potential renderers in ILIAS, and allow manipulations from different sources to be chained to one another.

Definition at line 28 of file ExampleRenderer.php.

Member Function Documentation

manipulateRendering()

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

protected

Definition at line 30 of file ExampleRenderer.php.

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

                                                                       : ?string
    {
        // choose the component you want to manipulate by checking the instance
        // as closely as possible. please note there may be custom components in
        // the current chain, which may extend an interface or implementation,
        // and also run into your manipulation.
        if ($component instanceof Bulky) {
            // render the component by passing it to the rendering chain of
            // renderers that come before this renderer.
            $html = $this->renderDefault($component);
            // manipulate the html to your desire and/or replace it entirely.
            $html .= 'my custom additions';
            // finally pass the manipulated HTML to the cain, so other renderers
            // that come after this may manipulate it too.
            return $html;
        }

        // return null to indicate you are not interested in the given component.
        return null;
    }

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/rendering-manipulations/ExampleRenderer.php