include/SugarSearchEngine/Elastic/Elastica/Request.php

Show:

inherited

Classes
- \Elastica_Request

Table of Contents

Elastica Request object

Author: Nicolas Ruflin
Category: Xodoa
Package: Elastica

\Elastica_Request
jump to top

Package: Elastica

Elastica Request object

Author: Nicolas Ruflin
Category: Xodoa

Constants

 
                POST
                = 'POST'

 
                PUT
                = 'PUT'

 
                GET
                = 'GET'

 
                DELETE
                = 'DELETE'

Properties


                 $_client= ''

Details

Type: n/a


                 $_data= ''

Details

Type: n/a


                 $_method= ''

Details

Type: n/a


                 $_path= ''

Details

Type: n/a

int
                 $_serverId= 'null'

static

Internal id of last used server. This is used for round robin

Last server id

Default valuenullDetails

Type: int

Methods

__construct(
          \Elastica_Client $client, string $path, string $method, array $data
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$client	\Elastica_Client
$path	string	Request path
$method	string	Request method (use const's)
$data	array	Data array

getClient(
          
          )
        
        :
          \Elastica_Client

Returns

Type	Description
\Elastica_Client

getConfig(
          string $key
              =
              ''
          )
        
        :
          array | string

Returns a specific config key or the whole config array if not set

Parameters

Name	Type	Description
$key	string	Config key

Returns

Type	Description
array \| string	Config value

getData(
          
          )
        
        :
          array

Returns

Type	Description
array	Request data

getMethod(
          
          )
        
        :
          string

Returns

Type	Description
string	Request method

getPath(
          
          )
        
        :
          string

Returns

Type	Description
string	Request path

getTransport(
          
          )
        
        :
          \Elastica_Transport_Abstract

Returns an instance of the transport type

Returns

Type	Description
\Elastica_Transport_Abstract	Transport object

Throws

Exception	Description
\Elastica_Exception_Invalid	If invalid transport type

send(
          
          )
        
        :
          \Elastica_Response

Sends request to server

Returns

Type	Description
\Elastica_Response	Response object

setData(
          array $data
          )
        
        :
          void

Sets the request data

Parameters

Name	Type	Description
$data	array	Request data

setMethod(
          string $method
          )
        
        :
          \Elastica_Request

Sets the request method. Use one of the for consts

Parameters

Name	Type	Description
$method	string	Request method

Returns

Type	Description
\Elastica_Request	Current object

setPath(
          string $path
          )
        
        :
          \Elastica_Request

Sets the request path

Parameters

Name	Type	Description
$path	string	Request path

Returns

Type	Description
\Elastica_Request	Current object

include/SugarSearchEngine/Elastic/Elastica/Request.php

\Elastica_Requestjump to top

Constants

Properties

Methods

\Elastica_Request
jump to top