TYPO3 CMS  TYPO3_6-2
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 Tx_Extbase_Persistence_QueryResult

Public Member Functions

 __construct (\TYPO3\CMS\Extbase\Persistence\QueryInterface $query)
 
 getQuery ()
 
 getFirst ()
 
 count ()
 
 toArray ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 current ()
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 
 __wakeup ()
 
 __sleep ()
 

Protected Member Functions

 initialize ()
 

Protected Attributes

 $dataMapper
 
 $persistenceManager
 
 $numberOfResults
 
 $query
 
 $queryResult
 

Detailed Description

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

Definition at line 23 of file QueryResult.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

Parameters
\TYPO3\CMS\Extbase\Persistence\QueryInterface$query

Definition at line 58 of file QueryResult.php.

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

Member Function Documentation

◆ __sleep()

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

Definition at line 238 of file QueryResult.php.

◆ __wakeup()

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

Definition at line 229 of file QueryResult.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ count()

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

Returns the number of objects in the result

Returns
integer The number of matching objects

Definition at line 111 of file QueryResult.php.

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

◆ current()

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

Definition at line 185 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()

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

Returns the first object in the result set

Returns
object

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 89 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(), and TYPO3\CMS\Extbase\Persistence\Generic\QueryResult\getQuery().

◆ getQuery()

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

Returns a clone of the query object

Returns

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 79 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

Returns
void

Definition at line 67 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()

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

Definition at line 194 of file QueryResult.php.

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

◆ next()

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

Definition at line 203 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
Returns
boolean
See also
ArrayAccess::offsetExists()

Definition at line 141 of file QueryResult.php.

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

◆ offsetGet()

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::offsetGet (   $offset)
Parameters
mixed$offset
Returns
mixed
See also
ArrayAccess::offsetGet()

Definition at line 151 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
Returns
void
See also
ArrayAccess::offsetSet()

Definition at line 164 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
Returns
void
See also
ArrayAccess::offsetUnset()

Definition at line 176 of file QueryResult.php.

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

◆ rewind()

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

Definition at line 212 of file QueryResult.php.

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

◆ toArray()

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

Returns an array with the objects in the result set

Returns
array

Implements TYPO3\CMS\Extbase\Persistence\QueryResultInterface.

Definition at line 128 of file QueryResult.php.

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

◆ valid()

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

Definition at line 221 of file QueryResult.php.

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

Member Data Documentation

◆ $dataMapper

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

Definition at line 29 of file QueryResult.php.

◆ $numberOfResults

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

Definition at line 40 of file QueryResult.php.

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

◆ $persistenceManager

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

Definition at line 35 of file QueryResult.php.

◆ $query

TYPO3\CMS\Extbase\Persistence\Generic\QueryResult::$query
protected

Definition at line 45 of file QueryResult.php.

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

◆ $queryResult

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

Definition at line 51 of file QueryResult.php.

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