Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bicpi/htmlconverter
PHP5 library that provides easy HTML-to-Text conversion
https://github.com/bicpi/htmlconverter
htmlconverter php php-library
Last synced: about 1 month ago
JSON representation
PHP5 library that provides easy HTML-to-Text conversion
- Host: GitHub
- URL: https://github.com/bicpi/htmlconverter
- Owner: bicpi
- License: mit
- Created: 2013-04-13T22:01:34.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2020-07-28T07:48:30.000Z (over 4 years ago)
- Last Synced: 2024-12-01T21:16:06.620Z (about 2 months ago)
- Topics: htmlconverter, php, php-library
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 11
- Watchers: 4
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bicpi's HtmlConverter library
HtmlConverter is a PHP library that provides easy HTML-to-Text conversion. This is useful, for example, for
automatically creating plain text parts of HTML emails.
[](https://travis-ci.org/bicpi/HtmlConverter)
## Usage
1. Create converter
2. Call `->convert($html)` method
3. Enjoy returned plain text
### SimpleConverter
The `SimpleConverter` works on every PHP enabled system by using PHP's `strip_tags()` function and putting some HTML
entity decoding on top.
```php
... you HTML content ... ...';
$converter = new SimpleConverter();
$plain = $converter->convert($html);
```
### LynxConverter
The `LynxConverter` works on every system with the `lynx` text browser package installed. The converted plain text
is equivalent to what you would see when opening the HTML in `lynx`. This is currently the most useful converter as
it provides the best results and includes all links as references.
```php
... you HTML content ... ...';
$converter = new LynxConverter();
$plain = $converter->convert($html);
```
### Html2TextConverter
The `Html2TextConverter` works on every system with the `html2text` package installed. The converted plain text
is equivalent to what you would see when passing the HTML on the command line to the `html2text` command. The result
is quite nice but be aware that links will be removed. Hence, this should not be used for converting a whole web page
or marketing email. May be useful for small chunks of HTML code.
```php
... you HTML content ... ...';
$converter = new Html2TextConverter();
$plain = $converter->convert($html);
```
### ChainConverter
The `ChainConverter` offers converter chaining so that the first appropriate converter will handle the conversion.
```php
... you HTML content ... ...';
$converter = new ChainConverter();
$converter->addConverter(new LynxConverter());
$converter->addConverter(new SimpleConverter());
$plain = $converter->convert($html);
```
In the above example the conversion will be handled by the `LynxConverter` - provided that the `lynx` package is
available. If not, the `SimpleConverter` will be used as a fallback. This for instance would be useful when deploying
to a machine without `lynx` installed but a development machine without the package - e.g. Windows.
## Running unit tests
To setup and run tests follow these steps:
1. Go to the root directory of this library
2. Run: `composer install`
3. Run: `./vendor/bin/phpunit`