LittleboyHarry 不是哈哈!打开方式没问题,的确是文档不够完善。不过基本的部分已经覆盖了,只是缺少更多的实践经验和教程,现阶段具体的修改还是需要依赖源码层面的阅读。
根据我这段时间的研究,Flarum 的扩展机制本身其实并不复杂,我也试试能不能几段话梳理清楚~
Flarum 后端的扩展的核心在于它定义的 Extenders
的概念。每一个模块在需要的地方定义 Extender
,按照 Extender
提供的逻辑去操作 服务容器,扩展某个类或者函数,实现业务逻辑的嵌入(比如说添加路由、头部添加 JS/CSS、增加语言支持、修改 Formatter 等等)。文档也有介绍。
插件开发者的核心工作,就是在插件的 extend.php
定义一个数组,数组元素是一个个具体的 Extender
的实例,也可以是回调函数。回调函数在内部会被转换为一种特殊的 Extender
实例,在 Flarum 的容器配置好后的启动阶段执行,一般在回调函数做事件订阅的逻辑。
参考这个插件的 入口文件:
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
use Flarum\Api\Serializer\PostSerializer;
use Flarum\Event\ConfigureNotificationTypes;
use Flarum\Extend;
use Flarum\Likes\Event\PostWasLiked;
use Flarum\Likes\Event\PostWasUnliked;
use Flarum\Likes\Listener;
use Flarum\Likes\Notification\PostLikedBlueprint;
use Flarum\Post\Post;
use Flarum\User\User;
use Illuminate\Contracts\Events\Dispatcher;
return [
(new Extend\Frontend('forum'))
->js(__DIR__.'/js/dist/forum.js')
->css(__DIR__.'/less/forum.less'),
(new Extend\Frontend('admin'))
->js(__DIR__.'/js/dist/admin.js'),
(new Extend\Model(Post::class))
->belongsToMany('likes', User::class, 'post_likes', 'post_id', 'user_id'),
function (Dispatcher $events) {
$events->subscribe(Listener\AddPostLikesRelationship::class);
$events->subscribe(Listener\SaveLikesToDatabase::class);
$events->listen(ConfigureNotificationTypes::class, function (ConfigureNotificationTypes $event) {
$event->add(PostLikedBlueprint::class, PostSerializer::class, ['alert']);
});
$events->listen(PostWasLiked::class, Listener\SendNotificationWhenPostIsLiked::class);
$events->listen(PostWasUnliked::class, Listener\SendNotificationWhenPostIsUnliked::class);
},
];
在接到请求的启动阶段,Flarum 会把所有启用的扩展入口返回的 Extender 数组合并在一起,然后一波执行。
Flarum 前端方面,就是新建 Extender,注入扩展打包的 JS(官方的说法叫做“资源注册”)。这段 JS 执行时候,通过前端预留的 extend 方法,通过修改 prototype 的方式,覆盖或扩展任意组件的成员函数,实现 UI 的修改之类的逻辑。参考 这里。