Format.crop ViewHelper <f:format.crop>
ViewHelper which can crop (shorten) a text. Whitespace within the <f:format.crop> element will be counted as characters.
Go to the source code of this ViewHelper: Format\CropViewHelper.php (GitHub).
Arguments
The following arguments are available for the format.crop ViewHelper:
append
-
- Type
- string
- Default
- '…'
What to append, if truncation happened
maxCharacters
-
- Type
- int
- Required
- 1
Place where to truncate the string
respectHtml
-
- Type
- bool
- Default
- true
If TRUE the cropped string will respect HTML tags and entities. Technically that means, that cropHTML() is called rather than crop()
respectWordBoundaries
-
- Type
- bool
- Default
- true
If TRUE and division is in the middle of a word, the remains of that word is removed.
Examples
Defaults
<f:format.crop maxCharacters="10">
This is some very long text
</f:format.crop>
Copied!
This is...
The third word "some" does not fit in the 10 character limit, because respectWordBoundaries is true by default.
Custom suffix
<f:format.crop maxCharacters="17" append=" [more]">
This is some very long text
</f:format.crop>
Copied!
This is some [more]
Don't respect word boundaries
<f:format.crop maxCharacters="10" respectWordBoundaries="false">
This is some very long text
</f:format.crop>
Copied!
This is s...
Don't respect HTML tags
<f:format.crop maxCharacters="28" respectWordBoundaries="false" respectHtml="false">
This is some text with <strong>HTML</strong> tags
</f:format.crop>
Copied!
This is some text with <stro
Inline notation
{someLongText -> f:format.crop(maxCharacters: 10)}
Copied!
someLongText cropped after 10 characters…
Depending on the value of {someLongText}.