Skip to content

Latest commit

 

History

History
110 lines (68 loc) · 3.18 KB

README.md

File metadata and controls

110 lines (68 loc) · 3.18 KB

This is my package laravel-page-statistics

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Simple package for collection visited page statistic.

Installation

You can install the package via composer:

composer require infinityxtech/laravel-page-statistics

You can publish and run the migrations with:

php artisan vendor:publish --tag="page-statistics-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="page-statistics-config"

This is the contents of the published config file:

return [
    'geoip_db_path' => null
];

In case you need to update config of packages used here, check docs for:

Usage

First it is same as for eloquent-viewable you need to add these to your model:

use Illuminate\Database\Eloquent\Model;
use CyrildeWit\EloquentViewable\InteractsWithViews;
use CyrildeWit\EloquentViewable\Contracts\Viewable;

class Post extends Model implements Viewable
{
    use InteractsWithViews;

    // ...
}

Then, you can use this code to save stats to database:

// Route model binding example

Route::get('/post/{slug}', function (Post $post) {

    $pageStatistics = new InfinityXTech\PageStatistics();

    $view = $pageStatistics->record($post);

});

There is also a method to get details that are stored.

    $pageStatistics = new InfinityXTech\PageStatistics();

    $details = $pageStatistics->getDetails();

    // do whatever with $details

    $view = $pageStatistics->record($post, $details);

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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