gamejolt api

gamejolt api PHP ライブラリ

https://gamejolt.com

このライブラリは、Game Jolt の API (トロフィー、スコア、セッションなど) を完全に (バッチ処理を除く) カバーします。現時点では、このライブラリは Game Jolt の API の v1.2 用に作成され、テストされています。

インストール

$ composer require " harrk/gamejolt-api " 

使用法

GamejoltApi のインスタンスを作成し、GamejoltConfig を提供して、Game Jolt への API 呼び出しを開始します。

 $ gameId = 0 ; // Your game's ID
$ gamePrivaykey = " Your game's private key " ;

$ api = new GamejoltApi ( new GamejoltConfig (
    $ gameId ,
    $ gamePrivaykey
));

エンドポイント

以下は、各エンドポイントと対話する方法の例です。これらは単なる例であり、すべてのパラメーター オプションを使用できるわけではないことに注意してください。

その他のオプションについては、Game Jolt API ドキュメントまたはソース コードを参照してください。

データストア

Data Store API を使用して、クラウドにデータを保存/取得できます。

 // Fetch the value for my-key
$ api -> dataStore ()-> fetch ( ' my-key ' );

// Set the value for my-key to my-value
$ api -> dataStore ()-> set ( ' my-key ' , ' my-value ' );

// Update player-logins by 1
$ api -> dataStore ()-> update ( ' player-logins ' , DataStore:: OPERATION_ADD , 1 );

// Remove my-key
$ api -> dataStore ()-> remove ( ' my-key ' );

// Fetch all keys
$ api -> dataStore ()-> getKeys ();

友達

Friends API は現在、ユーザーのフレンド ID を検索するためにのみ使用できます。

 // Fetch all friend ids for the user
$ api -> friends ()-> fetch ( ' username ' , ' user-token ' );

スコア

 //Fetch scores
$ api -> scores ()-> fetch ();

//Fetch all score tables
$ api -> scores ()-> tables ();

//Add a gamejolt user's score to the table
$ api -> scores ()-> addUserScore ( ' username ' , ' user_token ' , ' 100 Jumps ' , 100 );

//Add a guest's score to the table
$ api -> scores ()-> addGuestScore ( ' Mr Guest ' , ' 50 jumps ' , 50 );

//Get score rank
$ api -> scores ()-> getRank ( 60 );

セッション

 //Open a session for the given user
$ api -> sessions ()-> open ( ' username ' , ' user_token ' );

//Let GJ know the user session is still active
$ api -> sessions ()-> ping ( ' username ' , ' user_token ' , Sessions:: STATUS_ACTIVE );

//Check if the session is still open for user
$ api -> sessions ()-> check ( ' username ' , ' user_token ' );

//Close the session for user
$ api -> sessions ()-> close ( ' username ' , ' user_token ' );

時間

 //Get GJ's server time
$ api -> time ()-> fetch ();

トロフィー

 //Get all trophies
$ api -> trophies ()-> fetch ( ' username ' , ' user_token ' );

//User has achieved a trophy with ID 1
$ api -> trophies ()-> addAchieved ( ' username ' , ' user_token ' , 1 );

//User unachieved trophy with ID 1
$ api -> trophies ()-> removeAchieved ( ' username ' , ' user_token ' , 1 );

ユーザー

 //Fetch data on user
$ api -> users ()-> fetch ( ' username ' , ' user_token ' );

//Verify if the user's credentials are correct
$ api -> users ()-> auth ( ' username ' , ' user_token ' );

例外のキャッチ

例外をキャッチする方法の例を次に示します。

 try {
    $ auth = $ api -> users ()-> auth ( ' username ' , ' user_token ' );
} catch ( TimeOutException $ e ) {
    return redirect ()-> route ( ' home ' )-> with ( ' error ' , $ e -> getMessage ());
}

テスト

テストの実行を簡素化するために 2 つのコマンドが提供されています。

単体テストの実行

$ composer test

静的コード分析を実行する

$ composer analyse

藤堂

• エンドポイントで POST メソッドを許可する
• 単体テストの範囲を拡大する

ライセンス

MITライセンス