https://github.com/divineomega/php-wikitext-parser

Parse Wikitext in PHP
https://github.com/divineomega/php-wikitext-parser

parser php-library wikitext wikitext-parser

Last synced: about 2 months ago
JSON representation

Parse Wikitext in PHP

• Host: GitHub
• URL: https://github.com/divineomega/php-wikitext-parser
• Owner: DivineOmega
• License: lgpl-3.0
• Created: 2019-04-28T11:23:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-26T09:27:19.000Z (over 5 years ago)
• Last Synced: 2024-10-15T02:37:30.647Z (2 months ago)
• Topics: parser, php-library, wikitext, wikitext-parser
• Language: PHP
• Size: 10.7 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Wikitext Parser

The library provides an easy way to parse Wikitext in PHP.

## Installation

Just run the following Composer command at the root of 

your project.

```bash

composer require divineomega/php-wikitext-parser

```

## Usage

The most basic usage is to convert a Wikitext formatted

string to plain text.

```php

$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.

```php

$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.

```php

$cache = new OtherPsr6CacheItemPool();

$plainText = (new WikitextParser())

    ->setCache($cache)

    ->setWikitext($wikitext)

    ->parse();

```