README

Sonnn\BBCode 包可以帮助您解析 BBCode。

安装

通过 Composer

$ composer require sonnn/bbcode

用法

解析一些文本就像这样简单！

$bbcode = new Sonnn\BBCode\BBCodeParser;

echo $bbcode->parse('[b]Bold Text![/b]');
// <strong>Bold Text!</strong>

如果不想解析器使用所有 bbcode，只需这样做。

$bbcode = new Sonnn\BBCode\BBCodeParser;

echo $bbcode->only('bold', 'italic')
            ->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]');
            // <strong>[u]Bold[/u] <em>Italic</em>!</strong>

echo $bbcode->except('bold')
            ->parse('[b]Bold[/b] [i]Italic[/i]');
            // [b]Bold[/b] <em>Italic</em>

默认情况下，解析器是区分大小写的。但如果您希望解析器接受像 [B]粗体文本[/B] 这样的标签，非常简单。

$bbcode = new Sonnn\BBCode\BBCodeParser;

// Case insensitive
echo $bbcode->parse('[b]Bold[/b] [I]Italic![/I]', true);
     // <strong>Bold</strong> <em>Italic!</em>

// Or like this

echo $bbcode->parseCaseInsensitive('[b]Bold[/b] [i]Italic[/i]');
     // <strong>Bold</strong> <em>Italic!</em>

您也可以使用另一个辅助函数来更明确地表明解析器是区分大小写的。

    $bbcode = new Sonnn\BBCode\BBCodeParser;

    echo $bbcode->parseCaseSensitive('[b]Bold[/b] [I]Italic![/I]');
         // <strong>Bold</strong> [I]Italic![/I]

如果您想完全删除所有 BBCode，只需一个函数调用即可。

    $bbcode = new Sonnn\BBCode\BBCodeParser;

    echo $bbcode->stripBBCodeTags('[b]Bold[/b] [i]Italic![/i]');
         // Bold Italic!

Laravel 集成

Laravel 的集成非常简单，对于 Laravel 4 和 Laravel 5 都是同样的方法。只需打开您的 app.php 配置文件。

在那里，您只需将此添加到您的 providers 数组中

'Sonnn\BBCode\BBCodeParserServiceProvider'

并将此添加到您的 facades 数组中

'BBCode' => 'Sonnn\BBCode\Facades\BBCodeParser'

语法与在纯 PHP 中使用相同，但需要在方法前加上 BBCode::。以下是一些示例。

// Simple parsing
echo BBCode::parse('[b]Bold Text![/b]');

// Limiting the parsers with the only method
echo BBCode::only('bold', 'italic')
        ->parse('[b][u]Bold[/u] [i]Italic[/i]![/b]');
        // <strong>[u]Bold[/u] <em>Italic</em>!</strong>

// Or the except method
echo BBCode::except('bold')
        ->parse('[b]Bold[/b] [i]Italic[/i]');
        // [b]Bold[/b] <em>Italic</em>

贡献

有关详细信息，请参阅 CONTRIBUTING。