php clientダウンロードphp clientソースコードのダウンロード

Wonde PHPクライアント

ドキュメントhttps://wonde.com/docs/api/1.0/

インストール

PHP 7.2.5+が必要です（PHP 8.0を含む）

作曲家の使用：

{
  "require" : {
    "wondeltd/php-client" : " 3.* "
  }
}

または

composer require wondeltd/php-client

早期リリース

新しいエンドポイント /改善に早期にアクセスしたい場合は、パッケージバージョンをdev-masterに設定してください。

重要な注意： Wondeは、生産時に安定したバージョンにロックすることを強くお勧めします。

エンドポイント

クライアント

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

学校

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Loop through the schools your account has access to
foreach ( $ client -> schools -> all () as $ school ) {
    // Display school name
    echo $ school -> name . PHP_EOL ;
}

単一の学校

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Get single school
$ school = $ client -> schools -> get ( ' SCHOOL_ID_GOES_HERE ' );

保留中の学校

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

foreach ( $ client -> schools -> pending () as $ school ) {
    // Display school name
    echo $ school -> name . PHP_EOL ;
}

学校を検索します

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Search for schools with a postcode starting CB21
foreach ( $ client -> schools -> search ([], [ ' postcode ' => ' CB21 ' ]) as $ school ) {
    // Display school name
    echo $ school -> name . PHP_EOL ;
}

// Search for schools with the establishment number = 6006
foreach ( $ client -> schools -> search ([], [ ' establishment_number ' => ' 6006 ' ]) as $ school ) {
    // Display school name
    echo $ school -> name . PHP_EOL ;
}

アクセスをリクエストします

学校のIDを提供して、学校のデータへのアクセスを要求します。

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );
$ client -> requestAccess ( ' A0000000000 ' );

アクセスを取り消します

既に承認または保留中の承認にアクセスするために、学校IDを提供します。

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );
$ client -> revokeAccess ( ' A0000000000 ' );

学生

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get students
foreach ( $ school -> students -> all () as $ student ) {
    echo $ student -> forename . ' ' . $ student -> surname . PHP_EOL ;
}

// Get single student
$ student = $ school -> students -> get ( ' STUDENT_ID_GOES_HERE ' );

// Get students and include contact_details object
foreach ( $ school -> students -> all ([ ' contact_details ' ]) as $ student ) {
    echo $ student -> forename . ' ' . $ student -> surname . PHP_EOL ;
}

// Get students and include contacts array
foreach ( $ school -> students -> all ([ ' contacts ' ]) as $ student ) {
    echo $ student -> forename . ' ' . $ student -> surname . PHP_EOL ;
}

// Get students, include contact_details object, include extended_details object and filter by updated after date
foreach ( $ school -> students -> all ([ ' contact_details ' , ' extended_details ' ], [ ' updated_after ' => ' 2016-06-24 00:00:00 ' ]) as $ student ) {
    echo $ student -> forename . ' ' . $ student -> surname . PHP_EOL ;
}

入場前の学生

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get students
foreach ( $ school -> studentsPreAdmission -> all () as $ studentPreAdmission ) {
    echo $ studentPreAdmission -> forename . ' ' . $ studentPreAdmission -> surname . PHP_EOL ;
}

// Get single student
$ student = $ school -> studentsPreAdmission -> get ( ' STUDENT_ID_GOES_HERE ' );

成果

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get achievements
foreach ( $ school -> achievements -> all () as $ achievement ) {
    echo $ achievement -> comment . PHP_EOL ;
}

成果を投稿します

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );
$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

$ array = [
    ' students '      => [
        [
            ' student_id ' => ' A1039521228 ' ,
            ' points '     => 200 ,
            ' award '      => ' TROP ' ,
            ' award_date ' => ' 2016-04-05 ' ,
        ],
    ],
    ' employee_id '   => ' A1375078684 ' ,
    ' date '          => ' 2016-04-04 ' ,
    ' type '          => ' NYPA ' ,
    ' comment '       => ' A4 ' ,
    ' activity_type ' => ' RE ' ,
];

try {
    $ response = $ school -> achievements -> create ( $ array );
} catch (  Wonde  Exceptions  ValidationError $ error ) {
    $ errors = $ error -> getErrors ();
}

達成を削除します

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

$ school -> achievements -> delete ( ' WONDE_ACHIEVEMENTS_ID_HERE ' );

達成属性

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get achievement attributes
foreach ( $ school -> achievementsAttributes -> all () as $ achievement ) {
    echo $ achievement -> id . PHP_EOL ;
}

評価 - （ベータ）

このエンドポイントは安定したリリースに含まれていますが、将来変化する可能性があります。詳細については、サポートにお問い合わせください。

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get aspects
foreach ( $ school -> assessment -> aspects -> all () as $ aspect ) {
    echo $ aspect -> id . PHP_EOL ;
}

// Get templates
foreach ( $ school -> assessment -> templates -> all () as $ templates ) {
    echo $ templates -> id . PHP_EOL ;
}

// Get result sets
foreach ( $ school -> assessment -> templates -> all () as $ resultsets ) {
    echo $ resultsets -> id . PHP_EOL ;
}

// Get results
foreach ( $ school -> assessment -> results -> all () as $ results ) {
    echo $ results -> id . PHP_EOL ;
}

// Get marksheets
foreach ( $ school -> assessment -> marksheets -> all () as $ marksheets ) {
    echo $ marksheets -> id . PHP_EOL ;
}

出席

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get attendance
foreach ( $ school -> attendance -> all () as $ attendance ) {
    echo $ attendance -> comment . PHP_EOL ;
}

出席後

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Initiate a new register
$ register = new  Wonde  Writeback  SessionRegister ();

// Initiate a new attendance record
$ attendance = new  Wonde  Writeback  SessionAttendanceRecord ();

// Set fields
$ attendance -> setStudentId ( ' STUDENT_ID_GOES_HERE ' );
$ attendance -> setDate ( ' 2017-01-01 ' );
$ attendance -> setSession ( ' AM ' ); // AM or PM
$ attendance -> setAttendanceCodeId ( ' ATTENDANCE_CODE_ID_GOES_HERE ' );
$ attendance -> setComment ( ' Comment here. ' );
$ attendance -> setMinutesLate ( 10 );

// Add attendance mark to register
$ register -> add ( $ attendance );

// Save the session register
$ result = $ school -> attendance ()-> sessionRegister ( $ register );

// Writeback id is part of the response
echo $ result -> writeback_id ;

出席コード

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Get attendance codes
foreach ( $ client -> attendanceCodes -> all () as $ attendanceCode ) {
    echo $ attendanceCode -> code . PHP_EOL ;
}

// Get school attendance codes
$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );
foreach ( $ school -> attendanceCodes -> all () as $ attendanceCode ) {
    echo $ attendanceCode -> code . PHP_EOL ;
}

出席要約

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get attendance summaries
foreach ( $ school -> attendanceSummaries -> all () as $ attendanceSummary ) {
    echo $ attendance -> possible_marks . PHP_EOL ;
}

行動

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get behaviours
foreach ( $ school -> behaviours -> all () as $ behaviour ) {
    echo $ behaviour -> incident . PHP_EOL ;
}

動作を投稿します

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );
$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

$ array = [
    ' students '      => [
        [
            ' student_id '  => ' A1039521228 ' ,
            ' role '        => ' AG ' ,
            ' action '      => ' COOL ' ,
            ' action_date ' => ' 2016-04-01 ' ,
            ' points '      => 200 ,
        ],
        [
            ' student_id ' => ' A870869351 ' ,
            ' role '       => ' TA ' ,
            ' points '     => 2 ,
        ],
    ],
    ' employee_id '   => ' A1375078684 ' ,
    ' date '          => ' 2016-03-31 ' ,
    ' status '        => ' REV2 ' ,
    ' type '          => ' BULL ' ,
    ' bullying_type ' => ' B_INT ' ,
    ' comment '       => ' Bulling incident ' ,
    ' activity_type ' => ' RE ' ,
    ' location '      => ' CORR ' ,
    ' time '          => ' LUN ' ,
];

try {
    $ response = $ school -> behaviours -> create ( $ array );
} catch (  Wonde  Exceptions  ValidationError $ error ) {
    $ errors = $ error -> getErrors ();
}

動作を削除します

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

$ school -> behaviours -> delete ( ' WONDE_BEHAVIOUR_ID_HERE ' );

動作属性

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get behaviours
foreach ( $ school -> behavioursAttributes -> all () as $ behaviour ) {
    echo $ behaviour -> id . PHP_EOL ;
}

クラス

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get classes
foreach ( $ school -> classes -> all () as $ class ) {
    echo $ class -> name . PHP_EOL ;
}

連絡先

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get contacts
foreach ( $ school -> contacts -> all () as $ contacts ) {
    echo $ contacts -> forename . ' ' . $ contacts -> surname . PHP_EOL ;
}

カウント

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get counts
$ counts = $ school -> counts -> all ([ ' students ' , ' contacts ' ]);
echo $ counts -> array -> students -> data -> count . PHP_EOL ;
echo $ counts -> array -> contacts -> data -> count . PHP_EOL ;

削除

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get deletions
foreach ( $ school -> deletions -> all () as $ deletions ) {
    echo $ deletions -> id ;
}

従業員

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get employees
foreach ( $ school -> employees -> all () as $ employee ) {
    echo $ employee -> forename . ' ' . $ employee -> surname . PHP_EOL ;
}

従業員の欠席

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get employee absences
foreach ( $ school -> employeeAbsences -> all () as $ employeeAbsence ) {
    echo $ employeeAbsence -> employee . ' ' . $ employeeAbsence -> absence_type . PHP_EOL ;
}

イベント

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get events
foreach ( $ school -> events -> all () as $ event ) {
    echo $ event -> id . PHP_EOL ;
}

グループ

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get groups
foreach ( $ school -> groups -> all () as $ group ) {
    echo $ group -> name . PHP_EOL ;
}

レッスン

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get lessons
foreach ( $ school -> lessons -> all () as $ lesson ) {
    echo $ lesson -> period_id . ' - ' . $ lesson -> class_id . PHP_EOL ;
}

レッスンの出席

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get lesson attendance
foreach ( $ school -> lessonAttendance -> all () as $ lessonAttendance ) {
    echo $ lessonAttendance -> comment . PHP_EOL ;
}

レッスンの出席後

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

// Initiate a new register
$ register = new  Wonde  Writeback  LessonRegister ();

// Initiate a new attendance record
$ attendance = new  Wonde  Writeback  LessonAttendanceRecord ();

// Set fields
$ attendance -> setStudentId ( ' STUDENT_ID_GOES_HERE ' );
$ attendance -> setLessonId ( ' LESSON_ID_GOES_HERE ' );
$ attendance -> setAttendanceCodeId ( ' ATTENDANCE_CODE_ID_GOES_HERE ' );

// Add attendance mark to register
$ register -> add ( $ attendance );

// Save the lesson register
$ result = $ school -> lessonAttendance ()-> lessonRegister ( $ register );

// Writeback id is part of the response
echo $ result -> writeback_id ;

病状

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get medical conditions
foreach ( $ school -> medicalConditions -> all () as $ medicalCondition ) {
    echo $ medicalCondition -> description . PHP_EOL ;
}

医療イベント

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get medical events
foreach ( $ school -> medicalEvents -> all () as $ medicalEvent ) {
    echo $ medicalEvent -> description . PHP_EOL ;
}

医師

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get doctors
foreach ( $ school -> doctors -> all () as $ doctor ) {
    echo $ doctor -> surname . PHP_EOL ;
    echo $ doctor -> practice_name . PHP_EOL ;
    echo $ doctor -> telephone . PHP_EOL ;
}

期間

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get periods
foreach ( $ school -> periods -> all () as $ period ) {
    echo $ period -> name . PHP_EOL ;
}

写真

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get photos
foreach ( $ school -> photos -> all () as $ photo ) {
    echo $ photo -> hash . PHP_EOL ;
}

部屋

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get rooms
foreach ( $ school -> rooms -> all () as $ room ) {
    echo $ room -> name . PHP_EOL ;
}

被験者

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ school = $ client -> school ( ' SCHOOL_ID_GOES_HERE ' );

// Get subjects
foreach ( $ school -> subjects -> all () as $ subject ) {
    echo $ subject -> name . PHP_EOL ;
}

メタ

 $ client = new  Wonde  Client ( ' TOKEN_GOES_HERE ' );

$ metaObject = $ client -> meta -> get ( ' SCHOOL_ID_GOES_HERE ' );

拡大する