PHP Class Elastica\Multi\ResultSet

Author: munkie
Inheritance: implements Iterator, implements ArrayAccess, implements Countable
Show file Open project: ruflin/elastica

Protected Properties

Property Type Description
$_position Current position.
$_response Response.
$_resultSets Result Sets.

Public Methods

Method Description
__construct ( Response $response, $resultSets ) Constructs ResultSet object.
count ( ) : integer
current ( ) : boolean | ResultSet
getResponse ( ) : Response Returns response object.
getResultSets ( ) : array | ResultSet[]
hasError ( ) : boolean There is at least one result set with error.
key ( ) : integer
next ( )
offsetExists ( string | integer $offset ) : boolean
offsetGet ( mixed $offset ) : mixed
offsetSet ( mixed $offset, mixed $value )
offsetUnset ( mixed $offset )
rewind ( )
valid ( ) : boolean

Method Details

__construct() public method

Constructs ResultSet object.
public __construct ( Response $response, $resultSets )
$response Elastica\Response

count() public method

public count ( ) : integer
return integer

current() public method

public current ( ) : boolean | ResultSet
return boolean | Elastica\ResultSet

getResponse() public method

Returns response object.
public getResponse ( ) : Response
return Elastica\Response Response object

getResultSets() public method

public getResultSets ( ) : array | ResultSet[]
return array | Elastica\ResultSet[]

hasError() public method

There is at least one result set with error.
public hasError ( ) : boolean
return boolean

key() public method

public key ( ) : integer
return integer

next() public method

public next ( )

offsetExists() public method

public offsetExists ( string | integer $offset ) : boolean
$offset string | integer
return boolean true on success or false on failure.

offsetGet() public method

public offsetGet ( mixed $offset ) : mixed
$offset mixed
return mixed Can return all value types.

offsetSet() public method

public offsetSet ( mixed $offset, mixed $value )
$offset mixed
$value mixed

offsetUnset() public method

public offsetUnset ( mixed $offset )
$offset mixed

rewind() public method

public rewind ( )

valid() public method

public valid ( ) : boolean
return boolean

Property Details

$_position protected property

Current position.
protected $_position

$_response protected property

Response.
protected $_response

$_resultSets protected property

Result Sets.
protected $_resultSets