README

安装

需要 PHP 5.6。

使用 Composer

{
    "require": {
      "eduvo/php-api-library": "1.*"
    }
}

或

composer require eduvo/php-api-library

用法

使用 composer 安装后，请确保在您的 PHP 文件顶部包含以下行。

require 'vendor/autoload.php';

客户端

在使用 API 库之前，您需要使用您的 API Token 创建一个新的客户端。

$client = new \Eduvo\Client('YOUR API TOKEN');

示例

以下是一些如何使用库中各种端点的示例。

IB 群组

获取所有 IB 群组并显示群组名称

$ib_groups = $client->ib_groups->all();
foreach ($ib_groups as $ib_group) {
    echo $ib_group->name . PHP_EOL;
}

获取并显示 IB 群组的顾问

$advisors = $client->ib_groups->advisors(YOUR_IB_GROUP_ID);
foreach ($advisors as $advisor) {
    $teacher = $client->teachers->get($advisor->id);
    echo $teacher->first_name . ' ' . $teacher->last_name . PHP_EOL;
}

获取并显示 IB 群组的学生

$student_ids = $client->ib_groups->students(YOUR_IB_GROUP_ID);
foreach ($student_ids as $student_id) {
    $student = $client->students->get($student_id);
    echo $student->first_name . ' ' . $student->last_name . PHP_EOL;
}

将学生添加到 IB 群组

$students = [STUDENT1_ID, STUDENT2_ID];
$response = $client->ib_groups->add_students(YOUR_IB_GROUP_ID, $students);
echo $response->status;

从 IB 群组中删除学生

$students = [STUDENT1_ID, STUDENT2_ID];
$response = $client->ib_groups->remove_students(YOUR_IB_GROUP_ID, $students);
echo $response->status;

班级群组

获取所有班级并显示群组名称

$classes = $client->classes->all();
foreach ($classes as $class) {
    echo $class->name . PHP_EOL;
}

获取并显示单个班级的名称。

$class = $client->classes->get(10508262);
echo $class->name;

获取并显示班级的学生。

$student_ids = $client->classes->students(10753516);
foreach ($student_ids as $student_id) {
    $student = $client->students->get($student_id);
    echo $student->first_name . ' ' . $student->last_name . PHP_EOL;
}

将学生添加到班级。

$student_ids = [STUDENT1_ID, STUDENT2_ID];
$response = $client->classes->add_students(YOUR_CLASS_ID, $student_ids);
echo $response->status;

从班级中删除学生。

$student_ids = [STUDENT1_ID, STUDENT2_ID];
$response = $client->classes->remove_students(YOUR_CLASS_ID, $student_ids);
echo $response->status;

家长群组

获取并显示所有家长的电子邮件地址。

$parents = $client->parents->all();
foreach ($parents as $parent) {
    echo $parent->email . PHP_EOL;
}

获取并显示单个家长的电子邮件地址。

$parent = $client->parents->get(PARENT_ID);
echo $parent->email;

创建新的家长记录。

$parent = [
    'email' => 's.banderad@eduvo.com',
    'first_name' => 'Stepan',
    'last_name' => 'Bander',
    'child_ids' => [STUDENT1_ID]
];
$client->parents->create($parent);

更新家长记录。

$parent = [
    'child_ids' => [STUDENT1_ID, STUDENT2_ID]
];
$client->parents->update(PARENT_ID, $parent);

存档家长。

$response = $client->parents->archive(PARENT_ID);
echo $response->status;

取消存档家长。

$response = $client->parents->unarchive(PARENT_ID);
echo $response->status;

学生群组

获取并显示所有学生的电子邮件地址。

$students = $client->students->all();
foreach ($students as $student) {
    echo $student->email . PHP_EOL;
}

获取并显示单个学生的电子邮件地址。

$student = $client->students->get(STUDENT_ID);
echo $student->email;

创建新的学生记录。

$student = [
    'email' => 'kevin.epelbaum@eduvo.com',
    'first_name' => 'Kevin',
    'last_name' => 'Epelbaum'
];
$client->students->create($student);

更新学生记录。

$student = [
    'nationalities' => ['GB', 'US']
];
$client->students->update(STUDENT_ID, $student);

存档学生。

$response = $client->students->archive(STUDENT_ID);
echo $response->status;

取消存档学生。

$response = $client->students->unarchive(STUDENT_ID);
echo $response->status;

教师群组

获取并显示所有教师的电子邮件地址。

$teachers = $client->teachers->all();
foreach ($teachers as $teacher) {
    echo $teacher->email . PHP_EOL;
}

获取并显示单个学生的电子邮件地址。

$teacher = $client->teachers->get(TEACHER_ID);
echo $teacher->email;

创建新的教师记录。

$teacher = [
    'email' => 'john.epelbaum@eduvo.com',
    'first_name' => 'John',
    'last_name' => 'Epelbaum'
];
$client->teachers->create($teacher);

更新教师记录。

$teacher = [
    'nationalities' => ['GB']
];
$client->teachers->update(TEACHER_ID, $teacher);

eduvo / php-api-library

维护者

详细信息