TDataCustomApiCreator

Extends \SCC\Api\Model\Creator\Extend\ApiCreator

[ データカスタムテーブルAPI自動生成クラス ]

データカスタムテーブル(t_data_XXXX_custom)のAPIを自動生成する

package

Default

Methods

コンストラクター

__construct() 
inherited

追加カラムのモデルアノテーションを追加編集する

addModelAnnotation() : boolean
throws

Response

boolean

バリデータの設定を追加する

addValidateConfig() 
throws

ファイルのバックアップを実施する

backUpFiles( $identifier = '') 
inherited

Arguments

$identifier

識別子(バックアップファイル名の末尾に付加する)

API生成の取り消し

cancelApi() 
inherited

現在生成中のAPI関連のファイルを削除する。

APIの自動生成

createApi() 
inherited

Model、Contoller、router、validator configを生成し、 最後にbootstrapファイルを編集する。

コントローラークラスの生成

createControllerClass() : boolean
inherited

テンプレートを取得し、setterで指定された値を反映してファイルを生成する

throws

Response

boolean

Modelクラスの生成

createModelClass() : boolean
inherited

テンプレートを取得し、setterで指定された値を反映してファイルを生成する

throws

Response

boolean

Routerファイルの生成

createRouterFile() : boolean
inherited

テンプレートを取得し、setterで指定された値を反映してファイルを生成する

throws

Response

boolean

Validate Configファイルの生成

createValidateConfig() : boolean
inherited

テンプレートを取得し、ファイルをコピー(リネーム)する

throws

Response

boolean

DBの型からSwaggerの型へ変換する

dbTypeToSwaggerType(string $dbType) 
inherited

Arguments

$dbType

string

コントローラークラスの削除

deleteControllerClass() : boolean
inherited

(setterで指定された)生成中のコントローラクラスのファイルを物理削除する

throws

Response

boolean

Modelクラスの削除

deleteModelClass() : boolean
inherited

(setterで指定された)生成中のModelクラスのファイルを物理削除する

throws

Response

boolean

Routerファイルの削除

deleteRouterFile() : boolean
inherited

(setterで指定された)生成中のRouterファイルを物理削除する

throws

Response

boolean

Validate Configファイルの削除

deleteValidateConfig() : boolean
inherited

(setterで指定されたModel名から)生成中のValidate Configファイルを物理削除する

throws

Response

boolean

自動生成されるモデル名のテーブル表示名称を取得する

getAdminName() : string
inherited

Response

string

テーブル表示名称

自動生成されるSwaggerアノテーションの設定ファイル名を取得する

getAnnotationFile() : string
inherited

Response

string

アノテーション設定ファイル名

自動生成されるコレクション名称を取得する

getCollectionName() : string
inherited

Response

string

コレクション名称

自動生成されるcontrollerに追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraController() : string
inherited

Response

string

controllerに追記するコードが定義されたファイル名(拡張子なし)

自動生成されるcontrollerの「use」に追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraControllerUse() : string
inherited

Response

string

controllerの「use」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるmodelに追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraModel() : string
inherited

Response

string

modelに追記するコードが定義されたファイル名(拡張子なし)

自動生成されるmodelの「use」に追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraModelUse() : string
inherited

Response

string

modelの「use」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるrouterに追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraRouter() : string
inherited

Response

string

routerに追記するコードが定義されたファイル(拡張子なし)

自動生成されるmodelの「use `trait`」に追記するコードが定義されたファイル名(拡張子なし)を取得する

getExtraTraitUse() : string
inherited

Response

string

modelの「use trait」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるモデルに追加するfunctionを取得する

getModelFunction() : string
inherited

Response

string

モデルに追加するfunctionプログラム文字列

自動生成されるモデル名称を取得する

getModelName() : string
inherited

Response

string

モデル名称

自動生成されるモデルに実装されるTraitの名称を取得する

getModelTraitName() : string
inherited

Response

string

Traitの名称

自動生成されるコントロラーの親クラス名を取得する

getParentControllerName() : string
inherited

Response

string

コントロラーの親クラス名

自動生成されるモデルの親クラス名称を取得する

getParentModelName() : string
inherited

Response

string

親クラス名称

Router名称を取得する

getRouterName() : string
inherited

Response

string

router(Collection)名称

Model Swaggerアノテーションの生成

getSwaggerAnnotation() : string
inherited

アノテーション定義ファイル(csv)から各テーブルの項目を情報を取得して Modelアノテーション部分の文字列を生成する。

Response

string

Swagger アノテーション文字列

自動生成されるバリデーションConfigファイルのテンプレートファイル名を取得する

getValidateConfigFile() : string
inherited

Response

string

バリデーションConfigファイルのテンプレートファイル名

自動生成されるモデル名の可変部分を取得する

getVariableName() : string
inherited

Response

string

モデル名の可変部分

依存性を注入する

injection(string $insert_nm, string $admin_nm) : boolean
inherited abstract

Arguments

$insert_nm

string

DBテーブル名の動的部分

$admin_nm

string

DBテーブルの表示名称(日本語名称)

Response

boolean

文字列を区切り文字(配列)により分割する

multiexplode(array $delimiters, string $string) : array
inherited

配列による指定で、複数の区切り文字を指定可能

Arguments

$delimiters

array

区切り文字列

$string

string

入力文字列

Response

array

$string の内容を$delimitersで分割した文字列の配列

Bootstrapファイルの復元(自動生成前の状態に戻す)

restoreBootstrap() : boolean
inherited
throws

Response

boolean

自動生成されるモデル名のテーブル表示名称をセットする

setAdminName(string $admin_nm) 
inherited

Arguments

$admin_nm

string

テーブル表示名称

自動生成されるSwaggerアノテーションの設定ファイル名をセットする

setAnnotationFile(string $name) 
inherited

Arguments

$name

string

アノテーション設定ファイル名

自動生成されるコレクション名称をセットする

setCollectionName(string $name) 
inherited

Arguments

$name

string

コレクション名称

自動生成されるcontrollerに追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraController(string $extraController) 
inherited

Arguments

$extraController

string

controllerに追記するコードが定義されたファイル名(拡張子なし)

自動生成されるcontrollerの「use」に追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraControllerUse(string $extraControllerUse) 
inherited

Arguments

$extraControllerUse

string

controllerの「use」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるmodelに追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraModel(string $extraModel) 
inherited

Arguments

$extraModel

string

modelに追記するコードが定義されたファイル名(拡張子なし)

自動生成されるmodelの「use」に追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraModelUse(string $extraModelUse) 
inherited

Arguments

$extraModelUse

string

modelの「use」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるrouterに追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraRouter(string $extraRouter) 
inherited

Arguments

$extraRouter

string

routerに追記するコードが定義されたファイル(拡張子なし)

自動生成されるmodelの「use `trait`」に追記するコードが定義されたファイル名(拡張子なし)をセットする

setExtraTraitUse(string $extraTraitUse) 
inherited

Arguments

$extraTraitUse

string

modelの「use trait」に追記するコードが定義されたファイル名(拡張子なし)

自動生成されるモデルに追加するfunctionをセットする

setModelFunction(string $model_function) 
inherited

Arguments

$model_function

string

モデルに追加するfunctionプログラム文字列

自動生成されるモデルの名称をセットする

setModelName(string $name) 
inherited

Arguments

$name

string

モデル名称

自動生成されるモデルに実装されるTraitの名称をセットする

setModelTraitName(string $model_trait_nm) 
inherited

Arguments

$model_trait_nm

string

Traitの名称

自動生成されるコントロラーの親クラス名をセットする

setParentControllerName(string $parent_controller_nm) 
inherited

Arguments

$parent_controller_nm

string

コントロラーの親クラス名

自動生成されるモデルの親クラス名称をセットする

setParentModelName(string $parent_model_nm) 
inherited

Arguments

$parent_model_nm

string

親クラス名称

自動生成されるバリデーションConfigファイルのテンプレートファイル名をセットする

setValidateConfigFile(string $name) 
inherited

Arguments

$name

string

バリデーションConfigファイルのテンプレートファイル名

自動生成されるモデル名の可変部分をセットする

setVariableName(string $insert_nm) 
inherited

Arguments

$insert_nm

string

DBテーブル名の動的部分

Bootstrapファイルの更新

updateBootstrap() : boolean
inherited

自動生成されたrouterの登録及び、アノテーションの追記を実施。

SwaggerアノテーションのみBootstrapを直接編集。 Bootstrapでincludeされる「addapi.php」に追記していく。

throws

Response

boolean

Constants

PARENT_MODEL_AGENT

PARENT_MODEL_AGENT
inherited

PARENT_MODEL_CORE

PARENT_MODEL_CORE
inherited

PARENT_MODEL_CORE_STATUS

PARENT_MODEL_CORE_STATUS
inherited

PARENT_CONTROLLER_AGENT

PARENT_CONTROLLER_AGENT
inherited

PARENT_CONTROLLER_MASTER

PARENT_CONTROLLER_MASTER
inherited

PARENT_CONTROLLER_MASTER_NOSORT

PARENT_CONTROLLER_MASTER_NOSORT
inherited

MODEL_TRAIT_TERM

MODEL_TRAIT_TERM
inherited

MODEL_TRAIT_APP

MODEL_TRAIT_APP
inherited

MODEL_TRAIT_SIMPLE

MODEL_TRAIT_SIMPLE
inherited

Properties

カラム追加設定情報

addColumnSettings : 

Type(s)

ロガー

logger : 
inherited

Type(s)

モデル名称

modelName : 
inherited

Type(s)

コレクション名称

collectionName : 
inherited

Type(s)

アノテーション テンプレートファイル名

annotationFile : 
inherited

Type(s)

Validator テンプレートファイル名

validateConfigFile : 
inherited

Type(s)

テーブル名の可変部分

variableName : 
inherited

Type(s)

テーブル表示名称

adminName : 
inherited

Type(s)

Model親クラス名

parentModelName : 
inherited

Type(s)

ModelTrait名

modelTraitName : 
inherited

Type(s)

Model内function

modelFunction : 
inherited

Type(s)

Controller親クラス

parentControllerName : 
inherited

Type(s)

extra File Router

extraRouter : 
inherited

Type(s)

extra File Controller Use Section

extraControllerUse : 
inherited

Type(s)

extra File Controller

extraController : 
inherited

Type(s)

extra File Model

extraModel : 
inherited

Type(s)

extra File Model Use Section

extraModelUse : 
inherited

Type(s)

extra File Trait Use Section

extraTraitUse : 
inherited

Type(s)