php wikitext parser

php wikitext parser

このライブラリは、PHP で Wikitext を解析する簡単な方法を提供します。

インストール

プロジェクトのルートで次の Composer コマンドを実行するだけです。

composer require divineomega/php-wikitext-parser

使用法

最も基本的な使用法は、Wikitext 形式の文字列をプレーン テキストに変換することです。

 $ plainText = ( new WikitextParser ())
    -> setWikitext ( $ wikitext )
    -> parse ();

代替フォーマット

setFormatメソッドを使用して、変換先の代替形式を指定することもできます。デフォルトでは、これはプレーンテキストに設定されています。

たとえば、以下に示すように、Wikitext を HTML に変換できます。

 $ plainText = ( new WikitextParser ())
    -> setWikitext ( $ wikitext )
    -> setFormat (Format:: HTML )
    -> parse ();

キャッシング

デフォルトでは、ファイル キャッシュが使用されます。必要に応じて、PSR-6 準拠のキャッシュ ライブラリを指定できます。これは、以下のようにsetCacheメソッドを使用して行われます。

 $ cache = new OtherPsr6CacheItemPool ();

$ plainText = ( new WikitextParser ())
    -> setCache ( $ cache )
    -> setWikitext ( $ wikitext )
    -> parse ();