SMW\Query\Result\ResultArray Class Reference

Public Member Functions
	__construct (DIWikiPage $resultPage, PrintRequest $printRequest, Store $store, FieldItemFinder $fieldItemFinder=null)
	getStore ()
	getResultSubject ()
	setItemJournal (ItemJournal $itemJournal)
	setQueryToken (QueryToken $queryToken=null)
	setContextPage (DIWikiPage $contextPage=null)
	getContent ()
	getPrintRequest ()
	getNextDataItem ()
	reset ()
	getNextText ( $outputMode, $linker=null)

Static Public Member Functions
static	factory (DIWikiPage $resultPage, PrintRequest $printRequest, QueryResult $queryResult)

Protected Member Functions
	loadContent ()

Detailed Description

Container for the contents of a single result field of a query result, i.e. basically an array of SMWDataItems with some additional parameters. The content of the array is fetched on demand only.

GNU GPL v2+

Since

3.1

Author

Markus Krötzsch

Jeroen De Dauw < jeroe.nosp@m.nded.nosp@m.auw@g.nosp@m.mail.nosp@m..com >

Constructor & Destructor Documentation

__construct()

SMW\Query\Result\ResultArray::__construct	(	DIWikiPage	$resultPage,
		PrintRequest	$printRequest,
		Store	$store,
		FieldItemFinder	$fieldItemFinder = null
	)

Parameters

DIWikiPage	$resultPage
PrintRequest	$printRequest
Store	$store
fieldItemFinder | null	$fieldItemFinder

Member Function Documentation

factory()

static SMW\Query\Result\ResultArray::factory ( DIWikiPage  $resultPage, PrintRequest  $printRequest, QueryResult  $queryResult  )

static

Since

3.1

Parameters

DIWikiPage	$resultPage
PrintRequest	$printRequest
QueryResult	$queryResult

Returns

self

getContent()

SMW\Query\Result\ResultArray::getContent

(

)

Returns an array of SMWDataItem objects that contain the results of the given print request for the given result object.

Returns

DataItem[]|false

getNextDataItem()

SMW\Query\Result\ResultArray::getNextDataItem

(

)

Return the next SMWDataItem object or false if no further object exists.

Since

1.6

Returns

DataItem|false

getNextText()

SMW\Query\Result\ResultArray::getNextText	(		$outputMode,
			$linker = null
	)

Return the main text representation of the next SMWDataItem object in the specified format, or false if no further object exists.

The parameter $linker controls linking of title values and should be some Linker object (or NULL for no linking).

Parameters

integer	$outputMode
mixed	$linker

Returns

string|false

getPrintRequest()

SMW\Query\Result\ResultArray::getPrintRequest

(

)

Return a PrintRequest object describing what is contained in this result set.

Returns

PrintRequest

getResultSubject()

SMW\Query\Result\ResultArray::getResultSubject

(

)

Returns the DIWikiPage object to which this ResultArray refers. If you only care for those objects, consider using SMWQueryResult::getResults() directly.

Returns

DIWikiPage

getStore()

SMW\Query\Result\ResultArray::getStore

(

)

Get the SMWStore object that this result is based on.

Returns

Store

loadContent()

SMW\Query\Result\ResultArray::loadContent ( )

protected

Load results of the given print request and result subject. This is only done when needed.

reset()

SMW\Query\Result\ResultArray::reset

(

)

Set the internal pointer of the array of SMWDataItem objects to its first element. Return the first SMWDataItem object or false if the array is empty.

Since

1.7.1

Returns

DataItem|false

setContextPage()

SMW\Query\Result\ResultArray::setContextPage

(

DIWikiPage

$contextPage = null

)

Since

3.1

Parameters

DIWikiPage | null

$contextPage

setItemJournal()

SMW\Query\Result\ResultArray::setItemJournal

(

ItemJournal

$itemJournal

)

Temporary track what entities are used while being instantiated, so an external service can have access to the list without requiring to resolve the objects independently.

Since

2.4

Parameters

ItemJournal

$itemJournal

setQueryToken()

SMW\Query\Result\ResultArray::setQueryToken

(

QueryToken

$queryToken = null

)

Since

2.5

Parameters

QueryToken | null

$queryToken

---

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

• ResultArray.php