Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shetabit/visitor
a laravel package to work with visitors and retrieve their informations
https://github.com/shetabit/visitor
laravel laravel-online-users visitor-information
Last synced: 4 days ago
JSON representation
a laravel package to work with visitors and retrieve their informations
- Host: GitHub
- URL: https://github.com/shetabit/visitor
- Owner: shetabit
- License: mit
- Created: 2019-10-14T06:48:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T05:32:38.000Z (8 months ago)
- Last Synced: 2024-12-13T13:05:19.811Z (11 days ago)
- Topics: laravel, laravel-online-users, visitor-information
- Language: PHP
- Homepage:
- Size: 80.1 KB
- Stars: 535
- Watchers: 9
- Forks: 69
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Visitor
This is a laravel package to extract and access visitors' information such as `browser`, `ip`, `device` and etc.
**In this package, you can recognize online users and determine if a user is online or not**
### Install
Via composer
```bash
composer require shetabit/visitor
```
### Configure
If you are using Laravel 5.5 or higher then you don't need to add the provider and alias.
```php
# In your providers array.
'providers' => [
...
Shetabit\Visitor\Provider\VisitorServiceProvider::class,
],
# In your aliases array.
'aliases' => [
...
'Visitor' => Shetabit\Visitor\Facade\Visitor::class,
],
```
Then, run the below commands to publish migrations and create tables
```bash
php artisan vendor:publish
php artisan migrate
```
### How to use
You can access to `visitor's information` using `$request->visitor()` in your controllers , and you can access to the visitor's information using `visitor()` helper function any where.
We have the below methods to retrieve a visitor's information:
- `device` : device's name
- `platform` : platform's name
- `browser` : browser's name
- `languages` : language's name
- `ip` : client's ip
- `request` : the whole request inputs
- `useragent` : the whole useragent
- `isOnline` : determines if current (or given) user is online
```php
$request->visitor()->browser(); // firefox
$request->visitor()->visit($post); // create log for post
$request->visitor()->setVisitor($user)->visit($post); // create a log which says $user has visited $post
```
#### Store Logs
You can create logs using the `visit` method like the below
```php
visitor()->visit(); // create a visit log
```
use `Shetabit\Visitor\Traits\Visitable` trait in your models, then you can save visit's log for your models like the below
```php
// or you can save log like the below
visitor()->visit($model);
// or like the below
$model->createVisitLog();
// you can say which user has visited the given $model
$model->createVisitLog($user);
// or like the below
visitor()->setVisitor($user)->visit($model);
```
Model views can be loaded using `visits` relation.
You can count model visits like the below
```php
$model->visitLogs()->count();
```
unique users can be counted by their IP and by model.
```php
// by ip
$model->visitLogs()->distinct('ip')->count('ip');
// by user's model
$model->visitLogs()->visitor()->count();
```
use `Shetabit\Visitor\Traits\Visitor` in your `User` class, then you can run below codes
```php
$user->visit(); // create a visit log
$user->visit($model); // create a log which says, $user has visited $model
```
#### Retrieve and Determine Online users
use `Shetabit\Visitor\Traits\Visitor` in your `User` class at first.
Then you can retrieve online users which are instance of `User` class and determine if a user is online.
```php
visitor()->onlineVisitors(User::class); // returns collection of online users
User::online()->get(); // another way
visitor()->isOnline($user); // determines if the given user is online
$user->isOnline(); // another way
```
#### Automatic logging
Your application can store visitor's log automatically using `LogVisits` middleware.
Add the `Shetabit\Visitor\Middlewares\LogVisits` middleware if you want to save logs automatically.
The middleware will store logs for models which has binded in router (router model binding) and has used `Shetabit\Visitor\Traits\Visitable` trait.
## Star History
[](https://star-history.com/#shetabit/visitor&Date)