定義一覧

概要

YAMLで使用可能な定義の早見表です。

タグ1	タグ2	タグ3	タグ4	必須	説明
input_path				△	表入力のパス一覧を指定。ローカルExcelとGoogle Sheets URLを指定可能。base_typeがMultiYamlAction以外の場合に必須
	path			〇	ローカルExcelパスまたはGoogle Sheets URLを指定
development_input_path				×	developmentがTrueの時に追加で読み込む表入力のパス一覧を指定。input_pathと同じ形式
	path			〇	ローカルExcelパスまたはGoogle Sheets URLを指定
sheet				〇	表入力のシートを指定
row				×	表入力のデータ解析開始行を指定
base_type				×	以下のいずれかを指定定義がない場合はNormalとなる Normal：通常のデータ形式 NoOutput：データ出力を行わない MultiYamlAction：複数のYAMLに跨る処理 ManualOnly：マニュアルのみ出力
source_type				×	以下のいずれかを指定定義がない場合はNormalとなる Normal：通常のデータ形式　container_typeで出力方式が異なる Enum：列挙型出力形式 Const：定数出力形式 ConstSource：定数ソース出力形式
container_type				×	以下のいずれかを指定定義がない場合はListとなる List：配列形式の出力 Dictionary：<key, value>形式の出力　fieldsの最初のkeyがKeyとなる DictionaryList：<key, value[]>形式の出力　fieldsの最初のkeyがKeyとなる WienerDictionary：WienerDictionary形式の出力　fieldsの最初のkeyがKeyとなる WienerDictionaryList：WienerDictionaryList形式の出力　fieldsの最初のkeyがKeyとなる
output_path				△	出力フォルダを指定。base_typeがNormalの場合に必須
name				△	ファイル名やクラス名になる名前を指定。base_typeがNormalの場合に必須
group				×	同一形式のデータが複数存在し、使用時には1つ分だけ読み込む場合にグループ名を指定
sort				×	最初のkeyでソートして出力する
encryption				×	全ての難読化対応fieldsの難読化の有無これがTrueになるとfields.encryptionの設定に関わらず難読化対応項目を難読化する
template				×	テンプレートファイルを指定して出力方法を変更する PHPのみ有効
manual_comment				×	マニュアル出力時のYAMLのコメントを指定
validate				×	データ検証の親
	composite_unique			×	複数のkeyでの重複チェック
		keys		〇
			key	〇
localization				×	そのYAMLのローカライズ設定
	id_key			〇	各行を一意に識別するfieldsのkeyを指定
multi_yaml_action				△	base_typeがMultiYamlActionの時に必須定義
	type			〇	以下のいずれかを指定 ValidateKeyExistsYaml：fields.validate.key_exists_yamlで指定するYAMLに対して指定 ValidateKeyExistsYamlConditions：fields.validate.key_exists_yaml_conditionsで指定するYAMLに対して指定 ValidateUnique：複数のYAMLのkeyで重複チェック EnumConstJoin：EnumやConstを結合して1つのファイルに出力する(PHPのみ対応)
	ignores			×	無視リスト
		value		〇	無視する値

fields

タグ1	タグ2	タグ3	タグ4	必須	説明
key				〇	key項目を指定自動出力の変数名などに使われる relationで指定する先もこの項目となる
name				〇	Excelの列名を指定
type				〇	以下のいずれかを指定 Bool：真偽型　1、true、yes：真　0、false、no：偽 Byte：8bit符号なし整数型 Short：16bit符号あり整数型 UShort：16bit符号なし整数型 Int：32bit符号あり整数型 UInt：32bit符号なし整数型 Long：64bit符号あり整数型 ULong：64bit符号なし整数型 Float：32bit浮動小数型 Double：64bit浮動小数型 String：文字列型 Enum：列挙型　enumタグ必須 DateTime：時間型 Foreignkey：関連参照型　 relationタグ必須
enum				△	Enum名を指定 typeをEnumとした場合に必須 header.source_typeがEnumのYAMLのheader.nameを指定
enum_value				×	列挙に設定する値のkeyを指定指定がない場合は0からの値となる
enum_comment				×	列挙に設定するコメントのkeyを指定
default				×	セルが空の時に設定するデフォルト値
string_format				×	PHP出力と、C#/UE5のConstSource出力で有効値型の出力に手を加えたい場合にC#の数値書式で指定例えばFloat型で小数第二位まで表示する場合は「F2」と入力する
comment				×	キーに対するコメントを文字列で記載 C#/UE5/PHPで有効
manual_comment				×	キーの説明を記載マニュアル出力に使用
encryption				×	メモリ改ざん対策の難読化 Trueで有効 typeがByte, Short, UShort, Int, UInt, Long, ULong, Float, Double, Stringに対応
localize				×	ローカライズ文字列とする場合、Trueを指定
manual_only				×	データ出力は行わないがマニュアルのみ使用する場合、Trueを指定
obsolete				×	生成されるC# / UE5のアクセサを非推奨扱いにする
relation				×	データ関連参照、Excelで言うところのVLOOKUPに該当する機能 typeをForeignkeyにした場合必須
	yaml			〇	関連参照先のYAMLを指定
	from			〇	YAMLで指定した先の検索対象のkeyを指定
	to			〇	データ変換先のkeyを指定
validate				×	検証機能
	unique			×	重複チェック
		enable		〇	trueで有効
		ignores		×	無視リスト
			value	〇	無視する値を指定
	key_exist			×	単一のYAMLとのデータ存在チェック指定したYAMLに定義されている項目のいずれとも一致しない場合エラー
		yaml		〇	対象のYAMLを指定
		key		〇	対象のkeyを指定
		ignores		×	無視するデータの配列の親
			value	〇	無視するデータを指定
	key_exists_yaml			×	複数のYAMLとのデータ存在チェック指定したYAMLに定義されている項目のいずれとも一致しない場合エラー指定先のYAMLはheader.base_typeがMultiYamlActionでheader.multi_yaml_actionをValidateKeyExistsYamlとする
		yaml		〇	MultiYamlActionのYAMLを指定
	key_exists_yaml_conditions			×	パラメータ指定付きの複数のYAMLとのデータ存在チェック指定したパラメータに該当するYAMLに定義されている項目と一致しない場合エラー指定先のYAMLはheader.base_typeがMultiYamlActionでheader.multi_yaml_actionをValidateKeyExistsYamlConditionsとする詳しくはkey_exists_yaml_conditionsの詳細を参照
		yaml		〇	MultiYamlActionのYAMLを指定
		conditions_param_key		〇	パラメータのkeyを指定
	enum_exists			×	指定したEnumの全項目がデータに定義されていない場合にエラー
		yaml		〇	参照先のYAMLを指定
		key		〇	YAML内のkeyを指定
		unique		×	unique: trueとした場合、keyが重複した場合にエラーデフォルトはtrue
	range			×	値が範囲外であればエラー
		min		×	最小値を指定
		max		×	最大値を指定
		extra_conditions		×	追加条件の親
			key	〇	条件判定に使うkeyを指定
			value	〇	比較する値を指定
			equals	〇	trueで一致時、falseで不一致時に条件を適用
	string_length			×	文字列が指定値をオーバーした場合にエラー
		line_length		〇	1行の最大文字数を指定
		line_value		〇	最大行数を指定

multi_yaml_action

タグ1	必須	説明
yaml	〇	対象のYAMLを指定
key	△	チェック対象のkeyを指定。header.multi_yaml_action.typeがValidateKeyExistsYaml、ValidateKeyExistsYamlConditions、ValidateUniqueの場合に必須
conditions_param	△	条件パラメータを指定。header.multi_yaml_action.typeがValidateKeyExistsYamlConditionsの場合に必須

定義一覧

概要

header

fields

multi_yaml_action