API Documentation
Back to top  

HttpSourceCondition

Extends \HttpSourceField

Http source endpoint condition

package

HttpSource
subpackage

Config

Methods

Constructor

__construct(\HttpSourceConfigFactory $ConfigFactory)
inherited

Arguments

$ConfigFactory

\HttpSourceConfigFactory

Config factory instance

Typecast to string

__toString() : string
inherited

Response

string

Sets or gets condition default value

defaults(mixed $value = null) : \HttpSourceCondition

Arguments

$value

mixed

Response

\HttpSourceCondition

Sets or gets should we extract value or not

extract(boolean $value = null) : \HttpSourceCondition

Arguments

$value

boolean

Response

\HttpSourceCondition

Retunrn config factory

getConfigFactory() : \HttpSourceConfigFactory
inherited

Response

\HttpSourceConfigFactory

Returns all data types

getDataTypes() : array
static

Response

array

Returns all send in types

getSendInTypes() : array
static

Response

array

Return current key value

key() : string

Response

string

Set condition as primary key

keyPrimary() : \HttpSourceCondition

Response

\HttpSourceCondition

Sets or gets condition length

length(integer $length = null) : \HttpSourceCondition

Arguments

$length

integer

Response

\HttpSourceCondition

Get or set callback and new name

map(callable $callback = null, \= $map_to_name) : \HttpSourceCondition

Arguments

$callback

callable

$map_to_name

\=

Response

\HttpSourceCondition

Set or get callback

map(callable $callback = null) : \HttpSourceEndpointItem
inherited

Arguments

$callback

callable

Response

\HttpSourceEndpointItem

Get mapToName or name

mapToName()
inherited

True if condition must be in body or query depends on current endpoint

mustSendInAny() : boolean

Response

boolean

True if condition must be in body

mustSendInBody() : boolean

Response

boolean

True if condition must be in query

mustSendInQuery() : boolean

Response

boolean

True if condition must be virtial

mustSendInVirtual() : boolean

Response

boolean

Set or get field name

name(\= $name) : \HttpSourceCondition

Arguments

$name

\=

Response

\HttpSourceCondition

Set or get field name

name(string $name = null) : \HttpSourceField
inherited
throws

Arguments

$name

string

Response

\HttpSourceField

Mark condition as required or not If $null = null returns current value

null(boolean $null = null) : \HttpSourceCondition

Arguments

$null

boolean

Response

\HttpSourceCondition

Mark condition as required

required() : \HttpSourceCondition

Response

\HttpSourceCondition

Set force send in body or query, depends on current endpoint

sendInAny() : \HttpSourceCondition

Response

\HttpSourceCondition

Set force send in body

sendInBody() : \HttpSourceCondition

Response

\HttpSourceCondition

Set force send in query

sendInQuery() : \HttpSourceCondition

Response

\HttpSourceCondition

Set condition force to virtual

sendInVirtual() : \HttpSourceCondition

Response

\HttpSourceCondition

Returns condition type

type() : string

Response

string

Set type to bool

typeBool() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to bool

typeBoolean() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to float

typeFloat() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to int

typeInt() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to int

typeInteger() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to string

typeString() : \HttpSourceCondition

Response

\HttpSourceCondition

Set type to text

typeText() : \HttpSourceCondition

Response

\HttpSourceCondition

Constants

Send in constants

SEND_IN_ANY

SEND_IN_QUERY

SEND_IN_QUERY

SEND_IN_BODY

SEND_IN_BODY

SEND_IN_VIRTUAL

SEND_IN_VIRTUAL

Available types

TYPE_INT

TYPE_FLOAT

TYPE_FLOAT

TYPE_BOOL

TYPE_BOOL

TYPE_STRING

TYPE_STRING

TYPE_TEXT

TYPE_TEXT

Available keys

KEY_PRIMARY

Properties

Condition type

_type : string
var

Type(s)

string

True if condition required, false otherwise Used to describe model and build request

_null : boolean
var

Type(s)

boolean

Max length of conditions Used to describe model

_length : integer
var

Type(s)

integer

Key type, actually supports only 'primary' Used to describe model

_key : string
var

Type(s)

string

Default condition value Used to describe model and build request

_default : mixed
var

Type(s)

mixed

Extract values

_extract : boolean
var

Type(s)

boolean

Sepecified where to place condition - in body, in query or any - depends on current endpoint

_sendIn : string
var

Type(s)

string

Field name

_name : string
inherited
var

Type(s)

string

New field name

_mapToName : string
inherited
var

Type(s)

string

Holds callback

_map : callable
inherited
var

Type(s)

callable

Config factory instance

_ConfigFactory : \HttpSourceConfigFactory
inherited
var

Type(s)

\HttpSourceConfigFactory