README

Homeworker-Api 客户端目前处于 alpha 开发阶段。
可能还会进行重大更改。

配置

为了使用大多数 Api 应用，需要一个在 Hubi 生成的 Api-Token。

composer require homeworker/homeworker-php

Homeworker\Api\Client::setApiToken('<TOKEN>');

使用方法

获取资源

无 ID

/** @var Homeworker\Api\Resources\SchoolMananger\School $school **/
$school = Homeworker\Api\Resources\SchoolMananger\School::retrieve();
echo $school->name; // "Beispiel-Gymnasium Musterhausen"

带 ID

/** @var Homeworker\Api\Resources\SchoolMananger\Students $student **/
$student = Homeworker\Api\Resources\SchoolMananger\Students::retrieve('<ID>');
echo $student->first_name; // "Max"

创建资源

/** @var Homeworker\Api\Resources\SchoolMananger\Students $student **/
$student = Homeworker\Api\Resources\SchoolMananger\Students::create([
    'first_name' => 'Marion', 
    'last_name' => 'Musterfrau', 
    'birthday' => '2002-11-23',
    'grade' => '9',
    'course' => '9c',
    'import_key' => 'key-123456',
    'import_source' => 'api'
]);
echo $student->id; // z.B. 532636
echo $student->first_name; // z.B. "Marion"

更新资源

/** @var Homeworker\Api\Resources\SchoolMananger\Students $student **/
$student = Homeworker\Api\Resources\SchoolMananger\Students::update($student_id, [
    'first_name' => 'Marionetta', 
]);
echo $student->first_name; // z.B. "Marionetta"