PHP Class AlgoliaSearch\IndexBrowser

Inheritance: implements Iterator
Show file Open project: algolia/algoliasearch-client-php

Public Methods

Method Description
__construct ( Index $index, string $query, array | null $params = null, integer | null $cursor = null ) IndexBrowser constructor.
current ( ) : mixed
cursor ( ) : integer
key ( ) : integer
next ( ) : mixed
rewind ( )
valid ( ) : boolean

Private Methods

Method Description
doQuery ( integer $cursor = null )

Method Details

__construct() public method

IndexBrowser constructor.
public __construct ( Index $index, string $query, array | null $params = null, integer | null $cursor = null )
$index Index
$query string
$params array | null
$cursor integer | null

current() public method

public current ( ) : mixed
return mixed

cursor() public method

public cursor ( ) : integer
return integer

key() public method

public key ( ) : integer
return integer

next() public method

public next ( ) : mixed
return mixed

rewind() public method

public rewind ( )

valid() public method

public valid ( ) : boolean
return boolean