PHP Класс Elastica\Request

Автор: Nicolas Ruflin ([email protected])
Наследование: extends Param
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_connection Connection

Открытые методы

Метод Описание
__construct ( string $path, string $method = self::GET, array $data = [], array $query = [], Connection $connection = null ) : Request Construct.
__toString ( ) : string
getConnection ( ) : Connection Return Connection Object.
getData ( ) : array Return request data.
getMethod ( ) : string Get request method.
getPath ( ) : string Return request path.
getQuery ( ) : array Return query params.
send ( ) : Response Sends request to server.
setConnection ( Connection $connection )
setData ( array $data ) Sets the request data.
setMethod ( string $method ) Sets the request method. Use one of the for consts.
setPath ( string $path ) Sets the request path.
setQuery ( array $query = [] )
toArray ( ) : array
toString ( ) : string Converts request to curl request format.

Описание методов

__construct() публичный Метод

Construct.
public __construct ( string $path, string $method = self::GET, array $data = [], array $query = [], Connection $connection = null ) : Request
$path string Request path
$method string OPTIONAL Request method (use const's) (default = self::GET)
$data array OPTIONAL Data array
$query array OPTIONAL Query params
$connection Connection
Результат Request OPTIONAL Connection object

__toString() публичный Метод

public __toString ( ) : string
Результат string

getConnection() публичный Метод

Return Connection Object.
public getConnection ( ) : Connection
Результат Connection

getData() публичный Метод

Return request data.
public getData ( ) : array
Результат array Request data

getMethod() публичный Метод

Get request method.
public getMethod ( ) : string
Результат string Request method

getPath() публичный Метод

Return request path.
public getPath ( ) : string
Результат string Request path

getQuery() публичный Метод

Return query params.
public getQuery ( ) : array
Результат array Query params

send() публичный Метод

Sends request to server.
public send ( ) : Response
Результат Response Response object

setConnection() публичный Метод

public setConnection ( Connection $connection )
$connection Connection

setData() публичный Метод

Sets the request data.
public setData ( array $data )
$data array Request data

setMethod() публичный Метод

Sets the request method. Use one of the for consts.
public setMethod ( string $method )
$method string Request method

setPath() публичный Метод

Sets the request path.
public setPath ( string $path )
$path string Request path

setQuery() публичный Метод

public setQuery ( array $query = [] )
$query array

toArray() публичный Метод

public toArray ( ) : array
Результат array

toString() публичный Метод

Converts request to curl request format.
public toString ( ) : string
Результат string

Описание свойств

$_connection защищенное свойство

protected Connection,Elastica $_connection
Результат Connection