Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Collapse
Connection
Strategy
Exception
Bulk
Response
Connection
Index
Multi
Node
Processor
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Transport

\Elastica\TransportNullTransport

Elastica Null Transport object.

This is used in case you just need a test transport that doesn't do any connection to an elasticsearch host but still returns a valid response object

Summary

Methods
Properties
Constants
__construct()
getConnection()
setConnection()
exec()
sanityzeQueryStringBool()
create()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
count()
getResponse()
setResponse()
generateDefaultResponse()
No public properties found
No constants found
_convertArrayable()
_getBaseName()
_setRawParam()
$_connection
$_params
$_rawParams
$_response
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_response

$_response : \Elastica\Response

Response you want to get from the transport.

Type

\Elastica\Response — Response

Methods

__construct()

__construct(\Elastica\Connection  $connection = null)

Construct transport.

Parameters

\Elastica\Connection $connection

Connection object

getConnection()

getConnection() : \Elastica\Connection

Returns

\Elastica\Connection —

Connection object

setConnection()

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

Parameters

\Elastica\Connection $connection

Connection object

Returns

$this

exec()

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

Null transport.

Parameters

\Elastica\Request $request

Request object
array $params

Hostname, port, path, ...

Returns

\Elastica\Response —

Response empty object

sanityzeQueryStringBool()

sanityzeQueryStringBool(array  $query) : mixed

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

Parameters

array $query

Returns

mixed

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

mixed $transport

A transport definition
\Elastica\Connection $connection

A connection instance
array $params

Parameters for the transport class

Throws

\Elastica\Exception\InvalidException

Returns

\Elastica\Transport\AbstractTransport

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

array —

Filter array

setParam()

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

Sets (overwrites) the value at the given key.

Parameters

string $key

Key to set
mixed $value

Key Value

Returns

$this

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

array $params

Parameter list

Returns

$this

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

string $key

Param key
mixed $value

Value to set

Returns

$this

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

string $key

Key to return

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

mixed —

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

string $key

Key to test

Returns

boolean —

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

array —

Params

count()

count() : integer

{@inheritdoc}

Returns

integer

getResponse()

getResponse(array  $params = array()) : \Elastica\Response

Set response object the transport returns.

Parameters

array $params

Hostname, port, path, ...

Returns

\Elastica\Response

setResponse()

setResponse(\Elastica\Response  $response) : $this

Set response object the transport returns.

Parameters

\Elastica\Response $response

Returns

$this

generateDefaultResponse()

generateDefaultResponse(array  $params) : \Elastica\Response

Generate an example response object.

Parameters

array $params

Hostname, port, path, ...

Returns

\Elastica\Response —

$response

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

array $array

Returns

array

_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

string —

name

_setRawParam()

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

Sets params not inside params array.

Parameters

string $key
mixed $value

Returns

$this