nitroxy/nxauth

该软件包最新版本(v1.1)没有可用的许可证信息。

NitroXys CAS-service 认证模块

v1.1 2016-07-11 14:37 UTC

This package is auto-updated.

Last update: 2024-09-11 19:30:47 UTC


README

此代码为 nitroxy.com 提供了一个 API。在基本层面,它提供了 CAS 登录,只能获取用户的用户名和姓名,但通过 API 密钥,您可以访问更多内容。

用法

将此作为子模块放入您的仓库中,然后复制 nxauth.sample.php 到您的项目中并修改它。

函数

NXAuth

这些函数不需要 API 密钥

  • NXAuth::login():触发登录
  • NXAuth::logout():触发注销
  • NXAuth::is_authenticated():bool
  • NXAuth::user():返回当前用户的一个 NXUser 实例,或 null

NXUser

这些函数不需要 API 密钥

包含以下属性

  • username
  • user_id
  • fullname
  • ticket

NXAPI

NXAPI::api_function_name(api_options) 使用 api_options 调用 api_function_name。