PHP 클래스 RESTfulAPI_DefaultQueryHandler

저자: Thierry Francois @colymba [email protected]

상속: implements RESTfulAPI_QueryHandler

파일 보기 프로젝트 열기: colymba/silverstripe-restfulapi

공개 프로퍼티들

프로퍼티	타입	설명
$deSerializer	RESTfulAPI_DeSerializer	Current deSerializer instance
$requestedData	array	Stores the currently requested data

공개 메소드들

메소드	설명
createModel ( string $model, SS_HTTPRequest $request ) : DataObject	Create object of class $model
deleteModel ( string $model, integer $id, SS_HTTPRequest $request ) : null \| array	Delete object of Class $model and ID $id
findModel ( string $model, boolean \| integr $id = false, array $queryParams, SS_HTTPRequest $request ) : DataObject \| DataList	Finds 1 or more objects of class $model
getdeSerializer ( ) : RESTfulAPI_DeSerializer	Return current RESTfulAPI DeSerializer instance
handleQuery ( SS_HTTPRequest $request ) : DataObjec \| DataList	All requests pass through here and are redirected depending on HTTP verb and params
parseQueryParameters ( array $params ) : array	Parse the query parameters to appropriate Column, Value, Search Filter Modifiers array( array( 'Column' => ColumnName, 'Value' => ColumnValue, 'Modifier' => ModifierType ) )
updateModel ( String \| DataObject $model, integer $id, $request ) : DataObject	Update databse record or $model

메소드 상세

createModel() 공개 메소드

Create object of class $model

public createModel ( string $model, SS_HTTPRequest $request ) : DataObject
$model	string
$request	SS_HTTPRequest
리턴	DataObject

deleteModel() 공개 메소드

Delete object of Class $model and ID $id

public deleteModel ( string $model, integer $id, SS_HTTPRequest $request ) : null \| array
$model	string	Model class
$id	integer	Model ID
$request	SS_HTTPRequest	Model ID
리턴	null \| array	NULL if successful or array with error detail

findModel() 공개 메소드

Handles column modifiers: :StartsWith, :EndsWith, :PartialMatch, :GreaterThan, :LessThan, :Negation and query modifiers: sort, rand, limit

public findModel ( string $model, boolean \| integr $id = false, array $queryParams, SS_HTTPRequest $request ) : DataObject \| DataList
$model	string	Model(s) class to find
$id	boolean \| integr	The ID of the model to find or false
$queryParams	array	Query parameters and modifiers
$request	SS_HTTPRequest	The original HTTP request
리턴	DataObject \| DataList	Result of the search (note: DataList can be empty)

getdeSerializer() 공개 메소드

Return current RESTfulAPI DeSerializer instance

public getdeSerializer ( ) : RESTfulAPI_DeSerializer
리턴	RESTfulAPI_DeSerializer	DeSerializer instance

handleQuery() 공개 메소드

All requests pass through here and are redirected depending on HTTP verb and params

public handleQuery ( SS_HTTPRequest $request ) : DataObjec \| DataList
$request	SS_HTTPRequest	HTTP request
리턴	DataObjec \| DataList	DataObject/DataList result or stdClass on error

parseQueryParameters() 공개 메소드

Parse the query parameters to appropriate Column, Value, Search Filter Modifiers array( array( 'Column' => ColumnName, 'Value' => ColumnValue, 'Modifier' => ModifierType ) )

public parseQueryParameters ( array $params ) : array
$params	array	raw GET vars array
리턴	array	formatted query parameters

updateModel() 공개 메소드

Update databse record or $model

public updateModel ( String \| DataObject $model, integer $id, $request ) : DataObject
$model	String \| DataObject	the model or class to update
$id	integer	The ID of the model to update
리턴	DataObject	The updated model

프로퍼티 상세

$deSerializer 공개적으로 프로퍼티

Current deSerializer instance

public RESTfulAPI_DeSerializer $deSerializer
리턴	RESTfulAPI_DeSerializer

$requestedData 공개적으로 프로퍼티

Stores the currently requested data

public array $requestedData
리턴	array