gnurlan/chatter

此包最新版本(0.2.39.5)没有提供许可证信息。

为您的Laravel应用提供的一个简单论坛包

维护者

详细信息

github.com/gnurlan/chatter

源代码

0.2.39.5 2021-11-22 16:13 UTC

README

Build Status Build Status Total Downloads Latest Stable Version License

Laravel论坛包 - Chatter

安装

快速笔记:如果是新项目,请确保安装Laravel提供的默认用户认证。 php artisan make:auth

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

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

    如果您在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 事件和监听器注册文档。例如,要为“添加新讨论之前”事件注册一个监听器,请将以下内容添加到您的 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
    }

屏幕截图