DocumentList Class Reference

Inheritance diagram for DocumentList:

Collaboration diagram for DocumentList:

Public Member Functions
	__construct (SearchDoc &$s=null)
	count ()
	rewind ()
	next ()
	key ()
	current ()
	valid ()
&	getSearchDocument ()
	addDocumentIdentificators (array $ids, $useInitid=true)
	addDocumentIdentifiers (array $ids, $useInitid=true)
	listMap ($hookFunction)

Data Fields
	$length = 0

Detailed Description

Definition at line 15 of file Class.DocumentList.php.

Constructor & Destructor Documentation

__construct

(

SearchDoc &

$s = null

)

Definition at line 34 of file Class.DocumentList.php.

Here is the call graph for this function:

Member Function Documentation

addDocumentIdentificators	(	array	$ids,
			$useInitid = true
	)

set document identifiers to be used in iterator

Parameters

	int[]	$ids document identifiers
bool	$useInitid	if true identifier must ne initid else must be latest ids

Deprecated:

use addDocumentIdentifiers instead

Definition at line 131 of file Class.DocumentList.php.

Here is the call graph for this function:

addDocumentIdentifiers	(	array	$ids,
			$useInitid = true
	)

set document identifiers to be used in iterator

Api:

Set document identifiers to be used in iterator

Parameters

	int[]	$ids document identifiers
bool	$useInitid	if true identifier must ne initid else must be latest ids

Definition at line 142 of file Class.DocumentList.php.

Here is the call graph for this function:

count

(

)

get number of returned documents can be upper of real length due to callback map

Api:

Get number of returned documents

Returns

int

Definition at line 45 of file Class.DocumentList.php.

current

(

)

Returns

Doc

Definition at line 107 of file Class.DocumentList.php.

& getSearchDocument

(

)

Returns

null|SearchDoc

Definition at line 121 of file Class.DocumentList.php.

key

(

)

Definition at line 100 of file Class.DocumentList.php.

listMap

(

$hookFunction

)

apply a callback on each document if callback return false, the document is skipped from list

Parameters

Closure

$hookFunction

Returns

void

Definition at line 164 of file Class.DocumentList.php.

next

(

)

Returns

Doc|null

Definition at line 86 of file Class.DocumentList.php.

rewind

(

)

Definition at line 78 of file Class.DocumentList.php.

valid

(

)

Returns

bool

Definition at line 114 of file Class.DocumentList.php.

Field Documentation

$length = 0

Definition at line 32 of file Class.DocumentList.php.

---

The documentation for this class was generated from the following file:

• Class.DocumentList.php