Skip to content
This package converts content from strings or files to HTML strings to be rendered on a page
PHP HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.styleci.yml
.travis.yml
LICENSE
README.md
composer.json
composer.lock
phpunit.xml

README.md

Content to HTML Parser

Build status StyleCI Status Code coverage Total Downloads Latest Stable Version License

This package converts content from strings or files to HTML strings to be rendered on a page.

Installation

You can include this package through Composer using:

composer require roelofjan-elsinga/content-to-html-parser

Usage

use ContentParser\ContentParser;

$parser = ContentParser::forFile('/absolute/path/to/file.txt');

// OR

$parse_string = 'This is some beautiful text';

$parser = ContentParser::forString($parse_string, 'txt');

print $parser->parse(); // This is an HTML string

Available parsers

There are currently three parsers included:

  • HTML to HTML: This doesn't modify the string
  • Markdown to HTML: This parses Markdown to HTML strings
  • TXT to HTML: This parses plain text to usable HTML markup through nl2br()

Available methods

This package comes with two named constructors:

  • public static function forFile(string $file_path): ContentParserInterface
  • public static function forString(string $file_contents, string $file_extension = null): ContentParserInterface

You can parse the strings and get the resulting HTML string by calling: public function parse(): string

If you want to get the underlying parser, you can use: public function getParser(): ContentParserInterface

Testing

You can run the included tests by running ./vendor/bin/phpunit in your terminal.

Contributions

If you want to contribute you can add additional ContentParsers or improve the current parsers.

You can’t perform that action at this time.