aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-escaping.md
blob: a62e7de8988b98b96041b2baa81db4d7691359af (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
Escaping Smarty Parsing {#language.escaping}
=======================

It is sometimes desirable or even necessary to have Smarty ignore
sections it would otherwise parse. A classic example is embedding
Javascript or CSS code in a template. The problem arises as those
languages use the { and } characters which are also the default
[delimiters](#language.function.ldelim) for Smarty.

> **Note**
>
> A good practice for avoiding escapement altogether is by separating
> your Javascript/CSS into their own files and use standard HTML methods
> to access them. This will also take advantage of browser script
> caching. When you need to embed Smarty variables/functions into your
> Javascript/CSS, then the following applies.

In Smarty templates, the { and } braces will be ignored so long as they
are surrounded by white space. This behavior can be disabled by setting
the Smarty class variable [`$auto_literal`](#variable.auto.literal) to
false.


    <script>
       // the following braces are ignored by Smarty
       // since they are surrounded by whitespace
       function foobar {
        alert('foobar!');
       }
       // this one will need literal escapement
       {literal}
        function bazzy {alert('foobar!');}
       {/literal}
    </script>
      
     

[`{literal}..{/literal}`](#language.function.literal) blocks are used
for escaping blocks of template logic. You can also escape the braces
individually with
[`{ldelim}`](#language.function.ldelim),[`{rdelim}`](#language.function.ldelim)
tags or
[`{$smarty.ldelim}`,`{$smarty.rdelim}`](#language.variables.smarty.ldelim)
variables.

Smarty\'s default delimiters { and } cleanly represent presentational
content. However if another set of delimiters suit your needs better,
you can change them with Smarty\'s
[`$left_delimiter`](#variable.left.delimiter) and
[`$right_delimiter`](#variable.right.delimiter) values.

> **Note**
>
> Changing delimiters affects ALL template syntax and escapement. Be
> sure to clear out cache and compiled files if you decide to change
> them.


    <?php

    $smarty->left_delimiter = '<!--{';
    $smarty->right_delimiter = '}-->';

    $smarty->assign('foo', 'bar');
    $smarty->assign('name', 'Albert');
    $smarty->display('example.tpl');

    ?>

      

Where the template is:


    Welcome <!--{$name}--> to Smarty
    <script language="javascript">
      var foo = <!--{$foo}-->;
      function dosomething() {
        alert("foo is " + foo);
      }
      dosomething();
    </script>