PHP 클래스 Scalr\Api\DataType\ApiEntityAdapter

부터: 5.4.0 (02.03.2015)
저자: Vitaliy Demidov ([email protected])
상속: extends Scalr\Model\Objects\BaseAdapter
파일 보기 프로젝트 열기: scalr/scalr 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$controller Scalr\Api\Rest\Controller\ApiController Controller instance

공개 메소드들

메소드 설명
__construct ( ApiController $controller ) Constructor
convertInputValue ( $fieldType, $value, $fieldName = '' )
convertOutputValue ( string $fieldType, string $value ) : mixed Converts output value
copyAlterableProperties ( object $object, AbstractEntity $entity ) Copies all alterable properties from the request object to Entity
find ( array $criteria = null, callable $findCallback = null ) : ApiEntityAdapter Fetches records according to rules set
getCriteria ( array $criteria = null ) : array | null Adjusts search criteria according to RULE_TYPE_FILTERABLE rules and Request
getDescribeResult ( array $criteria = null, callable $findCallback = null ) : Scalr\Api\DataType\ListResultEnvelope Gets describe result
getSettingsCollection ( AbstractEntity $entity ) : SettingsCollection Gets settings collection from entity.
getSettingsRules ( ) : array Gets settings to data rules
getSorting ( ) : array | null Gets sorting option for the find method of the Entity
toData ( $entity )
toEntity ( $data )
validateEntity ( AbstractEntity $entity ) Validates entity
validateObject ( object $object, string $method = null ) Validates object
validateString ( string $string, string $message = 'Invalid string' ) Validates specified string

메소드 상세

__construct() 공개 메소드

Constructor
public __construct ( ApiController $controller )
$controller Scalr\Api\Rest\Controller\ApiController The controller instance

convertInputValue() 공개 정적인 메소드

또한 보기: BaseAdapter::convertInputValue()
public static convertInputValue ( $fieldType, $value, $fieldName = '' )

convertOutputValue() 공개 정적인 메소드

Converts output value
public static convertOutputValue ( string $fieldType, string $value ) : mixed
$fieldType string Field type
$value string A value taken from input
리턴 mixed Returns value which can be used in the response

copyAlterableProperties() 공개 메소드

It does not validate the values. It only checks whether the request contains only alterable properties. If not it will raise ApiErrorExceptions
public copyAlterableProperties ( object $object, AbstractEntity $entity )
$object object An object (source)
$entity Scalr\Model\AbstractEntity An Entity (destination)

find() 공개 메소드

Fetches records according to rules set
public find ( array $criteria = null, callable $findCallback = null ) : ApiEntityAdapter
$criteria array optional Default search criteria
$findCallback callable optional Find method. Default value: find
리턴 ApiEntityAdapter Returns current instance that actually is iterator of the found records

getCriteria() 공개 메소드

Adjusts search criteria according to RULE_TYPE_FILTERABLE rules and Request
public getCriteria ( array $criteria = null ) : array | null
$criteria array optional Default search criteria
리턴 array | null Returns adjusted criteria

getDescribeResult() 공개 메소드

Gets describe result
public getDescribeResult ( array $criteria = null, callable $findCallback = null ) : Scalr\Api\DataType\ListResultEnvelope
$criteria array Default search criteria
$findCallback callable optional Find method. Default value: find
리턴 Scalr\Api\DataType\ListResultEnvelope Returns describe result

getSettingsCollection() 공개 메소드

Gets settings collection from entity.
public getSettingsCollection ( AbstractEntity $entity ) : SettingsCollection
$entity Scalr\Model\AbstractEntity Entity containing collection of settings
리턴 Scalr\Model\Collections\SettingsCollection

getSettingsRules() 공개 메소드

Gets settings to data rules
public getSettingsRules ( ) : array
리턴 array

getSorting() 공개 메소드

It processes HTTP Request and takes RULE_TYPE_SORTING of rules into account
public getSorting ( ) : array | null
리턴 array | null Returns sorting option for the find method of the Entity

toData() 공개 메소드

또한 보기: BaseAdapter::toData()
public toData ( $entity )

toEntity() 공개 메소드

또한 보기: BaseAdapter::toEntity()
public toEntity ( $data )

validateEntity() 공개 메소드

It is applicable only to either POST or PATCH methods. It should be used on GET methods.
public validateEntity ( AbstractEntity $entity )
$entity Scalr\Model\AbstractEntity An Entity

validateObject() 공개 메소드

It is applicable only to either POST or PATCH methods. It should be used on GET methods.
public validateObject ( object $object, string $method = null )
$object object An object provided with the request
$method string optional HTTP METHOD

validateString() 공개 메소드

Validates specified string
public validateString ( string $string, string $message = 'Invalid string' )
$string string A string
$message string optional A error message

프로퍼티 상세

$controller 보호되어 있는 프로퍼티

Controller instance
protected ApiController,Scalr\Api\Rest\Controller $controller
리턴 Scalr\Api\Rest\Controller\ApiController