ebethus/chatter-vivetix

适用于您的Laravel 8+应用的简单论坛包

0.5.1 2023-09-22 04:15 UTC

README

Build Status Build Status Total Downloads Latest Stable Version License

Laravel论坛包 - Chatter

此版本与Laravel 6+兼容

安装

快速提示:如果您正在创建一个新项目,请确保安装了Laravel提供的默认用户认证。 php artisan make:auth

  1. 将包包含到您的项目中

    composer require "devdojo/chatter=0.2.*"
    
  2. 将服务提供者添加到您的 config/app.php 提供者数组中

    如果您正在安装Laravel 5.5+,请跳过此步骤

    DevDojo\Chatter\ChatterServiceProvider::class,
    
  3. 通过运行以下命令发布供应商资产文件

    php artisan vendor:publish --provider="DevDojo\Chatter\ChatterServiceProvider"
    
  4. 现在我们已经将一些新文件发布到我们的应用程序中,我们需要使用以下命令重新加载它们

    composer dump-autoload
    
  5. 运行您的迁移

    php artisan migrate
    

    快速提示:请确保您已创建数据库并在您的 .env 文件中添加了数据库凭据。

  6. 最后,运行种子文件以将少量数据填充到您的数据库中

    php artisan db:seed --class=ChatterTableSeeder
    
  7. 在您的 master.blade.php 文件中,包含一个头部和尾部输出。在 master 或 app.blade.php 的头部添加以下内容

    @yield('css')
    

    然后,在 master 文件中的 </body> 标签上方添加以下内容

    @yield('js')
    

现在,访问您的 site.com/forums,您应该会看到您的新论坛出现在您面前!

升级

确保您的 composer.json 文件要求使用最新的 chatter 版本

"devdojo/chatter": "0.2.*"

然后您将运行

composer update

接下来,您可能希望重新发布 chatter 资产、chatter 配置和 chatter 迁移,通过运行以下命令

php artisan vendor:publish --tag=chatter_assets --force
php artisan vendor:publish --tag=chatter_config --force
php artisan vendor:publish --tag=chatter_migrations --force

接下来,确保您有最新的数据库模式,请运行

php artisan migrate

这样,您就与最新版本同步了 :)

Markdown编辑器

如果您打算使用markdown编辑器而不是tinymce,您需要在您的 config/chatter.php 中更改该设置

'editor' => 'simplemde',

为了正确显示帖子,您需要包含 Laravel 的 graham-campbell/markdown

composer require graham-campbell/markdown

Trumbowyg编辑器

如果您打算使用Trumbowyg作为您的首选编辑器,您需要在您的 config/chatter.php 中更改该设置

'editor' => 'trumbowyg',

Trumbowyg需要包含jQuery >= 1.8。

视频

Chatter的介绍和安装

配置

当您发布供应商资产时,您在您的 config 文件夹中添加了一个新文件,该文件称为 config/chatter.php。此文件包含了一组您可以用来配置论坛的配置

定制

自定义CSS

如果您想添加额外的样式更改,您可以在 master 文件头部的 @yield('css') 语句末尾添加另一个样式表。为了仅在用户访问您的论坛时加载此文件,您可以在以下 if 语句中包含您的样式表

@if(Request::is( Config::get('chatter.routes.home') ) || Request::is( Config::get('chatter.routes.home') . '/*' ))
    <!-- LINK TO YOUR CUSTOM STYLESHEET -->
    <link rel="stylesheet" href="/assets/css/forums.css" />
@endif

SEO友好的页面标题

由于论坛使用您的 master 布局文件,因此您需要包含必要的代码以显示页面的SEO友好标题。以下代码需要添加到 master 文件的头部的 <head>

@if( Request::is( Config::get('chatter.routes.home')) )
    <title>Title for your forum homepage -  Website Name</title>
@elseif( Request::is( Config::get('chatter.routes.home') . '/' . Config::get('chatter.routes.category') . '/*' ) && isset( $discussion ) )
    <title>{{ $discussion->category->name }} - Website Name</title>
@elseif( Request::is( Config::get('chatter.routes.home') . '/*' ) && isset($discussion->title))
    <title>{{ $discussion->title }} - Website Name</title>
@endif

覆盖视图

为了覆盖Chatter的内置视图,只需在您的 vendor 视图文件夹中创建一个 chatter 文件夹,例如 ROOT/resources/views/vendor/chatter。然后只需将您想要覆盖的Chatter视图文件放入其中。

论坛的自定义函数钩子

有时候您可能希望在用户创建新的讨论或添加新回复时添加一些额外的功能。嗯,有一些内置的函数可以在您的脚本中创建以访问这些功能。

在用户添加新讨论之前 在您的脚本中创建一个名为的新全局函数

function chatter_before_new_discussion($request, $validator){}

注意:每个webhook都会传递带有用户输入的$request对象。如果您想使用它,请随意使用。如果不使用,请不要担心,只需添加您自定义的功能。

在用户添加新讨论之后 在您的脚本中创建一个名为的新全局函数

function chatter_after_new_discussion($request){}

在用户添加新回复之前 在您的脚本中创建一个名为的新全局函数

function chatter_before_new_response($request, $validator){}

在用户添加新回复之后 在您的脚本中创建一个名为的新全局函数

function chatter_after_new_response($request){}

Laravel 论坛事件

这个包提供了一系列事件,允许您在用户动作发生时做出响应

监听事件

要注册您的监听器,请按照Laravel 注册事件和监听器的文档进行操作。例如,要注册对“before new discussion”事件的监听器,请将以下内容添加到您的 EventServiceProvider

protected $listen = [
    'DevDojo\Chatter\Events\ChatterBeforeNewDiscussion' => [
        'App\Listeners\HandleNewDiscussion',
    ],
];

其中App\Listeners\HandleNewDiscussion是您的应用程序中处理事件被触发时的事件处理类。

您可以在监听器中使用以下方式访问触发事件的对象

    public function handle(ChatterAfterNewDiscussion $event)
    {
        // $event->discussion
        // $event->post
    }

    public function handle(ChatterAfterNewResponse $event)
    {
        // $event->post
    }

截图