README

西安交通大学 Webservice 的 PHP 客户端

目前支持：

• WsUserInfo 用户信息接口
• WsUserPhoto 用户照片接口
• WsSms 短信平台接口

使用方法

• 通过 Composer 引入包（Packagist）

composer require xjtuana/xjtu-webservice ~1.0

• 示例代码

use Xjtuana\XjtuWs\WebService\WsUserInfo;
use Xjtuana\XjtuWs\WebService\XjtuWebServiceException;

try {

    $userinfo = new WsUserInfo(
        // url of the webservice
        'url',
        // config of the webservice
        [
            'auth' => ...,
        ],
        // options for SoapClient (see: https://php.ac.cn/manual/en/soapclient.soapclient.php)
        [
            'compression ' => ....,
            'connection_timeout' => ...., // default connection_timeout = 5
            ...
        ]
    );
    
    $result = $userinfo->getByNetid('netid');
    
} catch(XjtuWebServiceException $e) {
    echo $e->getMessage();
} catch(\SoapFault $e) {
    throw $e;
}

var_dump($result);

API

WsUserInfo

• __construct() 构造函数
  • 参数：string 调用URL
  • 参数：array 配置数组

[
    'auth' => 'WS_AUTH',
]

• getByNetid() 通过 NETID 获取信息

  • 参数：string 查询的 NETID

  • 返回值：array 用户对象数组

• getByName() 通过姓名获取信息

  • 参数：string 查询的姓名

  • 返回值：array 用户对象数组

• getByUserno() 通过学工号获取信息

  • 参数：string 查询的学工号

  • 返回值：array 用户对象数组

• getByMobile() 通过手机号获取信息

  • 参数：string 查询的手机号

  • 返回值：array 用户对象数组

• setFilter() 设置要隐藏的字段

  • 参数：array 字段名数组

  • 返回值：UserInfo (可链式调用，对当前示例持续生效)

  • 示例：

  $userinfo->setFilter(['userno'])->getByNetid('netid');

  • 注意：默认filter = ['idcardname' ,'idcardno']，即默认隐藏证件名称和证件号码

字段列表

WsUserPhoto

• __construct() 构造函数
  • 参数：string 调用URL
  • 参数：array 配置数组

[
    'auth' => 'WS_AUTH',
]

• getByUserno() 通过学工号获取照片

  • 参数：string 查询的学工号

  • 返回值：string (base64)

WsSms

• __construct() 构造函数
  • 参数：string 调用URL
  • 参数：array 配置数组

[
    'usr' => 'WS_USER',
    'pwd' => 'WS_PASSWORD',
]

• send() 发送短信

  • 参数1：string 目标手机号，多个号码用半角逗号隔开

  • 参数2: string 短信内容，根据长度会拆分成多条

  • 返回值：int 发送结果，好像没什么用，成不成功都回0

相关包

• xjtuana/laravel-xjtuana