Files
smarty/docs/designers/language-modifiers/language-modifier-indent.md

68 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2023-02-06 14:42:31 +01:00
# indent
This indents a string on each line, default is 4. As an optional
parameter, you can specify the number of characters to indent. As an
optional second parameter, you can specify the character to use to
2023-02-06 14:42:31 +01:00
indent with. For example: use `"\t"` for a tab.
2023-02-06 14:42:31 +01:00
## Basic usage
```smarty
{$myVar|indent:4}
```
2023-02-06 14:42:31 +01:00
## Parameters
2023-02-06 14:42:31 +01:00
| Parameter Position | Type | Required | Default | Description |
|--------------------|---------|----------|-------------|---------------------------------------------------|
| 1 | integer | No | 4 | This determines how many characters to indent to. |
| 2 | string | No | (one space) | This is the character used to indent with. |
2023-02-06 14:42:31 +01:00
## Examples
2023-02-06 14:42:31 +01:00
```php
<?php
2023-02-06 14:42:31 +01:00
$smarty->assign('articleTitle',
'NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.'
);
```
2023-02-06 14:42:31 +01:00
Where template is:
2023-02-06 14:42:31 +01:00
```smarty
{$articleTitle}
2023-02-06 14:42:31 +01:00
{$articleTitle|indent}
2023-02-06 14:42:31 +01:00
{$articleTitle|indent:10}
2023-02-06 14:42:31 +01:00
{$articleTitle|indent:1:"\t"}
```
Will output:
2023-02-06 14:42:31 +01:00
```
NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.
NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.
2023-02-06 14:42:31 +01:00
NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.
NJ judge to rule on nude beach.
Sun or rain expected today, dark tonight.
Statistics show that teen pregnancy drops off significantly after 25.
2023-02-06 14:42:31 +01:00
```
2023-02-06 14:42:31 +01:00
See also [`strip`](language-modifier-strip.md),
[`wordwrap`](language-modifier-wordwrap.md) and
[`spacify`](language-modifier-spacify.md).