admn/admn-laravel

此包最新版本(1.3.12)没有可用的许可信息。

Laravel 与 ADMN 服务交互的包

1.3.12 2022-09-14 00:40 UTC

README

这是一个简单的 ADMN.io API 包装器,用 PHP 编写,适用于 Laravel。

功能

  • 将操作记录为实体(用户、客户、员工等。任何应用了我们的Trait的模型)

要求

  • PHP 7+
  • ADMN PHP SDK(通过 Composer 依赖自动安装)

安装

通过 Composer。

composer require admn/admn-laravel

php artisan vendor:publish --provider="Admn\Admn\AdmnServiceProvider"

模型配置

<?php 

namspace App\Models;

class User extends Authenticatable {
    ...
    use \Admn\Admn\PerformsActions;
    ...
        
    /**
     * How we display the entity in our interface 
     * @return string
     */
    protected function getAuditDisplayValue()
    {
        return $this->name;
    }
    
    /**
    * Key used to identify the entity in our platform 
    * @return string
    */
    protected function getAuditIdentifierKey()
    {
         return 'email';
    }
    
    /**
     * Value used to identify the entity in our platform 
     * @return string|int
     */
    protected function getAuditIdentifierValue()
    {
        return $this->email;
    }
}

使用

    $user = User::find(1);

    $user->logAction('Updated post title',['post:123'],['title' => 'My new title']);

    //OR in PHP 8.0+
    $user->logAction(
        action: 'Updated post title',
        tags: [
            'post:123'
        ],
        context: [
            'title' => 'My new title'
        ]
    );

即将推出

  • 能够从 API 获取动作的检索能力
  • 能够将动作记录卸载到队列
  • 能够选择区域(随着更多区域变得可用)