https://github.com/dzango/TwigTruncateExtension

A custom twig extension to truncate text while preserving HTML tags.
https://github.com/dzango/TwigTruncateExtension

Last synced: 28 days ago
JSON representation

A custom twig extension to truncate text while preserving HTML tags.

• Host: GitHub
• URL: https://github.com/dzango/TwigTruncateExtension
• Owner: dzango
• License: mit
• Created: 2014-09-07T04:02:18.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-12-02T03:30:35.000Z (over 6 years ago)
• Last Synced: 2024-03-14T21:41:38.286Z (3 months ago)
• Language: PHP
• Size: 26.4 KB
• Stars: 12
• Watchers: 2
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-twig - Truncate Text - A custom twig extension to truncate text while preserving HTML tags. (Twig / Extensions)
• awesome-twig - Truncate Text - A custom twig extension to truncate text while preserving HTML tags. (Twig / Extensions)

README

        
TwigTruncateExtension

=====================

A custom twig extension to truncate text while preserving HTML tags.

Installation

------------

Add the library to your app's `composer.json`:

```json

    "require": {

        "dzango/twig-truncate-extension": "~1.0",

        ...

    }

```

Add the extension to the `Twig_Environment`:

```php

use Dzango\Twig\Extension\Truncate;

$twig = new Twig_Environment(...);

$twig->addExtension(new Truncate());

```

Usage

-----

The bundle exposes a `truncate` twig filter, which can be applied to any string.

```twig

{{ "some ... very ... large ... text"|truncate }}

```

### Arguments

The `truncate` filter accepts 4 arguments, all of which have sensible defaults and can therefore be ignored most of the time:

```php

truncate($length = 100, $ending = '...', $exact = false, $considerHtml = true)

```

* **length**: the maximum number of characters to display, excluding any HTML markup (default `100`)

* **ending**: The characters to be appended to the truncated string (default `...`)

* **exact**: If set to true, the text may be cut off in the middle of a word. To avoid this, set this argument to false (default `false`)

* **considerHtml**: If set to true, HTML markup will be ignored and left unchanged (default `true`)

Markdown and raw content

------------------------

Because the `truncate` filter preserves HTML markup, it is perfectly able to handle rendered markdown content, as well as "raw" content (as rendered by the `raw` filter). For example, assuming your app has enabled a `markdown` twig filter for parsing markdown content, the following is fully supported:

```twig

{{ "some ... very ... long ... markdown text"|markdown|raw|truncate }}

```

Symfony2

--------

To use this extension in a symfony2 project, you have 2 options:

### 1. Add a service "manually"

```yaml

# app/config/config.yml

services:

    dzango.twig.truncate_extension:

        class: Dzango\Twig\Extension\Truncate

        tags:

            - { name: twig.extension }

```

### 2. Use the TwigTruncateBundle

The [Dzango/TwigTruncateBundle](https://github.com/dzango/TwigTruncateBundle) will register the extension for you as a service.

Credits

-------

 * http://alanwhipple.com/2011/05/25/php-truncate-string-preserving-html-tags-words/ for the truncation logic