Elastification PHP Client API
Interface

Elastification\Client\Request\RequestInterface

interface RequestInterface

Interface RequestInterface

Methods

null|string getIndex()

Gets the elasticsearch index

null|string getType()

Gets the elasticsearch type

string getMethod()

Gets the request method

null|string getAction()

Gets the elasticsearch action/endpoint like (_search, _mapping)

SerializerInterface getSerializer()

Gets the serializer

array getSerializerParams()

Gets the serializer params

mixed getBody()

get the body

void setBody(mixed $body)

before setting data it should be serialized

null|ResponseInterface createResponse(string $rawData, SerializerInterface $serializer, array $serializerParams = array())

string getSupportedClass()

gets a response class name that is supported by this class

Details

at line 37
public null|string getIndex()

Gets the elasticsearch index

Return Value

null|string

at line 45
public null|string getType()

Gets the elasticsearch type

Return Value

null|string

at line 53
public string getMethod()

Gets the request method

Return Value

string

at line 62
public null|string getAction()

Gets the elasticsearch action/endpoint like (_search, _mapping)

Return Value

null|string

at line 70
public SerializerInterface getSerializer()

Gets the serializer

Return Value

SerializerInterface

at line 78
public array getSerializerParams()

Gets the serializer params

Return Value

array

at line 86
public mixed getBody()

get the body

Return Value

mixed

at line 97
public void setBody(mixed $body)

before setting data it should be serialized

Parameters

mixed $body

Return Value

void

Exceptions

RequestException

at line 107
public null|ResponseInterface createResponse(string $rawData, SerializerInterface $serializer, array $serializerParams = array())

Parameters

string $rawData
SerializerInterface $serializer
array $serializerParams

Return Value

null|ResponseInterface

at line 119
public string getSupportedClass()

gets a response class name that is supported by this class

Return Value

string