uwdoem / group
华盛顿大学集团网络服务客户端库
1.0.13
2017-11-20 18:31 UTC
Requires
- uwdoem/connection: 3.*
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- phpunit/phpunit: 6.*
- squizlabs/php_codesniffer: 2.*
- sunra/php-simple-html-dom-parser: ^1.5
- uwdoem/standard: *
This package is not auto-updated.
Last update: 2024-09-21 02:00:27 UTC
README
UWDOEM/Group
使用X.509证书认证,平滑地轮询华盛顿大学的Person Web Service (PWS)和学生Web服务(SWS),以聚合特定成员的数据。
注意
这不是一个官方库,不受到通过GWS访问的信息的管理者或所有方的认可或支持。这个库也不受到华盛顿大学招生管理部的认可或支持。
安装
此库在Packagist上发布。要使用Composer安装,请在“require”依赖中添加"uwdoem/group": "1.*"
行。
{
"require": {
"uwdoem/aliro": "1.*"
}
}
当然,您也可以直接下载使用Aliro而不使用Composer,但强烈建议使用Composer来管理包。有关更多信息,请参阅Composer。
使用
要访问GWS,您需要一个私钥和大学签名的证书。
您可以在应用程序的任何地方设置所需的设置,但我们建议使用local-settings.php文件。
// Intialize the required settings
define('UW_GWS_BASE_PATH', '/path/to/your/api/');
define('UW_GWS_SSL_KEY_PATH', './path/to/your/key');
define('UW_GWS_SSL_CERT_PATH', './path/to/your/certificate');
define('UW_GWS_SSL_KEY_PASSWD', 'yourpassword'); // Can be blank for no password: ''
define('UW_GWS_VERBOSE', true); // (Optional) Whether to include verbose cURL messages in error messages.
UW_GWS_SSL_KEY_PATH
和UW_GWS_SSL_CERT_PATH
术语对应于您的私钥和大学签名证书的绝对位置。UW_GWS_SSL_KEY_PASSWD
对应于解锁您的私钥的字符串;如果您的密钥没有密码,则使用空字符串,例如:''。
UW_GWS_BASE_PATH
术语对应于集团网络服务的基准URL。
现在您可以创建一个组访问对象,并开始查询GWS。有关可用的端点的更多信息,请参阅GWS文档。
$g = new Group("test_group_name"); // You can pass either the group name or id
$memberList = $g->getMembers()
故障排除
X-Act-As
某些端点如果设置了X-Act-As将返回错误,而其他端点则允许。确保您使用UWDOEM/Connection 3.*,并且您没有在连接选项中包含X-Act-As。
需求
- PHP 7.0
- uwdoem/connection 3.*