🔧 Installation

Please read carefully the instructions below and follow them step by step.

Install the package

You can install the package via composer:

composer require cslant/laravel-like

The package will automatically register its service provider.

Configuration

required

This is a required step. Please don't skip it.

You can publish all the necessary configuration and migration files by running the following command:

php artisan vendor:publish --provider="CSlant\LaravelLike\LikeServiceProvider"

This is the default content of the config file:

return [
    'name' => 'The interactions configuration',

    /*
     * The flag to determine if the interactions table should use UUIDs.
     * If you want to use UUIDs instead of auto-incrementing integers for your interactions table, set this to true.
     */
    'is_uuids' => false,

    /*
     * The table name for interaction records.
     */
    'table_name' => 'likes',

    /*
     * The model class for the interaction table.
     */
    'interaction_model' => 'CSlant\LaravelLike\Models\Like',

    /*
     * The model and foreign key for the user relationship.
     */
    'users' => [
        /*
         * User model class.
         * Use this to set the user model class for the user relationship.
         */
        'model' => 'App\Models\User',

        /*
         * User tables foreign key name.
         * Use this to set the foreign key name for the user relationship.
         */
        'foreign_key' => 'user_id',
    ],
];

Migrate the database

After the configuration file has been published, you can run the migration:

php artisan migrate

The migration will create a likes table in your database. This table will store all the likes.

Import the trait in the appropriate model

Please import the HasLike trait in your model to use the package.

For example, you have a Post model, and you want to add likes to it. You can import the HasLike trait in the Post model.

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use CSlant\LaravelLike\HasLike;

class Post extends Model
{
    use HasLike;
    
    // Your model code here
}

Import the trait in your User model

After importing the HasLike trait in your model, you need to import the UserHasInteraction trait in your User model.

Why need to import the UserHasInteraction trait in the User model?

The UserHasInteraction trait is used to define the relationship between the user and the interactions.

It is required to get the interactions for a user.

Also, it provides the methods to interact with the interactions.

How to import the UserHasInteraction trait in the User model?

You can import the UserHasInteraction trait in your User model like this:

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use CSlant\LaravelLike\UserHasInteraction;

class User extends Authenticatable
{
    use UserHasInteraction;
    
    // Your model code here
}

That's it! You have successfully installed the Laravel Like package. 🎉

---