A clean way to track your pages & understand your user's behavior. This implement laravisit to OctoberCMS.
- October CMS 3.0 or above
Run the following to install this plugin:
php artisan plugin:install CWTeam.OctoVisit
To uninstall this plugin:
php artisan plugin:remove CWTeam.OctoVisit
then, run database migration
php artisan october:migrate
Then implement the CWTeam\OctoVisit\Behaviors\VisitModel behavior in the model class:
namespace Acme\Demo\Models\Post;
use CWTeam\OctoVisit\Behaviors\VisitModel;
class Post extends Model
{
...
public $implement = [
VisitModel::class,
];
...
}
After this step, you are all set, you can now count visits by using visit
method, but please keep in mind that the method returns an instance of the CWTeam\OctoVisit\PendingVisit class.
$post->visit();
You can chain methods to the visit
method. Here are a list of the available methods:
METHOD | SYNTAX | DESCRIPTION | EXAMPLE |
---|---|---|---|
withIp() |
string $ip = null |
Set an Ip address (default request()->ip() ) |
$post->visit()->withIp() |
withSession() |
string $session = null |
Set an Session ID (default session()->getId() ) |
$post->visit()->withSession() |
withData() |
array $data |
Set custom data | $post->visit()->withData(['region' => 'USA']) |
withUser() |
Model $user = null |
Set a user model (default Auth::getUser() ) |
$user->visit()->withUser() |
By default, you will have unique visits each day using dailyInterval()
method. Meaning, when the users access the page multiple times in a day time frame, you will see just one record
related to them.
If you want to log users access to a page with different timeframes, here are a bunch of useful methods:
METHOD | SYNTAX | DESCRIPTION | EXAMPLE |
---|---|---|---|
hourlyInterval() |
void |
Log visits each hour | $post->visit()->hourlyIntervals()->withIp(); |
dailyInterval() |
void |
Log visits each day | $post->visit()->dailyIntervals()->withIp(); |
weeklyInterval() |
void |
Log visits each week | $post->visit()->weeklyIntervals()->withIp(); |
monthlyInterval() |
void |
Log visits each month | $post->visit()->monthlyIntervals()->withIp(); |
yearlyInterval() |
void |
Log visits each year | $post->visit()->yearlyIntervals()->withIp(); |
customInterval() |
mixed $interval |
Log visits within a custom interval | $post->visit()->customInterval( now()->subYear() )->withIp(); |
After the visits get logged, you can retrieve the data by the following method:
METHOD | SYNTAX | DESCRIPTION | EXAMPLE |
---|---|---|---|
withTotalVisitCount() |
void |
get total visit count | Post::withTotalVisitCount()->first()->visit_count_total |
popularAllTime() |
void |
get popular visits all time | Post::popularAllTime()->get() |
popularToday() |
void |
get popular visits in the current day | Post::popularToday()->get() |
popularLastDays() |
int $days |
get popular visits last given days | Post::popularLastDays(10)->get() |
popularThisWeek() |
void |
get popular visits this week | Post::popularThisWeek()->get() |
popularLastWeek() |
void |
get popular visits last week | Post::popularLastWeek()->get() |
popularThisMonth() |
void |
get popular visits this month | Post::popularThisMonth()->get() |
popularLastMonth() |
void |
get popular visits last month | Post::popularLastMonth()->get() |
popularThisYear() |
void |
get popular visits this year | Post::popularThisYear()->get() |
popularLastYear() |
void |
get popular visits last year | Post::popularLastYear()->get() |
popularBetween() |
Carbon $from , Carbon $to |
get popular visits between custom two dates | Post::popularBetween(Carbon::createFromDate(2019, 1, 9), Carbon::createFromDat(2022, 1, 3))->get(); |
This package is coming with helpful decorate model properties, and it uses Laravel Presenter package under the hood.
METHOD | SYNTAX | DESCRIPTION | EXAMPLE |
---|---|---|---|
ip() |
void |
Get the associated IP from the model instance | $post->visits->first()->present()->ip |
user() |
void |
Get the associated User from the model instance | $post->visits->first()->present()->user->name |
- View in list. Add to columns.yaml
visits_count:
label: Visits count
relation: visits
relationCount: true
type: number
- View in form. Add in fields.yaml
visits:
label: Count visits
type: octovisit_visits_count
context: [preview, update]
readOnly: true
- Add in fields.yaml
visitors:
label: List of visitors
type: partial
context: [ preview, update ]
readOnly: true
- Create view _visitors.htm in folder with controller config
<table class="table">
<thead>
<tr>
<th>User id</th>
<th>User email</th>
<th>IP</th>
<th>Date visit</th>
</tr>
</thead>
<tbody>
<?php foreach ($formModel->visits as $visit) { ?>
<tr>
<td><?= $visit->present()->user()->id ?? '-' ?></td>
<td><?= $visit->present()->user()->email ?? '-' ?></td>
<td><?= $visit->present()->ip() ?></td>
<td><?= $visit->created_at ?></td>
</tr>
<?php } ?>
</tbody>
</table>
Please see CHANGELOG for more information on what has changed recently.
The MIT License (MIT). Please see License File for more information.