zvermafia/lavoter

Voteable Polymorphic Eloquent Models for Laravel 5 without user authentication. This means that for the identification of the user, we will use the fingerprintjs2 instead of authorization on the site.

Maintainers

Details

github.com/zvermafia/lavoter

Source

Issues

Installs: 1 054

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 0

Forks: 0

Language:Blade

4.1.2 2023-12-20 06:48 UTC

Requires

MIT 86d35ab13c5a76d06cc0486e72ffea44dc90791f

  • Mokhirjon Naimov
  • Temurbek Sabirov

This package is auto-updated.

Last update: 2024-03-20 07:21:45 UTC

README

Voteable Polymorphic Eloquent Models for Laravel 5 without user authentication. This means that for the identification of the user, we will use the fingerprintjs2 instead of authorization on the site.

Installation

First, pull in the package through Composer.

composer require zvermafia/lavoter

Include the service provider within config/app.php.

'providers' => [
    // ...
    Zvermafia\Lavoter\LavoterServiceProvider::class
],

You need to publish and run the migration.

php artisan vendor:publish --provider="Zvermafia\Lavoter\LavoterServiceProvider"
php artisan migrate

To initialize the fingerprintjs2 and to set an uuid for the user you must to include a view part of this package to your site template. After the fingerprintjs2 initialized will be declared a global JavaScript variable with the name lavoter_uuid.

For example:

<!-- Let's imagine this is a base template for your frontend section -->
<!DOCTYPE html>
<html lang="en">
    <head>
        <title>@yield('title', 'The App Name')</title>
    </head>
    <body>
        @yield('body')

        <!-- Don't forget jQuery must be included too  -->
        <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
        
        <!-- And here a view part of this package -->
        @include('lavoter::get')
    </body>
</html>

To finish installing add a cookie name within app/Http/Middleware/EncryptCookies.php. For example:

<?php

namespace App\Http\Middleware;

use Illuminate\Cookie\Middleware\EncryptCookies as BaseEncrypter;

class EncryptCookies extends BaseEncrypter
{
    /**
     * The names of the cookies that should not be encrypted.
     *
     * @var array
     */
    protected $except = [
        'lavoter_uuid',
    ];
}

Setup a Model

<?php

namespace App;

use Zvermafia\Lavoter\Contracts\Voteable;
use Zvermafia\Lavoter\Traits\Voteable as VoteableTrait;
use Illuminate\Database\Eloquent\Model;

class Article extends Model implements Voteable
{
    use VoteableTrait;
}

Usage

// Before you need to import a Vote model
use Zvermafia\Lavoter\Models\Vote;

// Up-vote
Vote::up($article, $uuid);

// Down-vote
Vote::down($article, $uuid);