lyseontech/ojs-sdk

OJS 的 SDK 包

维护者

详细信息

github.com/LibreCodeCoop/ojs-sdk

源代码

问题

安装: 93

依赖项: 1

建议者: 0

安全: 0

星标: 2

关注者: 3

分支: 0

开放问题: 1

v0.1.4 2022-01-23 17:12 UTC

Requires (Dev)

GPL-3.0-only fb574209d0101ae66543f3c2524287874e2636da

sdkojs

This package is auto-updated.

Last update: 2024-09-20 00:53:42 UTC

README

Test Status

OJS-SDK

为 OJS 提供的 SDK 包

安装

composer require librecodecoop/ojs-sdk

配置

必须在同一服务器上安装 OJS。请告知 OJS 的路径，以供所有依赖项使用。如果您需要在登录后进行登录并获取用户令牌，请提供登录 URL。

如何使用？

  • 创建或更新用户
use OjsSdk\Services\OJSService\Users\OJSUserService;

$OjsClient = new OJSUserService();
$return = $OjsClient->createUpdateUser([
    'username'       => 'jhonusername',
    'password'       => '123password',
    'email'          => 'jhon.doe@test.coop',
    'mailingAddress' => 'Street 55',
    'locales'        => ['en_US'],
    'groups'         => [1], // administrator
    'givenName'      => ['en_US' => 'Jhon'],
    'familyName'     => ['en_US' => 'Doe'],
    'phone'          => '+123456789',
    'lattes'         => 'https://lattes.com'
]);
  • 更改密码
use OjsSdk\Services\OJSService\Users\OJSUserService;

$OjsClient = new OJSUserService();
$OjsClient->changePassword('jhonusername', '123password');
  • 获取唯一用户名
use OjsSdk\Services\OJSService\Users\OJSUserService;

$OjsClient = new OJSUserService();
$uniqueUsername = $OjsClient->getUniqueUsername('jhonusername', '123password');
  • 登录
use OjsSdk\Services\OJSService\Users\OJSUserService;

$OjsClient = new OJSUserService();
$loginResponse = $OjsClient->login('jhonusername', '123password');

进行任何操作

方法 OjsProvider::getApplication(); 提供了使用所有 OJS 类所需的一切。

有关更多信息，请参阅 OJSUserServiceTest.php 或 OJSUserService.php。

开发

使用 Docker 创建开发环境。

如果您不使用 Docker，请阅读 entrypoint.sh 和 Dockerfile。

运行测试

composer test