docxpresso/html2text

A simple package that converts HTML into plain text using DOM methods

v1.2 2017-05-15 10:57 UTC

Requires

• php: >=5.4
• ext-tidy: *
• ext-zip: *
• lib-libxml: *

MIT

• Eduardo Ramos

• text
• html
• dom
• txt

README

HTML2TEXT is a single class PHP package that converts HTML into plain text.

It uses DOM methods rather than regular expressions and although it works out of the box it can be easily further customized to suit any particular need.

You can visit the official page in Docxpresso.

Installing HTML2TEXT

The recommended way to install HTML2TEXT is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of HTML2TEXT:

php composer.phar require docxpresso/html2text

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

You can then later update HTML2TEXT using composer:

composer.phar update

Using HTML2TEXT

The use of HTML2TEXT is extremely simple:

require __DIR__ . '/../vendor/autoload.php';
use Docxpresso\HTML2TEXT as Parser;
$html = '<p>A simple paragraph.</p>';
$parser = new Parser\HTML2TEXT($html);
echo $parser->plainText();

You can override some of the default values by including an options array whenever you invoke the HTML2TEXT class. The following options are available:

• bold: a string of chars that will wrap text in b or strong tags. The default value is an empty string.
• cellSeparator: a string of chars used to separate content between contiguous cells in a row. Default value is " || " (\t may be also a sensible choice)
• images: if set to true the alt value associated to the image will be printed like [img: alt value]. Default value is true.
• italics: a string of chars that will wrap text in i or em tags. The default value is an empty string.
• newLine: if set it will replace the default value (\n\r) for titles and paragraphs.
• tab: a string of chars that will be used like a "tab". The default value is " " (\t may be another standard option)
• titles: it can be "underline" (default), "uppercase" or "none".