PHP Class Elastica\Transport\AbstractTransport

Author: Nicolas Ruflin ([email protected])

Inheritance: extends Elastica\Param

Show file Open project: ruflin/elastica Class Usage Examples

Protected Properties

Property	Type	Description
$_connection	Elastica\Connection

Public Methods

Method	Description
__construct ( Connection $connection = null )	Construct transport.
create ( mixed $transport, Connection $connection, array $params = [] ) : AbstractTransport	Create a transport.
exec ( Request $request, array $params ) : Response	Executes the transport request.
getConnection ( ) : Connection
setConnection ( Connection $connection )

Method Details

__construct() public method

Construct transport.

public __construct ( Connection $connection = null )
$connection	Elastica\Connection	Connection object

create() public static method

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

public static create ( mixed $transport, Connection $connection, array $params = [] ) : AbstractTransport
$transport	mixed	A transport definition
$connection	Elastica\Connection	A connection instance
$params	array	Parameters for the transport class
return	AbstractTransport

exec() abstract public method

Executes the transport request.

abstract public exec ( Request $request, array $params ) : Response
$request	Elastica\Request	Request object
$params	array	Hostname, port, path, ...
return	Elastica\Response	Response object

getConnection() public method

public getConnection ( ) : Connection
return	Elastica\Connection	Connection object

setConnection() public method

public setConnection ( Connection $connection )
$connection	Elastica\Connection	Connection object

Property Details

$_connection protected property

protected Connection,Elastica $_connection
return	Elastica\Connection