divineomega / php-wikitext-parser
Parse Wikitext in PHP
Fund package maintenance!
DivineOmega
Requires
- php: >=7.1
- ext-dom: *
- ext-json: *
- divineomega/do-file-cache-psr-6: ^2.0
This package is auto-updated.
Last update: 2024-11-26 21:45:01 UTC
README
The library provides an easy way to parse Wikitext in PHP.
Installation
Just run the following Composer command at the root of your project.
composer require divineomega/php-wikitext-parser
Usage
The most basic usage is to convert a Wikitext formatted string to plain text.
$plainText = (new WikitextParser()) ->setWikitext($wikitext) ->parse();
Alternative Format
You are also able to specify alternative formats to
convert to, using the setFormat method. By default,
this is set to plain text.
For example, you can convert Wikitext to HTML, as shown below.
$plainText = (new WikitextParser()) ->setWikitext($wikitext) ->setFormat(Format::HTML) ->parse();
Caching
By default, file caching is used. If you wish, you can
specify any PSR-6 compliant caching library. This is
done using the setCache method as should below.
$cache = new OtherPsr6CacheItemPool(); $plainText = (new WikitextParser()) ->setCache($cache) ->setWikitext($wikitext) ->parse();