[ ユーザメッセージコントローラ ]
ユーザメッセージAPIのコントローラ
| package |
Default |
|---|
apiAuthorization() : boolean
APIの利用可否を判定する
boolean
canOperate() : boolean
boolean
chkAllowedIp(integer $user_flg = USER_FLG_APIUSER) : boolean
サーバのIPとアクセスクライアントのIPを比較する
integerユーザフラグ
booleantrue:認証OK false:認証NG
chkApiUserAuth( $operation_flg) : \SCC\Api\Controller\Extend\booean
| throws |
|---|
チェックするフラグの状態
\SCC\Api\Controller\Extend\booean
chkUserControlMode(integer $modeFlg) : boolean
integer設定の確認をするモード（権限）
boolean
copyOperationChkParams(\SCC\Api\Controller\Extend\SccCommonController $obj)
deleteModel( $id = "") : mixed
URLより取得。指定ない場合はPOSTパラメータの条件にて合致するデータを削除
mixed更新されたレコードのID
deleteUserControlMode(integer $modeFlg)
integer除外するモード（権限）
doSortUpdate() : mixed
mixed更新レコード数
doSortUpdateExecute(array $params, string $mode = "", string $id = "") : array
指定された「sortlist」のindex順にモデルのsort_orderを更新する。 「sortlist」に指定されなかったデータは「sortlist」の件数+1の値でsort_orderを更新する。
array入力データ
string未使用
string未使用
arrayAPI結果
doValidate() : mixed
mixed入力チェック結果（エラーがある場合は、その項目名とメッセージ）
doValidateExecute(array $params, string $mode = "", string $id = "") : array
コントローラに紐づけられたモデルのバリデートを実行する
array入力データ
string未使用
string未使用
arrayAPI結果
existOrganization() : boolean
| throws | |
|---|---|
boolean
getApiUserAuthority() : string
stringAPI操作権限
getApiUserFlg() : string
stringAPI利用者のユーザフラグ
getApiUserId() : string
stringAPI利用者のID
getApiUserOperationMaster() : string
stringAPIマスター系モデル操作権限
getApiUserOperationOther() : string
stringAPIその他モデル操作権限
getApiUserOperationTransaction() : string
stringAPIトランザクション系モデル操作権限
getByRawSQLExecute(array $params, string $mode = "", string $id = "") : array
生SQLを実行できる。Selectのみの許可でその他は実施できない。
| throws |
|---|
array検索情報（SQL文、バインド変数）
string未使用
string未使用
arrayAPI結果
getExecute(array $conditions, string $prevMode) : array
指定さてた条件は全て「AND」で処理され、比較演算子も「=」のみで検索を行う。
| throws |
|---|
array検索条件の連想配列
stringブレビューモード（onの場合はプレビューモード）
arrayAPI結果
getMode() : string
更新: API_MODE_UPDATE(api-update), 論理削除： API_MODE_DELETE(api-delete), 物理削除： API_MODE_PURGE(api-purge)
stringAPIのモード
getModel( $id = "") : mixed
URLより取得されるID(指定が無い場合はリストが返却される)
mixed指定されたフォーマットのModel情報
getModelByRawSQL() : mixed
生SQLを実行しModelを取得する。
mixed指定されたフォーマットのModel情報
getModelName() : string
stringモデル名称
getPreviewMode() : string
| throws | |
|---|---|
stringプレビューモード（通常:"on", 時間指定プレビュー：Y-m-d H:i:s）
getUserControlMode() : integer
integerAPI利用時の操作モード
invokeGet(string $method, string $id = "", string $arg1 = "", string $arg2 = "", string $arg3 = "", $arg4 = "") : \Phalcon\Http\Response
共通処理を実施後、指定されたメソッド($method)をコールする
string実行するメソッド名
stringレコードID
stringAPIクエリパラメータ1
stringAPIクエリパラメータ2
stringAPIクエリパラメータ3
\Phalcon\Http\Response
invokeGetPost(string $method, string $orginMethod = "", string $arg1 = "", string $arg2 = "") : \Phalcon\Http\Response
共通処理を実施後、指定されたメソッド($method)をコールする
string実行するメソッド名
stringAPIメソッド(get, post, put, delete, getpost)
stringURLパラメータ
stringURLパラメータ
\Phalcon\Http\Response
invokePost(string $method, string $arg1 = "", $arg2 = "") : \Phalcon\Http\Response
共通処理を実施後、指定されたメソッド($method)をコールする
string実行するメソッド名
stringURLパラメータ
\Phalcon\Http\Response
invokePostCommon(string $method, string $mode = "", string $orginMethod = "", string $arg1 = "", string $arg2 = "") : \Phalcon\Http\Response
共通処理を実施後、指定されたメソッド($method)をコールする
string実行するメソッド名
string処理モード
stringAPIメソッド(get, post, put, delete, getpost)
stringURLパラメータ
stringURLパラメータ
\Phalcon\Http\Response
invokePut(string $method, string $mode = "", string $arg1 = "", string $arg2 = "") : \Phalcon\Http\Response
共通処理を実施後、指定されたメソッド($method)をコールする
string実行するメソッド名
string更新モード(api-update, api-delete, api-purge)
stringURLパラメータ
stringURLパラメータ
\Phalcon\Http\Response
isHash(array &$array) : boolean
array確認対象の配列
booleantrue:連想配列
isNoAuthMode() : boolean
booleantrue:不要、false:必要
isOnlyOwnerMode() : boolean
boolean
onConstruct()
output(array $param, boolean $batchGet = false) : \Phalcon\Http\Response
ヘッダで指定された形式でアウトプットする
array出力するデータ
booleanバッチリクエストの場合はtrue
\Phalcon\Http\Response指定されたフォーマットに変換されたAPI結果情報
purgeModel(string $id = "") : mixed
string
mixed更新されたレコードのID
registExecute(array $params, string $mode = "", string $id = "") : array
| throws |
|---|
array登録情報
string未使用
string未使用
arrayAPI結果
registModel() : mixed
指定されたフォーマットでデータを受け取りModelを登録し、別で指定されたフォーマットで結果を返す。
mixed更新されたレコードのID
searchExecute(array $params, string $mode = "", string $id = "") : array
| throws |
|---|
arraySQL組み立て情報の連想配列
string未使用
string未使用
arrayAPI結果
searchModel() : mixed
mixed指定されたフォーマットのModel情報
setAdminChk(string $chk = true)
stringtrueでチェック実行
setApiUserAuthority(string $api_authority)
stringAPI操作権限
setApiUserFlg(string $user_flg)
stringAPI利用者のユーザフラグ
setApiUserId(string $user_id)
stringAPI利用者のID
setApiUserOperationMaster(string $master_operation_flg)
stringAPIマスター系モデル操作権限
setApiUserOperationOther(string $other_operation_flg)
stringAPIその他モデル操作権限
setApiUserOperationTransaction(string $tran_operation_flg)
stringAPIトランザクション系モデル操作権限
setConfig() : boolean
boolean
setMode(string $setMode)
更新: API_MODE_UPDATE(api-update), 論理削除： API_MODE_DELETE(api-delete), 物理削除： API_MODE_PURGE(api-purge)
stringAPIのモード
setNoAuthMode(boolean $isNoAuth = false)
boolean非認証モードを実施するかどうか
setOnlyOwnerMode(boolean $mode)
boolean
setUserControlMode(integer $modeFlg, string $overwrite = false)
integer設定するモード（権限）
string上書きフラグ（false: モードの追加 true: モードの初期化）
updateExecute(array $params, string $mode = API_MODE_UPDATE, string $id = "") : array
$params['conditions']で更新対象を絞り込むための条件設定が可能。
| throws |
|---|
array更新情報（データ、対象レコード検索条件）
string更新モード
string更新対象レコードのID
arrayAPI結果
updateModel( $id = "", $mode = API_MODE_UPDATE) : mixed
URLより取得。指定ない場合はPOSTパラメータの条件にて合致するデータを更新
更新モード(API_MODE_UPDATE(api-update): 更新, API_MODE_DELETE(api-delete): 論理削除, API_MODE_PURGE(api-purge): 物理削除)
mixed更新されたレコードのID
API_MODEL_MCOREAPPLICATIONACCESS
API_MODEL_MCOREAPPLICATIONACCESSFORMFIELD
API_MODEL_MCOREAPPLICATIONACCESSFORMFIELDDETAIL
API_MODEL_MCOREAPPLICATIONACCESSRECORD
API_MODEL_MCOREAPPLICATIONACCESSRECORDDETAIL
API_MODEL_MCOREAPPLICATIONCLASS
API_MODEL_MCOREAPPLICATION
API_MODEL_MCOREAPPLICATIONFORMFIELD
API_MODEL_MCOREAPPLICATIONFORMGROUP
API_MODEL_MCOREAPPLICATIONFORMSET
API_MODEL_MCOREAPPLICATIONRELATION
API_MODEL_MCOREAPPLICATIONWORKFLOWACTION
API_MODEL_MCOREAPPLICATIONWORKFLOWSTATUS
API_MODEL_MCOREASSETTYPE
API_MODEL_MCOREDB
API_MODEL_MCOREDBCUSTOM
API_MODEL_MCOREDOMAIN
API_MODEL_MCOREMASTERTYPE
API_MODEL_MCOREORGANIZATIONCLASS
API_MODEL_MCOREORGANIZATION
API_MODEL_MCOREORGANIZATIONRELATION
API_MODEL_MCOREPRODUCT
API_MODEL_MCOREROLE
API_MODEL_MORGASSET
API_MODEL_MORGCATEGORY
API_MODEL_MORGCATEGORYGROUP
API_MODEL_MORGCOLUMNTYPE
API_MODEL_MORGCOLUMNVALUE
API_MODEL_MORGSTOREFLOOR
API_MODEL_MORGSTORETYPE
API_MODEL_TDATA
API_MODEL_TBUSINESSREPORT
API_MODEL_TBUSINESSREPORTRULE
API_MODEL_TBUSINESSREPORTTARGET
API_MODEL_TCOREOPERATIONLOG
API_MODEL_TCOREUSER
API_MODEL_TCOREUSERINFORMATION
API_MODEL_TCOREUSERLOGINHISTORY
API_MODEL_TCOREUSERMESSAGE
API_MODEL_TCOREUSERNOTICE
API_MODEL_TCOREUSERORGRELATION
API_MODEL_TENQUETE
API_MODEL_TENQUETERESULT
API_MODEL_TENQUETETARGET
API_MODEL_TINFORMATION
API_MODEL_TMESSAGEBOARDCOMMENT
API_MODEL_TMESSAGEBOARD
API_MODEL_TMESSAGEBOARDREACTION
API_MODEL_TMESSAGEBOARDTARGET
API_MODEL_TSCHEDULE
API_MODEL_TSCHEDULETARGET
API_MODEL_TSALESBUDGETMONTHLY
API_MODEL_TSALESREPORTDAILY
API_MODEL_TINFORMATION2
API_MODEL_TINFORMATION2TARGET
API_MODEL_TCOREUSERINFORMATION2
API_MODEL_BATCH
API_MODEL_CMAGENT
API_MODEL_CMAGENTDOMAIN
API_MODEL_CTAGENTUSER
API_MODEL_PETITION
API_OPERATION_FLG_NOAUTH
API_OPERATION_FLG_SELECT
API_OPERATION_FLG_INSERT
API_OPERATION_FLG_UPDATE
API_OPERATION_FLG_DELETE
REGIST_METHOD_NM
UPDATE_METHOD_NM
DELETE_WITHRELATION_METHOD_NM
PURGE_WITHRELATION_METHOD_NM
adminChk :
modelName :
logger :
api_user_id :
api_user_flg :
user_control_mode :
mode :
onlyOwnerMode :
noAuthMode :
api_user_info :