RestControllerBase クラス

RestControllerBase の継承関係図

公開メンバ関数
	getDBO ($argDSN=NULL)
	getModel ($argModel, $argIdentifierORQuery=NULL, $argBinds=NULL, $argDSN=NULL)
	convertArrayFromModel ($ArgModel, $argFields=NULL)
	getRequestParams ()
	UIDAuthAndExecute ()
	authAndExecute ()
	execute ($argResourceHint=NULL, $argRequestParams=NULL)
	get ()
	post ($argRequestParams=NULL)
	put ($argRequestParams=NULL)
	delete ()
	head ()
基底クラス MVCControllerBase に属する継承公開メンバ関数
	execute ()
基底クラス RestControllerIO に属する継承公開メンバ関数
	post ()
	put ()

静的公開メンバ関数
static	resolveRequestParams ()
static	resolveRESTResource ($argRESTResourceHint)

公開変数類
	$requestMethod = 'GET'
	$restResource = ''
	$restResourceModel = ''
	$restResourceListed = NULL
	$restResourceCreateDateKeyName = ''
	$restResourceModifyDateKeyName = ''
	$restResourceAvailableKeyName = ''
	$restResourceUserTableName = NULL
	$restResourceRelaySuffix = ''
	$restResourceRelayPrefix = ''
	$AuthDevice = NULL
	$AuthUser = NULL
	$authUserID = NULL
	$authUserIDFieldName = NULL
	$authUserQuery = NULL
	$deepRESTMode = TRUE
	$rootREST = TRUE
	$virtualREST = FALSE
	$responceData = FALSE
基底クラス APIControllerBase に属する継承公開変数類
	$httpStatus = 200
	$outputType = "json"
	$validateError = ""
	$jsonUnescapedUnicode = true
基底クラス WebControllerBase に属する継承公開変数類
	$httpStatus = 200
	$outputType = "html"
基底クラス MVCControllerBase に属する継承公開変数類
	$controlerClassName = ""
	$httpStatus = 200
	$outputType = "html"
	$requestMethod = "GET"
	$restResource = ''
	$jsonUnescapedUnicode = TRUE
	$deviceType = "PC"
	$appVersion = "1.0.0"
	$appleReviewd = FALSE
	$mustAppVersioned = FALSE
	$allowed = NULL

静的公開変数類
static	$nowGMT = NULL

限定公開メンバ関数
	_init ()
	_getModel ($argModel, $argIdentifierORQuery=NULL, $argBinds=NULL, $argDSN=NULL)
	_convertArrayFromModel ($ArgModel, $argFields=NULL)

静的限定公開メンバ関数
static	_getDBO ($argDSN=NULL)
基底クラス APIControllerBase に属する継承静的限定公開メンバ関数
static	_clearCacheImage ($argFilePath, $argMemcacheDSN=NULL)
基底クラス WebControllerBase に属する継承静的限定公開メンバ関数
static	_clearCacheImage ($argFilePath, $argMemcacheDSN=NULL)

限定公開変数類
	$_initialized = FALSE

関数詳解

RestControllerBase::authAndExecute

(

)

フレームワーク標準のAuth機能を利用した認証を行って、RESTする

戻り値

array 配列構造のリソースデータ

RestControllerBase::delete

(

)

DELETEメソッド XXX モデルの位置付けが、テーブルリソースで無い場合は、継承してRESTの”冪等性”に従って実装して下さい(冪等性を持ちます)

戻り値

boolean

RestControllerIOを実装しています。

RestControllerBase::execute	(		$argResourceHint = NULL,
			$argRequestParams = NULL
	)

RESTする

戻り値

array 配列構造のリソースデータ

RestControllerBase::get

(

)

GETメソッド リソースの参照(冪等性を持ちます) XXX モデルの位置付けが、テーブルリソースで無い場合は、継承して、RESTの”冪等性”に従って実装して下さい

戻り値

mixed 成功時は最新のリソース配列 失敗時はFALSE

RestControllerIOを実装しています。

RestControllerBase::head

(

)

HEADメソッド

戻り値

boolean

RestControllerBase::post

(

$argRequestParams = NULL

)

POSTメソッド リソースの新規作成、更新、インクリメント、デクリメント(冪等性を強制しません) XXX モデルの位置付けが、テーブルリソースで無い場合は、継承して、RESTの”冪等性”に従って実装して下さい

戻り値

mixed 成功時は最新のリソース配列 失敗時はFALSE

RestControllerBase::put

(

$argRequestParams = NULL

)

PUTメソッド リソースの新規作成、更新(冪等性を持ちます) XXX モデルの位置付けが、テーブルリソースで無い場合は、継承して、RESTの”冪等性”に従って実装して下さい

戻り値

mixed 成功時は最新のリソース配列 失敗時はFALSE

static RestControllerBase::resolveRESTResource (   $argRESTResourceHint )

static

RESTAPIでリソースにアクセスする際の指定リソース情報を分解してパラメータ化します [me指定(任意)/][model指定(必須)/][pkey指定(,pkey指定,...)(GET以外は必須)/] 例) 自分の"model"の一覧を取得 /me/model.json XXX システム毎にRESTのURIパラメータ分解法が違う場合はこのメソッドをオーバーライドして下さい

引数

string

$argRESTResourceHint

戻り値

array model,listed,fields,idsの配列

RestControllerBase::UIDAuthAndExecute

(

)

フレームワーク標準のAuth機能を利用した認証と登録を行って、RESTする(スマフォAPI向け)

戻り値

array 配列構造のリソースデータ

---

このクラス詳解は次のファイルから抽出されました:

• FrameworkPackage/class/MVC/RestControllerBase.abstract.php