Menu

## TGMDK_JSONQuery
in package

TGMDK_JSONQuery.php : 11

### Table of Contents

BASE_DTO_NAME = "MdkBaseDto"
  BaseDto名
DQUOTE_CHAR = """
  ダブルクオート
DQUOTE_CHAR_ESCAPE = "\""
  ダブルクオートエスケープ文字列
EXPARAM_PREPOSIT = "exparam"
  サービス固有要素前置詞
FIELD_NAME_SEARCH_PARAM = "SearchParameter"
  サーチパラメータのフィールド名
FIELD_NAME_SEARCH_RANGE = "tgMdk\dto\SearchRange"
  サーチの範囲指定フィールド名
FIELD_NAME_SERVICE_COMMAND = "SERVICE_COMMAND"
  サービスコマンドのフィールド名
FIELD_NAME_SERVICE_TYPE = "SERVICE_TYPE"
  サービスタイプのフィールド名
N_SEP = "."
  NAME部階層区切り文字
NV_UNITE_CHAR = "="
  N、V結合文字
PARAM_UNITE_CHAR = '&'
  N=V要素結合文字
PARAM_UNITE_CHAR_ESCAPE = '\&'
  N=V要素結合文字エスケープ文字列
$conf : mixed
  TGMDK_Configファイルの読み込み
$jsonParame : mixed
  JSON文字
$maskedLogString : mixed
  ログ出力用文字列
$serviceCommand : mixed
  サービスコマンド
$serviceType : mixed
  サービスタイプ
__construct() : mixed
  コンストラクタ。 コンフィグファイルからデータを取得して当クラスを使用できる状態にする。 TGMDK_JSONQuery constructor.
createJsonParameter() : mixed
  リクエストDTOをJSON文字列に変換する
getJsonParam() : string|bool
  JSON文字列を取得する
getMaskedLogString() : string
  ログ出力用文字列を取得する
getServiceCommand() : mixed
  サービスコマンドを取得する
getServiceType() : mixed
  サービスタイプを取得する
createJsonSubObject() : array<string|int, mixed>|null
  サブオブジェクトを解析する。
shouldParseToJson() : bool
  JSONにパースすべきかどうかを判定する <p>createJsonParameter または createJsonSubObject で使用</p>

### Constants

#### BASE_DTO_NAME

TGMDK_JSONQuery.php : 25

BaseDto名

`public mixed BASE_DTO_NAME = "MdkBaseDto"`

#### DQUOTE_CHAR

TGMDK_JSONQuery.php : 19

ダブルクオート

`public mixed DQUOTE_CHAR = """`

#### DQUOTE_CHAR_ESCAPE

TGMDK_JSONQuery.php : 21

ダブルクオートエスケープ文字列

`public mixed DQUOTE_CHAR_ESCAPE = "\""`

#### EXPARAM_PREPOSIT

TGMDK_JSONQuery.php : 27

サービス固有要素前置詞

`public mixed EXPARAM_PREPOSIT = "exparam"`

#### FIELD_NAME_SEARCH_PARAM

TGMDK_JSONQuery.php : 35

サーチパラメータのフィールド名

`public mixed FIELD_NAME_SEARCH_PARAM = "SearchParameter"`

#### FIELD_NAME_SEARCH_RANGE

TGMDK_JSONQuery.php : 37

サーチの範囲指定フィールド名

`public mixed FIELD_NAME_SEARCH_RANGE = "tgMdk\dto\SearchRange"`

#### FIELD_NAME_SERVICE_COMMAND

TGMDK_JSONQuery.php : 33

サービスコマンドのフィールド名

`public mixed FIELD_NAME_SERVICE_COMMAND = "SERVICE_COMMAND"`

#### FIELD_NAME_SERVICE_TYPE

TGMDK_JSONQuery.php : 31

サービスタイプのフィールド名

`public mixed FIELD_NAME_SERVICE_TYPE = "SERVICE_TYPE"`

#### N_SEP

TGMDK_JSONQuery.php : 29

NAME部階層区切り文字

`public mixed N_SEP = "."`

#### NV_UNITE_CHAR

TGMDK_JSONQuery.php : 23

N、V結合文字

`public mixed NV_UNITE_CHAR = "="`

#### PARAM_UNITE_CHAR

TGMDK_JSONQuery.php : 15

N=V要素結合文字

`public mixed PARAM_UNITE_CHAR = '&'`

#### PARAM_UNITE_CHAR_ESCAPE

TGMDK_JSONQuery.php : 17

N=V要素結合文字エスケープ文字列

`public mixed PARAM_UNITE_CHAR_ESCAPE = '\&'`

### Properties

#### $conf

TGMDK_JSONQuery.php : 40

TGMDK_Configファイルの読み込み

`private mixed $conf`

#### $jsonParame

TGMDK_JSONQuery.php : 43

JSON文字

`private mixed $jsonParame`

#### $maskedLogString

TGMDK_JSONQuery.php : 46

ログ出力用文字列

`private mixed $maskedLogString`

#### $serviceCommand

TGMDK_JSONQuery.php : 50

サービスコマンド

`private mixed $serviceCommand`

#### $serviceType

TGMDK_JSONQuery.php : 48

サービスタイプ

`private mixed $serviceType`

### Methods

#### __construct()

TGMDK_JSONQuery.php : 92

コンストラクタ。 コンフィグファイルからデータを取得して当クラスを使用できる状態にする。 TGMDK_JSONQuery constructor.

`public __construct() : mixed`

##### Tags

throws
  TGMDK_Exception

##### Return values

mixed —

#### createJsonParameter()

TGMDK_JSONQuery.php : 105

リクエストDTOをJSON文字列に変換する

`public createJsonParameter(MdkBaseDto $requestDto, string $className) : mixed`

##### Parameters

$requestDto : MdkBaseDto

  リクエストDTO

$className : string

##### Tags

throws
  TGMDK_Exception

##### Return values

mixed —

#### getJsonParam()

TGMDK_JSONQuery.php : 56

JSON文字列を取得する

`public getJsonParam() : string|bool`

##### Return values

string|bool —

#### getMaskedLogString()

TGMDK_JSONQuery.php : 65

ログ出力用文字列を取得する

`public getMaskedLogString() : string`

##### Return values

string —

#### getServiceCommand()

TGMDK_JSONQuery.php : 81

サービスコマンドを取得する

`public getServiceCommand() : mixed`

##### Return values

mixed —

#### getServiceType()

TGMDK_JSONQuery.php : 73

サービスタイプを取得する

`public getServiceType() : mixed`

##### Return values

mixed —

#### createJsonSubObject()

TGMDK_JSONQuery.php : 157

サブオブジェクトを解析する。

`private createJsonSubObject(mixed $subObject, string $className, bool $is_mask) : array<string|int, mixed>|null`

##### Parameters

$subObject : mixed

  サブオブジェクト

$className : string

  クラス名

$is_mask : bool

##### Tags

throws
  TGMDK_Exception

##### Return values

array<string|int, mixed>|null —

サブオブジェクト

#### shouldParseToJson()

TGMDK_JSONQuery.php : 216

JSONにパースすべきかどうかを判定する <p>createJsonParameter または createJsonSubObject で使用</p>

`private shouldParseToJson(mixed $value) : bool`

##### Parameters

$value : mixed

  判定する値

##### Tags

access

  private

##### Return values

bool —

判定結果

## Search results