PHP版 Graph SDKのクラスインスタンスとリクエストビルダの詳細ガイド

サーバーに迷い込んだ人 Microsoft Graph
この記事は約2分で読めます。

PHP版 Graph SDKでは、クエリとリクエストボディを含むクラスインスタンスを生成し、リクエストビルダを介してクエリ文字列や、リクエスト本文の生成を行うことが可能です。

対象ユーザーレベル:開発初心者

クラスの依存関係図

参考リンク

RequestConfiguretionクラス

各エンドポイントに対し、対応するクラスが用意されています。
クラス名は以下のとおり命名規則が明確に決まっています。

{Resource}RequestBuilder{Method}RequestConfigration

例えばユーザー一覧を取得する際に指定するクラス名は以下になります。

UsersRequestBuilderGetRequestConfigration

対応するクラスを明示的に指定することで利用できないパラメータを指定した際にjsonParseエラーを出してくれます。
クラスの構成要素は以下となってます。

  • headers
  • options
  • queryParameters (GET)のみ

headers

用途

RequestHeader

データの型

連想配列

補足

このパラメータはBaseRequestConfigration::__constractの第一引数です。

options

用途

主にRequestBody

データの型

配列 (Microsoft\Graph\Generated\Modelsに定義されているモデルクラスのインスタンス等)

補足

このパラメータはBaseRequestConfigration::__constractの第二引数です。

queryParameters

GETメソッドでのみ宣言されているプロパティです。
{Resource}RequestBuilderGetQueryParametersクラスのインスタンスを利用できます。
{Resource}RequestBuilderGetQueryParametersクラスのインスタンスはcreateQueryParameters関数でも生成できます。

get_class_vars関数でプロパティ一覧を取得しforeachすることで利用可能なクエリパラーメータに対して確実に値をセットできます。

この記事を書いた人

岩本敏彦
タイトルとURLをコピーしました