\Elastica\TransportGuzzle

__construct()

__construct(\Elastica\Connection  $connection = null) 

Construct transport.

Parameters

getConnection()

getConnection() : \Elastica\Connection

Returns

Connection object

setConnection()

setConnection(\Elastica\Connection  $connection) : $this

Parameters

Returns

exec()

exec(\Elastica\Request  $request, array  $params) : \Elastica\Response

Makes calls to the elasticsearch server.

All calls that are made to the server are done through this function

Parameters

Throws

\Elastica\Exception\ConnectionException

\Elastica\Exception\ResponseException

\Elastica\Exception\Connection\HttpException

Returns

Response object

sanityzeQueryStringBool()

sanityzeQueryStringBool(string  $query) : mixed

BOOL values true|false should be sanityzed and passed to Elasticsearch as string.

Parameters

Returns

create()

create(mixed  $transport, \Elastica\Connection  $connection, array  $params = array()) : \Elastica\Transport\AbstractTransport

Create a transport.

The $transport parameter can be one of the following values:

• string: The short name of a transport. For instance "Http"
• object: An already instantiated instance of a transport
• array: An array with a "type" key which must be set to one of the two options. All other keys in the array will be set as parameters in the transport instance

Parameters

Throws

\Elastica\Exception\InvalidException

Returns

toArray()

toArray() : array

Converts the params to an array. A default implementation exist to create the an array out of the class name (last part of the class name) and the params.

Returns

Filter array

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

Returns

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

Returns

addParam()

addParam(string  $key, mixed  $value) : $this

Adds a param to the list.

This function can be used to add an array of params

Parameters

Returns

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

Returns

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

Params

count()

count() : integer

{@inheritdoc}

Returns

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

Returns

_getBaseName()

_getBaseName() : string

Param's name Picks the last part of the class name and makes it snake_case You can override this method if you want to change the name.

Returns

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

Returns

_createPsr7Request()

_createPsr7Request(\Elastica\Request  $request, \Elastica\Connection  $connection) : \GuzzleHttp\Psr7\Request

Parameters

Returns

_getGuzzleClient()

_getGuzzleClient(string  $baseUrl, boolean  $persistent = true, \Elastica\Request  $request) : \GuzzleHttp\Client

Return Guzzle resource.

Parameters

Returns

_getBaseUrl()

_getBaseUrl(\Elastica\Connection  $connection) : string

Builds the base url for the guzzle connection.

Parameters

Returns

_getActionPath()

_getActionPath(\Elastica\Request  $request) : string

Builds the action path url for each request.

Parameters

Returns