Laravel Acquaintances

Laravel Acquaintances is a lightweight package designed to add social capabilities to Eloquent models without requiring a monolithic framework dependency. It provides the following core features:

• Friendships: Manage connections between models using groups.
• Verifications: Implement peer attestations using groups.
• Interactions: Support for Follow, Like, Favorite, Report, Subscribe, Vote, and View actions.
• Ratings: An advanced, multi-type rating system.

It is built to be modular and works with various Illuminate components.

By default, the package does not automatically load its migrations. Migrations will only be auto-loaded if:

1. You have explicitly configured them to be loaded,
2. OR no published migration files exist in your application's migration directory.

Add the package to your Laravel project using Composer:

composer require multicaret/laravel-acquaintances

After installing the package and (optionally) publishing the migrations, run the standard Laravel migration command to create the necessary database tables:

Note: By default, acquaintances.migrations is set to false in the configuration to prevent auto-loading vendor migrations. If you have not published the migrations manually, you may need to check the configuration or follow the specific migration loading documentation.

php artisan migrate

Install the package via Composer to add social features like Friendships, Verifications, and Interactions to your Eloquent models.

composer require multicaret/laravel-acquaintances

To manually manage the package migrations within your application's database/migrations folder, use the vendor:publish command with the acquaintances-migrations tag. This process uses updateMigrationDate() to ensure the files are created with current timestamps, allowing them to run in the correct order relative to your existing migrations.

php artisan vendor:publish --tag=acquaintances-migrations

To enable social features, import and use the relevant traits in your Eloquent models.

Common traits include:

• Friendable, Verifiable for relationship management.
• CanFollow, CanBeFollowed for following logic.
• CanLike, CanBeLiked for likes.
• CanRate, CanBeRated for ratings.

use Multicaret\Acquaintances\Traits\Friendable;
use Multicaret\Acquaintances\Traits\Verifiable;
use Multicaret\Acquaintances\Traits\CanFollow;
use Multicaret\Acquaintances\Traits\CanBeFollowed;
use Multicaret\Acquaintances\Traits\CanLike;
use Multicaret\Acquaintances\Traits\CanBeLiked;
use Multicaret\Acquaintances\Traits\CanRate;
use Multicaret\Acquaintances\Traits\CanBeRated;

class User extends Model {
    use Friendable, Verifiable;
    use CanFollow, CanBeFollowed;
    use CanLike, CanBeLiked;
    use CanRate, CanBeRated;
}

To use Laravel Acquaintances, ensure your environment meets the following requirements:

• PHP: version 8.1 or higher.
• Illuminate components: version ^9.0, ^10.0, ^11.0, ^12.0, or ^13.0 (supporting Laravel 9 through Laravel 13).

To enable the verification system, add the Multicaret\Acquaintances\Traits\Verifiable trait to your User model.

use Multicaret\Acquaintances\Traits\Verifiable;

class User extends Model { use Verifiable; }