tealorca/laravel-freshchat

Freshchat Web Widget for Laravel

Maintainers

Details

github.com/tealorca/laravel-freshchat

Homepage

Source

Issues

Installs: 73

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 1

v0.0.2 2021-03-20 09:17 UTC

Requires

  • php: ^7.1

Requires (Dev)

MIT 12e424dda85dc83553e26eb4fe6e29e14e377e9b

  • Daniel Felix <danielfelix1995.woop@gmail.com>

tealorcalaravel-freshchat

This package is auto-updated.

Last update: 2024-12-20 19:39:31 UTC

README

Latest Version on Packagist Total Downloads

Installation

You can install the package via composer:

composer require tealorca/laravel-freshchat

The package will automatically register a service provider.

Next, Include the chat widget into blade layout code by adding Blade directive @laravelFreshchat before the end of the body tag.

<body>
    ...
    ...
    @laravelFreshchat
</body>
</html>

Next, you need to publish the freshchat configuration file:

php artisan vendor:publish --provider="TealOrca\LaravelFreshchat\LaravelFreshchatServiceProvider" --tag="config"

This is the default content of the config file that will be published as config/laravel-freshchat.php:

/*
 * Freshchat Configurations
 */
return [

    /*
     * Freshchat's Web Messenger Token.
     *
     * You can see that on Web Messenger Settings page of Freshchat Portal.
     */
    'token'      => env('FRESHCHAT_TOKEN', null),

    /*
     * Freshchat's Web Messenger Host Value. ( it would be different based on your data region)
     *
     * Few examples:
     *
     *	https://wchat.freshchat.com
     *	https://wchat.in.freshchat.com
     *
     * You can see that on Web Messenger Settings page of Freshchat Portal.
     */
    'host'       => env('FRESHCHAT_HOST', 'https://wchat.freshchat.com'),
];

Once you added FRESHCHAT_TOKEN and FRESHCHAT_HOST values to your .env file you can see the widget on your webpage.

The displayed widget will be treated as a Anonymous User window.

You can see the Freshchat's Web SDK Docs for more details.

Configure Logged in User

Add the ChatUser Trait to your User Model

To treat the current authenticated user as a Freshchat user, simply add the TealOrca\LaravelFreshchat\Traits\ChatUser trait to the user authentication model.

use TealOrca\LaravelFreshchat\Traits\ChatUser;

class User extends Model {

    use ChatUser;

	/**
     * Specify the column name for Freshchat Restore Id
     */
    protected $freshchatRestoreId = '<<the column name you created for storing the Freshchat restoreId>>';

    /**
     * Specify the value for Freshchat External Id
     *
     * @return string
     */
    public function chatUserExternalId()
    {
        return $this->email; // using the user's email as the external id
    }

    /**
     * Specify the properties
     *
     * @return array
     */
    public function chatUserProperties() {

        return [
            'firstName' => 'first_name', ////// '<< Property Name for Freshchat >>' => '<< column name on the users table >>',
            'lastName' => 'last_name',
            'email' => 'email',
            'phone' => 'phone_no',
            'phoneCountryCode' => 'phone_country_code',
        ];
    }
}

Add the Restore Id column to your user table

php artisan make:migration add_freshchat_restore_id_to_users_table --table=users
class AddFreshchatRestoreIdToUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('users', function (Blueprint $table) {

            if (!Schema::hasColumn('users', 'freshchat_restore_id')) {
                Schema::table('users', function (Blueprint $table) {
                    $table->string('freshchat_restore_id')->nullable();
                });
            }

        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('users', function (Blueprint $table) {

            if (Schema::hasColumn('users', 'freshchat_restore_id')) {
                $table->dropColumn('freshchat_restore_id');
            }
        });
    }
}

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email danielfelix1995@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.