Templating Helpers

Introduction

Template Helpers are methods that offer special functionality to increase usability of view scripts. This is a concept of the Symfony Templating Component and you can of course use all of the built-in functionalities of this component.

Following an overview of some helpers provided by the Symfony Templating Component:

• escape()
• extend()
• actions()
• assets()
• code()
• form()
• request()
• router()
• session()
• stopwatch()
• translator()
• url()
• path()

For more information please have a look into the docs of the Symfony PHP Templating Compontent.

In addition to the Symfony standard templating helpers, Pimcore adds some additional powerful helpers.

Pimcore Templating Helpers

All helpers are described below in detail, the following tables give just a short overview of all available helpers.

You can also create your own custom templating helpers to make certain functionalities available to your views.
Here you can find an example how to create and register your own templating helper.

$this->action()

This helper is a shorthand of Symfony's actions helper.

<?= $this->action($action, $controller, $bundle, $params = []) ?>

{{ pimcore_action(action, controller, bundle, {}) }}

Example

<section id="foo-bar">
    <?= $this->action("foo", "Bar", null, ["awesome" => "value"]) ?>
</section>

<section id="foo-bar">
    {{ pimcore_action('foo', 'Bar', ~, { awesome: 'value' }) }}
</section>

$this->cache()

This is an implementation of an in-template cache. You can use this to cache some parts directly in the template, independent of the other global definable caching functionality. This can be useful for templates which need a lot of calculation or require a huge amount of objects (like navigations, ...).

$this->cache(string $name, [int $lifetime = null], [bool $force = false])

Example

<?php $cache = $this->cache("test_cache_key", 60); ?>
<?php if (!$cache->start()): ?>
    <h1>This is some cached microtime</h1>
    <?= microtime() ?>
    <?php $cache->end(); ?>
<?php endif ?>

{% set cache = pimcore_cache("test_cache_key", 60) %}
{% if not cache.start() %}
    <h1>This is some cached microtime</h1>
    {{ 'now'|date('U') }}
    {% do cache.end() %}
{% endif %}

$this->device()

This helper makes it easy to implement "Adaptive Design" in Pimcore.

<?= $this->device('a default value'); ?>

{{ pimcore_device('a default value') }}

Example

This is my phone content

This text is shown on a tablet

This is for default desktop Browser

Here is some desktop specific content

```twig
{% if pimcore_device()->isPhone() %}
    This is my phone content
{% elseif pimcore_device()->isTablet() %}
    This text is shown on a tablet
{% elseif pimcore_device()->isDesktop() %}
    This is for default desktop Browser
{% endif %}

$this->getAllParams()

Returns all parameters as an array on the request object.
See also $this->getParam().

$this->getParam()

Returns a parameter from the request object (get, post, .... ), it's an equivalent to $request->get() in the controller action.

$this->getParam(string $key, [mixed $default = null])

Example

<?= $this->getParam("myParam"); ?>

$this->glossary()

For details please see Glossary Documentation.

Example

<section class="area-wysiwyg">

    <?php // start capturing content with Glossary feature ?>
    <?php $this->glossary()->start(); ?>
        <?= $this->wysiwyg("content"); ?>
    <?php // call the processor with optional parameters ?>
    <?php $this->glossary()->stop(['limit' => 1]); ?>

</section>

$this->placeholder()

See Placeholder Template Helper

$this->headLink()

See HeadLink Template Helper

$this->headMeta()

See HeadMeta Template Helper

$this->headScript()

See HeadScript Template Helper

$this->headStyle()

See HeadStyle Template Helper

$this->headTitle()

See HeadTitle Template Helper

$this->inc()

Use $this->inc() to include documents (eg. snippets) within views. This is especially useful for footers, headers, navigations, sidebars, teasers, ...

$this->inc(mixed $document, [array $params], [$cacheEnabled = true])

Example

use Pimcore\Model\Document;
  
<!-- include path -->
<?= $this->inc("/shared/boxes/buttons") ?>
 
<!-- include ID -->
<?= $this->inc(256) ?>
 
<!-- include object -->
<?php
 
$doc = Document::getById(477);
echo $this->inc($doc, [
    "param1" => "value1"
]);
?> 
  
<!-- disable caching -->
<?= $this->inc(123, null, false) ?>

In Pimcore 5, when passing parameters to something included with pimcore_inc(), these parameters are not automatically passed to Twig. The parameters are passed as attributes to the included document, and should be passed to Twig via the document's controller action.

Example:

index.html.twig

{{ pimcore_inc('/some/other/document', { 'parameterToPass': parameterToPass }) }}

IndexController.php (whatever controller / method is designated for /some/other/document in the document tree)

public function otherDocumentAction(Request $request) {
    $this->viewParameters->add([
        'parameterToPass' => $request->get('parameterToPass')
    ]);
}

someOtherDocument.html.twig (whatever Twig template is actually for /some/other/document in the document tree)

...
{{ parameterToPass }}
...

$this->inlineScript()

See InlineScript Template Helper

$this->navigation()

See Navigation

$this->pimcoreUrl()

An alternative to url() and path() with the building behavior of Pimcore 4.

$this->template()

This method is designed to include a different template directly, without calling an action.

$this->template($name, array $parameters = [])

Example

<?php echo $this->template("Includes/footer.html.php") ?>
 
<!-- with parameters -->
<?php echo $this->template("Includes/somthingelse.html.php", [
    "param1" => "value1"
]) ?>

Parameters in the included template are then accessible through $this->paramName or directly as $paramName, i.e. from the example above.

Example

<?= $this->param1 ?>
<?= $param1 ?>

Following parameter names cannot be used with $this->parameterName notation:

• current
• container
• loader
• helpers
• parents
• stach
• charset
• cache
• escapers
• globals
• parser
• evalTemplate
• evalParameter

$this->translate()

View helper for getting translation from shared translations. For details also see Shared Translations.

$this->t(string $key = "") $this->translate(string $key = "")

Example

<a href="/"><?= $this->translate("Home"); ?></a>

$this->webLink()

Exposes methods provided by Symfony's WebLink Component. See WebLink for details.

<link rel="stylesheet" href="<?= $this->webLink()->preload('/static/css/global.css', ['as' => 'style']) ?>">