• 홈
• RESTfulAPI

PHP 클래스 RESTfulAPI

파일 보기 프로젝트 열기: colymba/silverstripe-restfulapi 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$authenticator	RESTfulAPI_Authenticator	Current Authenticator instance
$authority	RESTfulAPI_PermissionManager	Current Permission Manager instance
$queryHandler	RESTfulAPI_QueryHandler	Current QueryHandler instance
$serializer	RESTfulAPI_Serializer	Current serializer instance

보호된 프로퍼티들

프로퍼티	타입	설명
$instance	RESTfulAPI	Current RESTfulAPI instance

공개 메소드들

메소드	설명
__construct ( )	Constructor.
acl ( SS_HTTPRequest $request )	Handles Access Control methods get response from API PermissionManager then passes it on to $answer()
answer ( string $json = null, boolean $corsPreflight = false )	Output the API response to client then exit.
api_access_control ( string | DataObject $model, string $httpMethod = 'GET' ) : boolean	Checks a class or model api access depending on access_control_policy and the provided model.
auth ( SS_HTTPRequest $request )	Handles authentications methods get response from API Authenticator then passes it on to $answer()
error ( RESTfulAPI_Error $error )	Handles formatting and output error message then exit.
getqueryHandler ( ) : RESTfulAPI_QueryHandler	Returns current query handler instance
getserializer ( ) : RESTfulAPI_Serializer	Returns current serializer instance
index ( SS_HTTPRequest $request ) : string	Main API hub switch All requests pass through here and are redirected depending on HTTP verb and params
init ( )	Controller inititalisation Catches CORS preflight request marked with HTTPMethod 'OPTIONS'

비공개 메소드들

메소드	설명
api_access_config_check ( string $className, string $httpMethod = 'GET' ) : boolean	Checks a model's api_access config.
model_permission_check ( string | DataObject $model, string $httpMethod = 'GET' ) : boolean	Checks a Model's permission for the currently authenticated user via the Permission Manager dependency.
setAnswerCORS ( SS_HTTPResponse $answer )	Apply the proper CORS response heardes to an SS_HTTPResponse

메소드 상세

프로퍼티 상세