Merge branch 'master' of https://github.com/VectorNetworkProject/UserdataProvider

Author: InkoHX

.poggit.yml

@@ -1,7 +1,11 @@
 --- # Poggit-CI Manifest. Open the CI at https://poggit.pmmp.io/ci/VectorNetworkProject/UserdataProvider
 branches:
 - master
+- develop
 projects:
   UserdataProvider:
     path: ""
+    libs:
+    - src: poggit/libasynql/libasynql
+      version: ^3.0
 ...

.scrutinizer.yml

@@ -18,10 +18,6 @@ changetracking:
   bug_patterns: ["\bfix(?:es|ed)?\b"]
   feature_patterns: ["\badd(?:s|ed)?\b", "\bimplement(?:s|ed)?\b"]
 
-checks:
-  php:
-    sql_injection_vulnerabilities: true
-
 coding_style:
   php:
     indentation:
@@ -125,4 +121,4 @@ coding_style:
       keywords:
         general: lower
       constants:
-        true_false_null: lower
+        true_false_null: lower

README.md

@@ -1,10 +1,50 @@
 # DataProvider
 [![Build Status](https://scrutinizer-ci.com/g/VectorNetworkProject/DataProvider/badges/build.png?b=master)](https://scrutinizer-ci.com/g/VectorNetworkProject/DataProvider/build-status/master)
+[![](https://poggit.pmmp.io/ci.shield/Pluginproject/VectorNetworkProject/UserdataProvider)](https://poggit.pmmp.io/ci/VectorNetworkProject/UserdataProvider)
+　データを格納するためのプラグイン。テーブルの粒度は小さめに！
+## テーブル
 
-データを格納するためのプラグイン
+### accounts
 
-##使い方
+| Column | Type  | Description |  
+| :----: | :---: | :---------: |
+| id | int | 登録したときに自動的に付与されます |
+|name |string |プレイヤーの名前です。 |
 
+　UserdataProviderで基本となる情報を扱うテーブルです。ここに記載されたIDをもとに各テーブルの管理を行います。  
+　sqlite.sql上ではidをメインにやり取りしていますが、デベロッパーが扱う際はラップしたクラス群の関数を使ってください。
+
+### ffapvp
+
+| Column | Type  | Description |  
+| :----: | :---: | :---------: |
+| id | int | プレイヤーと対応するaccountsテーブルのid |
+| kill | int | キル数 |
+| death | int | デス数 |
+| exp | int | EXP |
+
+### dual
+
+| Column | Type  | Description |
+| :----: | :---: | :---------: |
+| id | int | プレイヤーと対応するaccountsテーブルのid |
+| kill | int | キル数 |
+| death | int | デス数 |
+| win | int | 勝利数 |
+| lose | int| 敗北数 |
+
+### corepvp
+
+| Column | Type  | Description |
+| :----: | :---: | :---------: |
+| id | int | プレイヤーと対応するaccountsテーブルのid |
+| kill | int | キル数 |
+| death | int | デス数 |
+| win | int | 勝利数 |
+| lose | int| 敗北数 |
+| exp | int | exp |
+
+## 使い方
 ```PHP
 public function onEnable()
 {
@@ -15,10 +55,21 @@ public funciton onPlayerJoin(PlayerJoinEvent $event)
 {
     $this->accounts->get(
         $event->player,
-        function (array $rows) use($player)
+        function(array $rows) use($player): void
         {
-            $player->sendMessage("あなたのIDは$raws[0][id]です");
+            if($rows[0] !== null)
+            {
+                $player->sendMessage("あなたのIDは$raws[0][id]です");
+            }
+        },
+        function(SqlError $error, ?Exception $trace): void  //https://github.com/poggit/libasynql/blob/master/libasynql/src/poggit/libasynql/base/DataConnectorImpl.php#L196
+        {
+            var_dump($error, $trace);
         }
     );
 }
-``````
+```
+
+　クエリの終了時、またはエラー時の際の処理をクロージャで渡してください。   
+　終了時の引数は`array $rows`で結果が`$rows[<順番>][<カラム名>]`で格納されます。エラー時の引数は上記の通り`SqlError $error, ?Ecxeption $trace`となります。`SqlError`については[SqlError](https://github.com/poggit/libasynql/blob/master/libasynql/src/poggit/libasynql/SqlError.php)を参照してください。  
+　`$raws[<int>]`に格納されているデータは基本的に`accounts`の`name`カラムとそれぞれのテーブルのカラムを複合したものになります。`

plugin.yml

@@ -1,5 +1,5 @@
 name: DataProvider
-version: 0.0.1
+version: 0.3.0
 api: 3.3.0
 main: VectorNetworkProject\DataProvider\Main
 prefix: DataProvider