‪TYPO3CMS  ‪main
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Persistence\Generic\QueryResult Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Persistence\Generic\QueryResult:
TYPO3\CMS\Extbase\Persistence\QueryResultInterface TYPO3\CMS\Extbase\Persistence\QueryResultInterface

Public Member Functions

 __construct (DataMapper $dataMapper, PersistenceManagerInterface $persistenceManager)
 
 setQuery (QueryInterface $query)
 
QueryInterface getQuery ()
 
object getFirst ()
 
int count ()
 
array toArray ()
 
 offsetExists ($offset)
 
TValue null offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
mixed current ()
 
mixed key ()
 
 next ()
 
 rewind ()
 
 valid ()
 
 __wakeup ()
 
array __sleep ()
 

Protected Member Functions

 initialize ()
 

Protected Attributes

DataMapper $dataMapper
 
PersistenceManagerInterface $persistenceManager
 
int null $numberOfResults
 
QueryInterface $query = null
 
array null $queryResult
 

Detailed Description

A lazy result list that is returned by Query::execute()

Todo:
‪v12: Candidate to declare final - Can be decorated or standalone class implementing the interface @template TValue of object

<mixed,TValue>

Definition at line 31 of file QueryResult.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::__construct ( DataMapper  $dataMapper,
PersistenceManagerInterface  $persistenceManager 
)

Definition at line 50 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$dataMapper, and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$persistenceManager.

Member Function Documentation

◆ __sleep()

array TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::__sleep ( )
Returns
‪array

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 252 of file QueryResult.php.

◆ __wakeup()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::__wakeup ( )

Ensures that the persistenceManager and dataMapper are back when loading the QueryResult from the cache

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 242 of file QueryResult.php.

◆ count()

int TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::count ( )

Returns the number of objects in the result

Returns
‪int The number of matching objects

Definition at line 116 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$numberOfResults.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\QueryResultTest\countCallsGetObjectCountByQueryOnPersistenceManager(), and TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\QueryResultTest\countDoesNotInitializeProxy().

◆ current()

mixed TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::current ( )
Returns
‪mixed
See also
‪Iterator::current()
Returns
‪TValue|false

Definition at line 193 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getFirst(), and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\valid().

◆ getFirst()

object TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::getFirst ( )

Returns the first object in the result set

Returns
‪object @phpstan-return TValue|null

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 94 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$query, TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$queryResult, TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\current(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getQuery(), TYPO3\CMS\Extbase\Persistence\QueryInterface\getType(), and TYPO3\CMS\Extbase\Persistence\QueryInterface\setLimit().

◆ getQuery()

QueryInterface TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::getQuery ( )

Returns a clone of the query object

Returns
‪QueryInterface @phpstan-return QueryInterface<TValue>

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 83 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$query.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getFirst().

◆ initialize()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::initialize ( )
protected

Loads the objects this QueryResult is supposed to hold

Definition at line 70 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\current(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\key(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\next(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\offsetExists(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\offsetGet(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\offsetSet(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\offsetUnset(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\rewind(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\toArray(), and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\valid().

◆ key()

mixed TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::key ( )
Returns
‪mixed
See also
‪Iterator::key()
Returns
‪int|null

Definition at line 204 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ next()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::next ( )
See also
‪Iterator::next()

Definition at line 213 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ offsetExists()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::offsetExists (   $offset)

This method is needed to implement the ArrayAccess interface, but it isn't very useful as the offset has to be an integer

Parameters
mixed$offset

Definition at line 146 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ offsetGet()

TValue null TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::offsetGet (   $offset)
Parameters
mixed$offset
Returns
‪TValue|null

Definition at line 156 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ offsetSet()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::offsetSet (   $offset,
  $value 
)

This method has no effect on the persisted objects but only on the result set

Parameters
mixed$offset
mixed$value‪@phpstan-param TValue $value

Definition at line 169 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ offsetUnset()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::offsetUnset (   $offset)

This method has no effect on the persisted objects but only on the result set

Parameters
mixed$offset

Definition at line 181 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ rewind()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::rewind ( )
See also
‪Iterator::rewind()

Definition at line 222 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ setQuery()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::setQuery ( QueryInterface  $query)

@phpstan-param QueryInterface<TValue> $query

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 61 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\$query.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\QueryResultTest\countCallsGetObjectCountByQueryOnPersistenceManager(), TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\QueryResultTest\countDoesNotInitializeProxy(), and TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\QueryResultTest\initializeExecutesQueryWithArrayFetchMode().

◆ toArray()

array TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::toArray ( )

Returns an array with the objects in the result set

Returns
‪array @phpstan-return list<TValue>

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 134 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

◆ valid()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::valid ( )
See also
‪Iterator::valid()

Definition at line 231 of file QueryResult.php.

References TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\current(), and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\initialize().

Member Data Documentation

◆ $dataMapper

DataMapper TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$dataMapper
protected

Definition at line 33 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\__construct().

◆ $numberOfResults

int null TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$numberOfResults
protected

Definition at line 38 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\count().

◆ $persistenceManager

PersistenceManagerInterface TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$persistenceManager
protected

Definition at line 34 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\__construct().

◆ $query

QueryInterface TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$query = null
protected

@phpstan-var QueryInterface<TValue>|null

Definition at line 43 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getFirst(), TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getQuery(), and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\setQuery().

◆ $queryResult

array null TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$queryResult
protected

@phpstan-var list<TValue>|null

Definition at line 48 of file QueryResult.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getFirst().