PHP Class Tebru\Retrofit\Generation\Provider\AnnotationProvider

Author: Nate Brunette ([email protected])
ファイルを表示 Open project: tebru/retrofit-php Class Usage Examples

Public Methods

Method Description
__construct ( Tebru\Dynamo\Collection\AnnotationCollection $annotations, Tebru\Dynamo\Model\MethodModel $methodModel ) Constructor
getBaseUrl ( ) : null | string Get base url
getBody ( ) : null | string Get body variable
getBodyParts ( ) : array | null Get body parts
getCallback ( ) : null | string Get the callback parameter variable
getDeserializationContext ( ) : array | null Get JMS Deserialization context
getHeaders ( ) : array | null Get header variables
getMultipartBoundary ( ) : string Get the multipart boundary
getQueries ( ) : null | array Get request queries
getQueryMap ( ) : null | string Get query map
getRequestMethod ( ) : string Get request method
getRequestUri ( ) : string Get request uri
getResponseType ( ) : null | string Get the return type for a response return
getReturnType ( ) : null | string Get the expected return
getSerializationContext ( ) : array | null Get JMS Serialization context
getStaticHeaders ( ) : null | array Get headers defined by "@Headers"
hasBody ( ) : boolean If there is a request body
hasBodyAnnotation ( ) : boolean If there is a body annotation
isBodyArray ( ) : boolean If the body parameter is an array
isBodyJsonSerializable ( ) : boolean If the body parameter implements \JsonSerializable
isBodyObject ( ) : boolean If the body parameter is an object
isBodyOptional ( ) : boolean If the body parameter is optional
isCallbackOptional ( ) : boolean Returns if the callback is optional
isFormUrlEncoded ( ) : boolean If the request is form encoded
isJsonEncoded ( ) : boolean If the request is json encoded
isMultipart ( ) : boolean If the request is multipart encoded

Private Methods

Method Description
getBodyAnnotation ( ) * Get the body annotation
getCallbackParameter ( ) : null | Tebru\Dynamo\Model\ParameterModel Get the callback method parameter
getRequestAnnotation ( ) : HttpRequest Get the request annotation

Method Details

__construct() public method

Constructor
public __construct ( Tebru\Dynamo\Collection\AnnotationCollection $annotations, Tebru\Dynamo\Model\MethodModel $methodModel )
$annotations Tebru\Dynamo\Collection\AnnotationCollection
$methodModel Tebru\Dynamo\Model\MethodModel

getBaseUrl() public method

Get base url
public getBaseUrl ( ) : null | string
return null | string

getBody() public method

Get body variable
public getBody ( ) : null | string
return null | string

getBodyParts() public method

Get body parts
public getBodyParts ( ) : array | null
return array | null

getCallback() public method

Get the callback parameter variable
public getCallback ( ) : null | string
return null | string

getDeserializationContext() public method

Get JMS Deserialization context
public getDeserializationContext ( ) : array | null
return array | null

getHeaders() public method

Get header variables
public getHeaders ( ) : array | null
return array | null

getMultipartBoundary() public method

Get the multipart boundary
public getMultipartBoundary ( ) : string
return string

getQueries() public method

Get request queries
public getQueries ( ) : null | array
return null | array

getQueryMap() public method

Get query map
public getQueryMap ( ) : null | string
return null | string

getRequestMethod() public method

Get request method
public getRequestMethod ( ) : string
return string

getRequestUri() public method

Get request uri
public getRequestUri ( ) : string
return string

getResponseType() public method

Get the return type for a response return
public getResponseType ( ) : null | string
return null | string

getReturnType() public method

Get the expected return
public getReturnType ( ) : null | string
return null | string

getSerializationContext() public method

Get JMS Serialization context
public getSerializationContext ( ) : array | null
return array | null

getStaticHeaders() public method

Get headers defined by "@Headers"
public getStaticHeaders ( ) : null | array
return null | array

hasBody() public method

If there is a request body
public hasBody ( ) : boolean
return boolean

hasBodyAnnotation() public method

If there is a body annotation
public hasBodyAnnotation ( ) : boolean
return boolean

isBodyArray() public method

If the body parameter is an array
public isBodyArray ( ) : boolean
return boolean

isBodyJsonSerializable() public method

If the body parameter implements \JsonSerializable
public isBodyJsonSerializable ( ) : boolean
return boolean

isBodyObject() public method

If the body parameter is an object
public isBodyObject ( ) : boolean
return boolean

isBodyOptional() public method

If the body parameter is optional
public isBodyOptional ( ) : boolean
return boolean

isCallbackOptional() public method

Returns if the callback is optional
public isCallbackOptional ( ) : boolean
return boolean

isFormUrlEncoded() public method

If the request is form encoded
public isFormUrlEncoded ( ) : boolean
return boolean

isJsonEncoded() public method

If the request is json encoded
public isJsonEncoded ( ) : boolean
return boolean

isMultipart() public method

If the request is multipart encoded
public isMultipart ( ) : boolean
return boolean