PHP 클래스 Elastica\Connection

저자: Nicolas Ruflin ([email protected])
상속: extends Param
파일 보기 프로젝트 열기: ruflin/elastica 1 사용 예제들

공개 메소드들

메소드 설명
__construct ( array $params = [] ) Creates a new connection object. A connection is enabled by default.
addConfig ( string $key, mixed $value )
create ( Connection | array $params = [] ) : self
getConfig ( string $key = '' ) : array | string Returns a specific config key or the whole config array if not set.
getConnectTimeout ( ) : integer
getHost ( ) : string
getPassword ( ) : string
getPath ( ) : string
getPort ( ) : integer
getProxy ( ) : string | null
getTimeout ( ) : integer
getTransport ( ) : string | array
getTransportObject ( ) : AbstractTransport Returns an instance of the transport type.
getUsername ( ) : string
hasCompression ( ) : boolean
hasConfig ( string $key ) : boolean
isEnabled ( ) : boolean
isPersistent ( ) : boolean
setCompression ( boolean $compression = null )
setConfig ( array $config )
setConnectTimeout ( integer $timeout ) Number of seconds after a connection timeout occurs for every request during the connection phase.
setEnabled ( boolean $enabled = true ) Enables a connection.
setHost ( string $host )
setPath ( string $path )
setPort ( integer $port )
setProxy ( string | null $proxy ) Set proxy for http connections. Null is for environmental proxy, empty string to disable proxy and proxy string to set actual http proxy.
setTimeout ( integer $timeout )
setTransport ( string | array $transport )

메소드 상세

__construct() 공개 메소드

Creates a new connection object. A connection is enabled by default.
public __construct ( array $params = [] )
$params array OPTIONAL Connection params: host, port, transport, timeout. All are optional

addConfig() 공개 메소드

public addConfig ( string $key, mixed $value )
$key string
$value mixed

create() 공개 정적인 메소드

public static create ( Connection | array $params = [] ) : self
$params Connection | array Params to create a connection
리턴 self

getConfig() 공개 메소드

Returns a specific config key or the whole config array if not set.
public getConfig ( string $key = '' ) : array | string
$key string Config key
리턴 array | string Config value

getConnectTimeout() 공개 메소드

public getConnectTimeout ( ) : integer
리턴 integer Connection timeout in seconds

getHost() 공개 메소드

public getHost ( ) : string
리턴 string Host

getPassword() 공개 메소드

public getPassword ( ) : string
리턴 string Password

getPath() 공개 메소드

public getPath ( ) : string
리턴 string

getPort() 공개 메소드

public getPort ( ) : integer
리턴 integer Server port

getProxy() 공개 메소드

public getProxy ( ) : string | null
리턴 string | null Host

getTimeout() 공개 메소드

public getTimeout ( ) : integer
리턴 integer Connection timeout in seconds

getTransport() 공개 메소드

public getTransport ( ) : string | array
리턴 string | array

getTransportObject() 공개 메소드

Returns an instance of the transport type.
public getTransportObject ( ) : AbstractTransport
리턴 Elastica\Transport\AbstractTransport Transport object

getUsername() 공개 메소드

public getUsername ( ) : string
리턴 string User

hasCompression() 공개 메소드

public hasCompression ( ) : boolean
리턴 boolean

hasConfig() 공개 메소드

public hasConfig ( string $key ) : boolean
$key string
리턴 boolean

isEnabled() 공개 메소드

public isEnabled ( ) : boolean
리턴 boolean True if enabled

isPersistent() 공개 메소드

public isPersistent ( ) : boolean
리턴 boolean Returns true if connection is persistent. True by default

setCompression() 공개 메소드

public setCompression ( boolean $compression = null )
$compression boolean

setConfig() 공개 메소드

public setConfig ( array $config )
$config array

setConnectTimeout() 공개 메소드

Use a small value if you need a fast fail in case of dead, unresponsive or unreachable servers (~5 sec). Set to zero to switch to the default built-in connection timeout (300 seconds in curl).
또한 보기: http://curl.haxx.se/libcurl/c/CURLOPT_CONNECTTIMEOUT.html
public setConnectTimeout ( integer $timeout )
$timeout integer Connect timeout in seconds

setEnabled() 공개 메소드

Enables a connection.
public setEnabled ( boolean $enabled = true )
$enabled boolean OPTIONAL (default = true)

setHost() 공개 메소드

public setHost ( string $host )
$host string

setPath() 공개 메소드

public setPath ( string $path )
$path string

setPort() 공개 메소드

public setPort ( integer $port )
$port integer

setProxy() 공개 메소드

Set proxy for http connections. Null is for environmental proxy, empty string to disable proxy and proxy string to set actual http proxy.
또한 보기: http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY
public setProxy ( string | null $proxy )
$proxy string | null

setTimeout() 공개 메소드

public setTimeout ( integer $timeout )
$timeout integer Timeout in seconds

setTransport() 공개 메소드

public setTransport ( string | array $transport )
$transport string | array