homeworker/homeworker-php

0.0.35 2020-09-30 11:19 UTC

Requires

• php: >=7.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: 6.5.0

Requires (Dev)

• phpunit/phpunit: ^4.8

proprietary

• xolf UG (haftungsbeschränkt)
• Florian Theimer

• php
• api
• sdk
• homeworker
• schulplaner

README

Der Client für die Homeworker-Api befindet sich noch in der Alpha-Entwicklung.
Es können möglicherweiße noch Major-Changes vorgenommen werden.

Einrichtung

Zur Verwendung der meisten Api-Anwendungen ist ein Api-Token notwendig, welche in Hubi generiert werden können.

composer require homeworker/homeworker-php

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

Verwendung

Resourcen erhalten

Ohne ID

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

Mit ID

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

Resource erstellen

/** @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"

Resource updaten

/** @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"