README

XJTUANA development package for Laravel

Site: https://ana.xjtu.edu.cn

Authors:

• meteorlxy - [meteor.lxy@foxmail.com]

Introduction 简介

CAS模块

• 通过xjtuana/cas-proxy-client，结合xczh/cas-proxy进行CAS代理认证
• 通过Laravel的Eloquent模型和用户认证，配置使用CAS的用户登录认证流程

WS模块

• 快速使用学校的相应Webservice接口
• 目前支持：查询用户信息、查询用户照片、发送短信
• 需要向网络信息中心申请使用权限

API模块

• 快速使用学校的相应API
• 目前支持：查询用户Network日志
• 需要向网络信息中心申请使用权限

HealthCheck模块

• 快速使用社团福利健康检测
• 目前支持：KMS, Jetbrains, SS

Usgae 使用方法

1. 通过Composer引入（Packagist）

composer require xjtuana/laravel-xjtuana ~2.0.0

2. 注册ServiceProvider & Facade

** 可以通过Xjtuana\XjtuanaServiceProvider配置所有模块，也可以根据需要的子模块，使用其中提供的ServiceProvider分别配置 **

在config/app.php的providers下，加入：

Xjtuana\XjtuanaServiceProvider::class,

在config/app.php的aliases下，加入：

'CasProxy' => Xjtuana\Cas\Facades\XjtuanaCasProxy::class,
'WsUserInfo' => Xjtuana\XjtuWs\Facades\XjtuWsUserInfo::class,
'WsUserPhoto' => Xjtuana\XjtuWs\Facades\XjtuWsUserPhoto::class,
'WsSms' => Xjtuana\XjtuWs\Facades\XjtuWsSms::class,
'ApiNetworkLog' => Xjtuana\XjtuApi\Facades\XjtuApiNetworkLog::class,
'ApiSms' => Xjtuana\XjtuApi\Facades\ApiSms::class,
'CheckJetbrains' => Xjtuana\HealthCheck\Facades\CheckJetbrains::class,
'CheckKms' => Xjtuana\HealthCheck\Facades\CheckKms::class,
'CheckShadowsocks' => Xjtuana\HealthCheck\Facades\CheckShadowsocks::class,

3. 配置

运行以下命令生成配置文件

php artisan vendor:publish --provider="Xjtuana\XjtuanaServiceProvider"

根据需要，在.env文件中配置相应变量

XJTUANA_CAS_PROXY_PROTOCOL=
XJTUANA_CAS_PROXY_HOSTNAME=
XJTUANA_CAS_PROXY_PREFIX=
XJTUANA_CAS_PROXY_VERSION=

XJTUANA_WS_USERINFO_URL=
XJTUANA_WS_USERINFO_AUTH=
XJTUANA_WS_USERPHOTO_URL=
XJTUANA_WS_USERPHOTO_AUTH=
XJTUANA_WS_SMS_URL=
XJTUANA_WS_SMS_USER=
XJTUANA_WS_SMS_PWD=

XJTUANA_API_NETWORKLOG_URL=
XJTUANA_API_SMS_URL=
XJTUANA_API_SMS_ACCOUNT_ID=
XJTUANA_API_SMS_ACCOUNT_KEY=
XJTUANA_API_SMS_CHANNEL_ID=

4. 具体模块配置和使用

• CAS模块
• Ws模块
• Api模块