php-htmltruncator

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #llm #go #rust #docker #nodejs #awesome #cli #awesome-list #security #ios

php-htmltruncator

(★ 26)

Want to truncate an HTML string properly? This is a PHP port of the html_truncator rubygem.

php-htmltruncator Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

PHP HTML Truncator
==================

[![Build Status](https://api.travis-ci.org/judev/php-htmltruncator.svg)](https://travis-ci.org/judev/php-htmltruncator)

This is a PHP port of the [html_truncator gem](https://github.com/nono/HTML-Truncator).

It will cleanly truncate HTML content, appending an ellipsis or other marker in the most
suitable place.
There is optional support for [html5-php](https://github.com/Masterminds/html5-php) if parsing
of non-well-formed HTML5 is required. This is because PHP's DOMDocument->loadHTML (or the underlying libxml) doesn't recognize HTML5.

During the truncation process the HTML will be loaded into a DOMDocument. This can be relatively slow and memory hungry, so you may want to cache the truncated output.

The [intl](http://php.net/intl) and [mbstring](http://php.net/mbstring) extensions are highly recommended to make truncation of international text more predictable.

How to use it
-------------

The HtmlTruncator\Truncator class has only one static method, `truncate`, with 3 arguments:

* the HTML-formatted string to truncate
* the number of words to keep (real words, tags and attributes aren't counted)
* some options like the ellipsis (optional, '…' by default). If the option is string it is used as the ellipsis

And a static attribute, `$ellipsable_tags`, which lists the tags that can contain the ellipsis
(by default: p ol ul li div header article nav section footer aside dd dt dl).

Examples
--------

A simple example:

Truncator::truncate("Lorem ipsum dolor sit amet.", 3);
 # => "Lorem ipsum dolor…"

If the text is too short to be truncated, it won't be modified:

Truncator::truncate("Lorem ipsum dolor sit amet.", 5);
 # => "Lorem ipsum dolor sit amet."

If you prefer, you can have the length in characters instead of words:

Truncator::truncate("Lorem ipsum dolor sit amet.", 12, array('length_in_chars' => true));
 # => "Lorem ipsum …"

You can customize the ellipsis:

Truncator::truncate("Lorem ipsum dolor sit amet.", 3, " (truncated)");
 # => "Lorem ipsum dolor (truncated)"

And even have HTML in the ellipsis:

Truncator::truncate("Lorem ipsum dolor sit amet.", 3, '<a href="/more-to-read">...</a>');
 # => "Lorem ipsum dolor<a href="/more-to-read">...</a>"

The ellipsis is put at the right place, inside ``, but not ``:

Truncator::truncate("Lorem ipsum dolor sit amet.", 3);
 # => "Lorem ipsum dolor…"

You can indicate that a tag can contain the ellipsis by adding it to the ellipsable_tags:

Truncator::$ellipsable_tags[] = "blockquote";
 Truncator::truncate("<blockquote>Lorem ipsum dolor sit amet.</blockquote>", 3);
 # => "<blockquote>Lorem ipsum dolor…</blockquote>"

Credits
-------

This PHP port is entirely based on [Bruno Michel's excellent rubygem](https://github.com/nono/HTML-Truncator), any
bugs introduced are likely mine.

Ported 2013-07-04 by Jude Venn <judev@cuttlefish.com>, released under the MIT license

php-htmltruncator

php-htmltruncator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

php-htmltruncator

php-htmltruncator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README