Класс ResultSet
Представляет результаты, полученные после выполнения запроса к определённой таблице. Этот объект отвечает за правильное вложение ключей результатов, полученных из запроса, преобразование каждого поля к соответствующему типу и выполнение дополнительных запросов, необходимых для ленивой загрузки внешних ассоциаций.
- Cake\ORM\ResultSet реализует Cake\Datasource\ResultSetInterface использует Cake\Collection\CollectionTrait
Краткое описание свойств
-
$_autoFieldsprotectedОтслеживает значение свойства $_autoFields объекта $query, переданного в конструктор.boolean -
$_containMapprotectedСписок ассоциаций, которые должны быть загружены лениво.array -
$_countprotectedСодержит количество записей в этом наборе результатов.integer -
$_currentprotectedПоследняя запись, извлечённая из оператора.array -
$_defaultAliasprotectedПсевдоним таблицы по умолчанию.string - Экземпляр таблицы по умолчанию.
$_defaultTableprotected - Объект драйвера базы данных.
$_driverprotected -
$_entityClassprotectedПолное имя пространства имён класса, используемого для гидратации результатов.string -
$_hydrateprotectedНеобходимо ли гидратировать результаты в объекты.boolean -
$_indexprotectedУказатель на следующий номер записи, который должен быть извлечён.integer -
$_mapprotectedarrayОтображение полей, извлечённых из оператора, с указанием их типа и таблицы, к которой они относятся.
-
$_matchingMapprotectedarrayСписок ассоциаций, которые должны быть размещены под ключом
_matchingDataрезультата. -
$_matchingMapColumnsprotectedarrayСписок соответствующих ассоциаций и ключей столбцов, ожидаемых от каждой из них.
- Исходный запрос, из которого были получены результаты.
$_queryprotected -
$_resultsprotectedРезультаты, которые были извлечены или гидратированы в результаты.array|ArrayAccess - Оператор базы данных, содержащий результаты.
$_statementprotected -
$_typesprotectedКэш типов для преобразователей типов.array -
$_useBufferingprotectedБуферизовать ли результаты, извлечённые из оператора.boolean
Краткое описание методов
- __construct() publicКонструктор
- __debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
- _calculateAssociationMap() protected
Вычисляет список ассоциаций, которые должны быть загружены лениво при извлечении каждой записи.
- _calculateColumnMap() protected
Создаёт отображение ключей строк из запроса select, которое можно использовать для более быстрого гидратирования вложенных наборов результатов.
-
Создаёт отображение классов преобразователей типов для каждого из столбцов, которые должен извлечь этот объект.
-
Преобразует все значения из строки, полученной из таблицы, к соответствующему типу PHP.
- _fetchResult() protected
Вспомогательная функция для извлечения следующего результата из оператора или засеянных результатов.
-
Возвращает классы типов для каждого из переданных полей, относящихся к таблице.
- _groupResult() protectedПравильно вкладывает ключи результатов, включая те, которые поступают от ассоциаций.
- count() publicВозвращает количество строк в наборе результатов.
- current() publicВозвращает текущую запись в итераторе набора результатов.
- first() publicПолучить первую запись из набора результатов.
- key() publicВозвращает ключ текущей записи в итераторе.
- next() publicПеремещает указатель итератора к следующей записи.
- rewind() publicПерематывает набор результатов.
- serialize() publicСериализует набор результатов.
- unserialize() publicДесериализует набор результатов.
- valid() publicЕсть ли ещё результаты для извлечения из итератора.
Подробное описание методов
__construct()source public
__construct( Cake\ORM\Query $query , Cake\Database\StatementInterface $statement )
Конструктор
Параметры
-
Cake\ORM\Query$query - Запрос, из которого поступают результаты
-
Cake\Database\StatementInterface$statement - Оператор для извлечения данных
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращаемое значение
массив_calculateAssociationMap()source protected
_calculateAssociationMap( Cake\ORM\Query $query )
Вычисляет список ассоциаций, которые должны быть загружены лениво при извлечении каждой записи
Параметры
-
Cake\ORM\Query$query - Запрос, из которого следует извлечь ассоциации
_calculateColumnMap()source protected
_calculateColumnMap( Cake\ORM\Query $query )
Создаёт отображение ключей строк из запроса select, которое можно использовать для более быстрого гидратирования вложенных наборов результатов.
Параметры
-
Cake\ORM\Query$query - Запрос, из которого следует извлечь отображение столбцов
_calculateTypeMap()source protected deprecated
_calculateTypeMap( )
Создаёт отображение классов преобразователей типов для каждого из столбцов, которые должен извлечь этот объект.
Устарело
3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператора_castValues()source protected deprecated
_castValues( string $alias , array $values )
Преобразует все значения из строки, полученной из таблицы, в соответствующий тип PHP.
Устарело
3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператораПараметры
- строка
$alias - Псевдоним объекта таблицы
- массив
$values - Значения для преобразования
Возвращает
массив_fetchResult()source protected
_fetchResult( )
Вспомогательная функция для извлечения следующего результата из оператора или посеянных результатов.
Возвращает
mixed_getTypes()source protected deprecated
_getTypes( Cake\ORM\Table $table , array $fields )
Возвращает классы типов для каждого из переданных полей, принадлежащих таблице.
Устарело
3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператораПараметры
-
Cake\ORM\Table$table - Таблица, из которой нужно получить схему
- массив
$fields - Список полей для использования в схеме.
Возвращает
массив_groupResult()source protected
_groupResult( array $row )
Правильно вложенные ключи результатов, включая те, которые поступают из ассоциаций.
Параметры
- массив
$row - Массив, содержащий столбцы и значения, или false, если результатов нет
Возвращает
массивРезультаты
count()source public
count( )
Возвращает количество строк в наборе результатов.
Часть интерфейса Countable.
Возвращает
целое числоРеализация
Cake\Collection\CollectionInterface::count() current()source public
current( )
Возвращает текущую запись в итераторе результата.
Часть интерфейса Iterator.
Возвращает
массив|объектРеализация
Iterator::current() first()source public
first( )
Получение первой записи из набора результатов.
Этот метод также закроет курсор базового оператора.
Возвращает
массив|объектРеализация
Cake\Collection\CollectionInterface::first() key()source public
key( )
Возвращает ключ текущей записи в итераторе.
Часть интерфейса Iterator.
Возвращает
целое числоРеализация
Iterator::key() next()source public
next( )
Перемещает указатель итератора к следующей записи.
Часть интерфейса Iterator.
Реализация
Iterator::next() rewind()source public
rewind( )
Перемотка набора результатов.
Часть интерфейса Iterator.
Исключения
Cake\Database\ExceptionРеализация
Iterator::rewind() serialize()source public
serialize( )
Сериализация набора результатов.
Часть интерфейса Serializable.
Возвращает
строкаСериализованный объект
Реализация
Serializable::serialize() unserialize()source public
unserialize( string $serialized )
Десериализация набора результатов.
Часть интерфейса Serializable.
Параметры
- строка
$serialized - Сериализованный объект
Реализация
Serializable::unserialize() valid()source public
valid( )
Есть ли еще результаты для извлечения из итератора
Часть интерфейса Iterator.
Возвращает
booleanРеализация
Iterator::valid() Методы, используемые из Cake\Collection\CollectionTrait
_unwrap()source public
_unwrap( )
append()source public
append( $items )
appendItem()source public
appendItem( $item , $key = null )
avg()source public
avg( $matcher = null )
cartesianProduct()source public
cartesianProduct( callable $operation = null , callable $filter = null )
Параметры
- вызываемый
$operationнеобязательно null - Операция
- вызываемый
$filterнеобязательно null - Фильтр
Возвращает
Cake\Collection\CollectionInterfaceИсключения
LogicExceptionchunk()source public
chunk( $chunkSize )
chunkWithKeys()source public
chunkWithKeys( $chunkSize , $preserveKeys = true )
combine()source public
combine( $keyPath , $valuePath , $groupPath = null )
compile()source public
compile( $preserveKeys = true )
contains()source public
contains( $value )
countBy()source public
countBy( $callback )
each()source public
each( callable $c )
every()source public
every( callable $c )
extract()source public
extract( $matcher )
filter()source public
filter( callable $c = null )
Возвращает
Cake\Collection\Iterator\FilterIteratorfirstMatch()source public
firstMatch( array $conditions )
groupBy()source public
groupBy( $callback )
indexBy()source public
indexBy( $callback )
isEmpty()source public
isEmpty( )
jsonSerialize()source public
jsonSerialize( )
last()source public
last( )
lazy()source public
lazy( )
listNested()source public
listNested( $dir = 'desc' , $nestingKey = 'children' )
Возвращает
Cake\Collection\Iterator\TreeIteratormatch()source public
match( array $conditions )
max()source public
max( $callback , $type = \SORT_NUMERIC )
median()source public
median( $matcher = null )
min()source public
min( $callback , $type = \SORT_NUMERIC )
nest()source public
nest( $idPath , $parentPath , $nestingKey = 'children' )
newCollection()source protected
newCollection( ... $args )
Возвращает новую коллекцию.
Позволяет классам, использующим этот трайт, определять собственный тип возвращаемого интерфейса коллекции
Параметры
- ...
$args - $args Аргументы конструктора.
Возвращает
Cake\Collection\CollectionInterfaceoptimizeUnwrap()source protected
optimizeUnwrap( )
Распаковывает этот итератор и возвращает самый простой итерируемый объект, который может быть использован для получения данных.
Возвращает
Итерируемый объект|массивprepend()source public
prepend( $items )
prependItem()source public
prependItem( $item , $key = null )
reduce()source public
reduce( callable $c , $zero = null )
sample()source public
sample( $size = 10 )
shuffle()source public
shuffle( )
skip()source public
skip( $howMany )
some()source public
some( callable $c )
sortBy()source public
sortBy( $callback , $dir = \SORT_DESC , $type = \SORT_NUMERIC )
stopWhen()source public
stopWhen( $condition )
Возвращает
Cake\Collection\Iterator\StoppableIteratorsumOf()source public
sumOf( $matcher = null )
take()source public
take( $size = 1 , $from = 0 )
takeLast()source public
takeLast( $howMany )
through()source public
through( callable $handler )
toArray()source public
toArray( $preserveKeys = true )
toList()source public
toList( )
transpose()source public
transpose( )
Возвращает
Cake\Collection\CollectionInterfaceИсключения
LogicExceptionunfold()source public
unfold( callable $transformer = null )
unwrap()source public
unwrap( )
zip()source public
zip( $items )
zipWith()source public
zipWith( $items , $callable )
Магические методы, унаследованные от Cake\Collection\CollectionInterface
cartesianProduct() |
Подробное описание свойств
$_autoFieldssource
protected boolean
Отслеживает значение свойства $_autoFields объекта $query, переданного в конструктор.
$_defaultTablesource
protected Cake\ORM\Table|Cake\Datasource\RepositoryInterface
Экземпляр таблицы по умолчанию.
$_driversource
protected Cake\Database\Driver
Объект драйвера базы данных.
Кэшируется в свойстве, чтобы избежать многократных вызовов одной и той же функции.
$_entityClasssource
protected string
Полное именованное имя класса, используемого для гидратации результатов.
$_mapsource
protected array
Карта полей, извлеченных из оператора, с их типом и таблицей, к которой они относятся.
[]
$_matchingMapsource
protected array
Список ассоциаций, которые должны быть размещены под ключом _matchingData результата.
[]
$_matchingMapColumnssource
protected array
Список соответствующих ассоциаций и ключей столбцов, которые следует ожидать от каждой из них.
[]
$_querysource
protected Cake\ORM\Query
Исходный запрос, из которого были сгенерированы результаты.
Устарело
3.1.6 Из-за утечки памяти это свойство больше использовать нельзя.$_resultssource
protected array|ArrayAccess
Результаты, которые были извлечены или гидратированы в результаты.
[]
$_statementsource
protected Cake\Database\StatementInterface
Оператор базы данных, содержащий результаты.
$_typessource
protected array
Кэш типа для преобразователей типа.
Преобразователи индексируются по псевдониму и имени столбца.
Устарело
3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператора.[]
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.ORM.ResultSet.html