README

专为Laravel版本8、9和10设计的有效且多功能的短代码管理器。

安装

使用Composer安装包

composer require kfoobar/laravel-shortcode

设置

发布配置文件以自定义设置

php artisan vendor:publish --tag=shortcode-config

使用

添加自定义短代码

可以轻松定义如下自定义短代码

Shortcode::add('author', 'Joe Doe');

配置默认短代码

使用配置文件中的短代码数组设置默认短代码

'shortcodes' => [
    'author' => 'John Doe',
],

短代码格式化

短代码键会自动转换：它们会被转换为大写并用配置文件中wrapper设置定义的字符包裹。默认的包裹字符是%。

渲染短代码

获取具有各种选项的解析内容

// Standard Parsing
Shortcode::render($content);

// Markdown Conversion
Shortcode::markdown($content);

// Text Parsing (Stripping HTML)
Shortcode::text($content);

Shortcode::render('%YEAR% will be awesome!'); // 2024 will be awesome!

在Blade模板中使用@shortcode指令

@shortcode($content)

注意：Blade指令使用render()方法。

与模型集成

使用HasShortcode特质进行自动短代码解析

use KFoobar\Shortcode\Traits\HasShortcode;

class MyModel extends Model
{
    use HasShortcode;

    // Specify attributes for parsing or use '*' for all
    protected $shortcodes = ['*'];

默认情况下关闭自动短代码解析以避免与写入操作冲突。这种预防措施确保常规的创建、更新和删除操作在没有意外干扰短代码处理机制的情况下进行。

使用代码启用

$model = (new MyModel)->withShortcode();

使用模型设置启用

默认启用自动解析

protected $shortcode = true;

使用中间件启用

为特定路由启用自动解析

protected $middlewareGroups = [
    'web' => [
        // other middleware
        \KFoobar\Shortcode\Middlware\ApplyShortcode::class,
    ],

中间件自动排除非读取请求、AJAX请求和Laravel Nova请求。

预定义短代码

这些是预定义的短代码

贡献

您的贡献非常受欢迎。

许可

MIT许可（MIT）。有关更多信息，请参阅许可文件。