aselsan/visitors

dev-main 2024-09-16 22:22 UTC

This package is auto-updated.

Last update: 2024-09-16 22:22:44 UTC


README

CodeIgniter Shield 的轻量级用户配置文件访问跟踪系统,设计用于监控用户配置文件访问,类似于领英的配置文件查看者功能。

安装

通过 Composer 轻松安装,以利用 CodeIgniter 4 的自动加载功能并始终保持最新状态

composer require aselsan/visitors

下载文件并包含在自动加载中后,运行任何库迁移以确保数据库正确设置

php spark migrate --all

配置

HasVisitors 特性添加到您的用户模型中,并使用 initVisitors() 方法初始化访问者。

class ExampleUsersModel extends BaseModel
{
    use HasVisitors;

    // ...

    protected function initialize()
    {
        $this->initVisitors();
    }

    // ...
}

如果您使用实体类,请向其中添加 Visitable 特性

class ExampleUser extends Entity
{
    use Visitable;

    // ...
}

用法

访问用户

记录特定用户的配置文件访问

$users = auth()->getProvider();
$user  = $users->find($id);

// Record a visit to this user
$user->visit();

获取带有访问者信息的用户

检索用户及其访问者

$users = auth()->getProvider();
$user  = $users->withVisitors()->find($id);

// Get total number of visitors
$user->getSumVisitors();

// Get detailed visitor information
$user->visitors;
// or
$user->getVisitors();

许可

本项目采用 MIT 许可证 - 详细信息请参阅LICENSE 文件。