compredict/users-sdk-laravel

Compredict为Laravel提供的用户API。

dev-master 2021-04-19 10:08 UTC

README

这是一个简单的Laravel服务提供者,用于方便地将官方的COMPREDICT用户SDK for PHP集成到您的Laravel项目中。

本README针对服务提供者的1.x版本,该版本旨在与PHP和Laravel 5.x的1版本一起使用。

通过Composer安装

您可以通过在项目的composer.json文件中添加compredict/users-sdk-laravel包来使用Composer安装Compredict服务提供者。

{
    "require": {
        "compredict/users-sdk-laravel": "dev-master"
    }
}

然后运行composer update

php composer.phar update

Compredict配置

默认情况下,该包使用以下环境变量来自动配置插件,无需修改

COMPREDICT_USERS_ADMIN_KEY=  # Only needed if your application requires to register new users.
COMPREDICT_USERS_FAIL_ON_ERROR=True

要自定义配置文件,请使用Artisan发布包配置。

php artisan vendor:publish  --provider="Compredict\User\Providers\CompredictServiceProvider" --force

在生成的app/config/compredict.php配置文件中更新您的设置。

此外,发布还将提供以下内容

  • 登录和密码重置视图。
  • 与登录和密码重置关联的路由。
  • 添加继承自Compredict用户的用户类。

只有在设置了COMPREDICT_USERS_ADMIN_KEY值时,才会添加注册视图和路由。

用户

用户类具有以下属性

  • token, APIKey。
  • id。
  • username。
  • first_name。
  • last_name。
  • email。
  • organization。

目前我们只支持使用用户名进行登录。

更新用户信息

$user = \Auth::guard()->user();
$user->first_name = "Ousama";
$user->last_name = "Esbel";
$user->organization = "COMPREDICT";
$user->update();

从API刷新用户信息

$user = \Auth::guard()->user();
$user->fresh();