sqginfo/html2text

A PHP script to convert HTML into a plain text format

Maintainers

Details

github.com/sqginfo/html2text

Homepage

Source

Installs: 483

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 135

Language:HTML

0.3.4.1 2016-12-05 23:50 UTC

Requires

  • php: >=5.3.2
  • ext-dom: *
  • ext-libxml: *

Requires (Dev)

EPL-1.0 95bce336fe81467d22df9d747224584170a31ba4

phptextemailhtml

This package is auto-updated.

Last update: 2024-11-11 00:16:23 UTC

README

html2text is a very simple script that uses PHP's DOM methods to load from HTML, and then iterates over the resulting DOM to correctly output plain text. For example:

<html>
<title>Ignored Title</title>
<body>
  <h1>Hello, World!</h1>

  <p>This is some e-mail content.
  Even though it has whitespace and newlines, the e-mail converter
  will handle it correctly.

  <p>Even mismatched tags.</p>

  <div>A div</div>
  <div>Another div</div>
  <div>A div<div>within a div</div></div>

  <a href="http://foo.com">A link</a>

</body>
</html>

Will be converted into:

Hello, World!

This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.

Even mismatched tags.
A div
Another div
A div
within a div
[A link](http://foo.com)

See the original blog post or the related StackOverflow answer.

Installing

You can use Composer to add the package to your project:

{
  "require": {
    "soundasleep/html2text": "~0.3"
  }
}

And then use it quite simply:

$text = Html2Text\Html2Text::convert($html);

You can also include the supplied html2text.php and use $text = convert_html_to_text($html); instead.

Tests

Some very basic tests are provided in the tests/ directory. Run them with composer install --dev && vendor/bin/phpunit.

License

html2text is dual licensed under both EPL v1.0 and LGPL v3.0, making it suitable for both Eclipse and GPL projects.

Other versions

Also see html2text_ruby, a Ruby implementation.