SCC Core Developer's Document
Back to top  

ExecuteWithRelationTrait

[ 紐づけマスタを操作するトレイト（共通） ]

紐づけマスタコントローラ側でuseする

package

Default

Methods

モデル削除時に紐づけマスタも削除する(子データ存在時は全ての処理を中断し、ステータスコード「200」で、影響レコード0件で返す)

deleteWithRelation(\SCC\Api\Controller\Behaviors\unknown $params, string $mode = "", string $target_cd = "") : string
throws

Arguments

$params

\SCC\Api\Controller\Behaviors\unknown

$mode

string

$target_cd

string

Response

string

指定された親（コード）を持つ子データ（階層差1のみ）のうち指定した分類に属するデータを取得

getChildByClassCd( $params, string $mode = "", string $parent_cd = "", string $class_cd = "") : array
throws

Arguments

$params

APIパラメータ

$mode

string

更新モード

$parent_cd

string

親コード

$class_cd

string

分類コード

Response

array

API結果情報

子コードのフィールド名を取得する

getChildCodeFieldName() : string
abstract

Response

string

子コードのフィールド名

指定された親コードの子（階層差1のみ）のうち指定した分類に属するデータを取得

getChildListByClassCd( $params, string $mode = "", string $parent_cd = "", string $class_cd = "") : array
abstract
throws

Arguments

$params

APIパラメータ

$mode

string

更新モード

$parent_cd

string

親コード

$class_cd

string

分類コード

Response

array

マスタ情報

分類コードのフィールド名を取得する

getClassCodeFieldName() : string
abstract

Response

string

分類コードのフィールド名

分類マスタのモデルのインスタンスを取得する

getClassModel() : \SCC\Api\Model\Extend\CommonModel
abstract

Response

\SCC\Api\Model\Extend\CommonModel

を継承しているモデル

階層差のフィールド名を取得する

getLevelFieldName() : string
abstract

Response

string

階層差のフィールド名

メインのモデルのインスタンスを取得する

getMainModel() : \SCC\Api\Model\Extend\CommonModel
abstract

Response

\SCC\Api\Model\Extend\CommonModel

を継承しているモデル

メインModelのユニークコードのフィールド名を取得する

getMainModelCodeFieldName() : string
abstract

Response

string

メインModelのユニークコードのフィールド名

親コードのフィールド名を取得する

getParentCodeFieldName() : string
abstract

Response

string

親コードのフィールド名

紐づけテーブルのモデルのインスタンスを取得する

getRelationControlModel() : \SCC\Api\Model\Extend\CommonModel
abstract

Response

\SCC\Api\Model\Extend\CommonModel

を継承しているモデル

モデル登録時に紐づけマスタも登録する

registWithRelation(array $params, string $mode = "", string $parent_cd = "") : array
abstract
throws

Arguments

$params

array

登録情報

$mode

string

更新モード（未使用）

$parent_cd

string

親コード（未指定時は自身がTOPの階層となる）

Response

array

API結果情報

指定された親（コード）を持つ子データ（階層差1のみ）のうち指定した分類に属するデータのソート順を更新

updateChildByClassExecute( $params, string $mode = "", string $parent_cd = "", string $class_cd = "") : array
throws

Arguments

$params

APIパラメータ

$mode

string

更新モード

$parent_cd

string

親コード

$class_cd

string

分類コード

Response

array

更新されたレコードのIDのリスト