laravel package to define some social relevance

This package provides a simple API to associate social relevance between Eloquent models.

Installation

You can install the package via composer:

composer require msr/laravel-relevance

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-relevance-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-relevance-config"

This is the contents of the published config file:

return [

    /**
     * database configuration
     */
    'database' => [
        'relevance_user_foreign_key_column_name' => 'user_id',
        'relevance_table_name' => 'relevance',
        'relevance_column_name' => 'relevance_name',
        'relevance_relation_column_name' => 'relation_name',
    ],
    
];

Usage

add Msr\LaravelRelevance\Traits\CanDoRelevance trait to your model, which one can do some action... e.x= User

use Illuminate\Foundation\Auth\User as Authenticatable;
use Msr\LaravelRelevance\Traits\CanDoRelevance;

class User extends Authenticatable
{
    use CanDoRelevance;

then you can define relation between you models like below:

$mainUser->addRelevence('your_relation_name', $yourModel);

or remove relation:

$mainUser->removeRelevence('your_relation_name', $yourModel);

you can toggle relation:

$mainUser->toggleRelevence('your_relation_name', $yourModel);

check relation exists:

$mainUser->relevanceExist('your_relation_name', $yourModel);

get relation:

$mainUser->getRelevance('your_relation_name', $yourModel);

count of a relation of model:

$mainUser->relevanceCount('your_relation_name');

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

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