Класс ResultSet
Представляет результаты, полученные после выполнения запроса к определённой таблице. Этот объект отвечает за правильное вложение ключей результатов, полученных из запроса, приведение каждого поля к соответствующему типу и выполнение дополнительных запросов, необходимых для ленивой загрузки внешних ассоциаций.
- Cake\ORM\ResultSet реализует Cake\Datasource\ResultSetInterface использует Cake\Collection\CollectionTrait
Подробное описание методов
__constructsource public
__construct( Cake\ORM\Query $query , Cake\Database\StatementInterface $statement )
Конструктор
Параметры
-
Cake\ORM\Query$query - Запрос, из которого берутся результаты
-
Cake\Database\StatementInterface$statement - Запрос для получения данных
__debugInfosource public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
arrayмассив
_calculateAssociationMapsource protected
_calculateAssociationMap( Cake\ORM\Query $query )
Вычисляет список ассоциаций, которые должны быть загружены при извлечении каждого записей.
Параметры
-
Cake\ORM\Query$query - Запрос, из которого следует извлечь ассоциации
_calculateColumnMapsource protected
_calculateColumnMap( Cake\ORM\Query $query )
Создаёт карту ключей строк из запроса select-фрагмента, которая может использоваться для более быстрого гидратирования вложенных наборов результатов.
Параметры
-
Cake\ORM\Query$query - Запрос, из которого следует извлечь карту столбцов
_calculateTypeMapsource protected
_calculateTypeMap( )
Создаёт карту классов конвертеров типов для каждого из столбцов, которые должны быть извлечены этим объектом.
_castValuessource protected
_castValues( string $alias , array $values )
Приводит все значения из строки, взятой из таблицы, к правильному типу PHP.
Параметры
- строка
$alias - Псевдоним объекта таблицы
- массив
$values - Значения для приведения к типу
Возвращает
arrayмассив
_fetchResultsource protected
_fetchResult( )
Вспомогательная функция для извлечения следующего результата из запроса или заданных результатов.
Возвращает
mixedсмешанный тип
_getTypessource protected
_getTypes( Cake\ORM\Table $table , array $fields )
Возвращает классы типов для каждого из переданных полей, относящихся к таблице.
Параметры
-
Cake\ORM\Table$table - Таблица, из схемы которой необходимо получить типы
- массив
$fields - Список полей для использования в схеме.
Возвращает
arrayмассив
_groupResultsource protected
_groupResult( mixed $row )
Правильно вкладывает ключи результатов, включая те, которые получены из ассоциаций.
Параметры
- смешанный тип
$row - Массив, содержащий столбцы и значения, или ложь, если результатов нет
Возвращает
arrayРезультаты
countsource public
count( )
Возвращает количество строк в наборе результатов.
Часть интерфейса Countable.
Возвращает
integerцелое число
currentsource public
current( )
Возвращает текущую запись в итераторе результатов.
Часть интерфейса Iterator.
Возвращает
array|objectмассив или объект
firstsource public
first( )
Получить первую запись из набора результатов.
Этот метод также закроет курсор подлежащего оператора.
Возвращает
array|objectмассив или объект
Реализация
Cake\Collection\CollectionInterface::first() keysource public
key( )
Возвращает ключ текущей записи в итераторе.
Часть интерфейса Iterator.
Возвращает
integerцелое число
nextsource public
next( )
Передвигает указатель итератора к следующей записи.
Часть интерфейса Iterator.
rewindsource public
rewind( )
Перемотка набора результатов.
Часть интерфейса Iterator.
Исключения
Cake\Database\Exception\Cake\Database\Исключение
serializesource public
serialize( )
Сериализация набора результатов.
Часть интерфейса Serializable.
Возвращает
stringСериализованный объект
unserializesource public
unserialize( string $serialized )
Десериализация набора результатов.
Часть интерфейса Serializable.
Параметры
- строка
$serialized - Сериализованный объект
validsource public
valid( )
Есть ли ещё результаты для извлечения из итератора?
Часть интерфейса Iterator.
Возвращает
booleanлогическое значение
Методы, используемые из Cake\Collection\CollectionTrait
_unwrapsource public
_unwrap( )
Обратный совместимый оболочка для unwrap()
Устарело
Возвращает
Iterator\Iterator
bufferedsource public
buffered( )
Возвращает
Cake\Collection\Iterator\BufferedIterator\Cake\Collection\Iterator\BufferedIterator
Реализация
Cake\Collection\CollectionInterface::buffered() chunksource public
chunk( mixed $chunkSize )
Реализация
Cake\Collection\CollectionInterface::chunk() combinesource public
combine( mixed $keyPath , mixed $valuePath , mixed $groupPath null )
Реализация
Cake\Collection\CollectionInterface::combine() compilesource public
compile( mixed $preserveKeys true )
Реализация
Cake\Collection\CollectionInterface::compile() containssource public
contains( mixed $value )
Реализация
Cake\Collection\CollectionInterface::contains() countBysource public
countBy( mixed $callback )
Реализация
Cake\Collection\CollectionInterface::countBy() extractsource public
extract( mixed $matcher )
Реализация
Cake\Collection\CollectionInterface::extract() filtersource public
filter( callable $c null )
Возвращает
Cake\Collection\Iterator\FilterIterator\Cake\Collection\Iterator\FilterIterator
Реализация
Cake\Collection\CollectionInterface::filter() firstMatchsource public
firstMatch( array $conditions )
Реализация
Cake\Collection\CollectionInterface::firstMatch() groupBysource public
groupBy( mixed $callback )
Реализация
Cake\Collection\CollectionInterface::groupBy() indexBysource public
indexBy( mixed $callback )
Реализация
Cake\Collection\CollectionInterface::indexBy() insertsource public
insert( mixed $path , mixed $values )
Возвращает
Cake\Collection\Iterator\InsertIterator\Cake\Collection\Iterator\InsertIterator
Реализация
Cake\Collection\CollectionInterface::insert() jsonSerializesource public
jsonSerialize( )
Реализация
Cake\Collection\CollectionInterface::jsonSerialize() listNestedsource public
listNested( mixed $dir 'desc' , mixed $nestingKey 'children' )
Возвращает
Cake\Collection\Iterator\TreeIterator\Cake\Collection\Iterator\TreeIterator
Реализация
Cake\Collection\CollectionInterface::listNested() mapsource public
map( callable $c )
Возвращает
Cake\Collection\Iterator\ReplaceIterator\Cake\Collection\Iterator\ReplaceIterator
Реализация
Cake\Collection\CollectionInterface::map() matchsource public
match( array $conditions )
Реализация
Cake\Collection\CollectionInterface::match() maxsource public
max( mixed $callback , mixed $type SORT_NUMERIC )
Реализация
Cake\Collection\CollectionInterface::max() minsource public
min( mixed $callback , mixed $type SORT_NUMERIC )
Реализация
Cake\Collection\CollectionInterface::min() nestsource public
nest( mixed $idPath , mixed $parentPath )
Реализация
Cake\Collection\CollectionInterface::nest() reducesource public
reduce( callable $c , mixed $zero null )
Реализация
Cake\Collection\CollectionInterface::reduce() rejectsource public
reject( callable $c )
Возвращает
Cake\Collection\Iterator\FilterIterator\Cake\Collection\Iterator\FilterIterator
Реализация
Cake\Collection\CollectionInterface::reject() samplesource public
sample( mixed $size 10 )
Реализация
Cake\Collection\CollectionInterface::sample() sortBysource public
sortBy( mixed $callback , mixed $dir SORT_DESC , mixed $type SORT_NUMERIC )
Реализация
Cake\Collection\CollectionInterface::sortBy() stopWhensource public
stopWhen( mixed $condition )
Возвращает
Cake\Collection\Iterator\StoppableIterator\Cake\Collection\Iterator\StoppableIterator
Реализация
Cake\Collection\CollectionInterface::stopWhen() sumOfsource public
sumOf( mixed $matcher null )
Реализация
Cake\Collection\CollectionInterface::sumOf() takesource public
take( mixed $size 1 , mixed $from 0 )
Реализация
Cake\Collection\CollectionInterface::take() throughsource public
through( callable $handler )
Реализация
Cake\Collection\CollectionInterface::through() toArraysource public
toArray( mixed $preserveKeys true )
Реализация
Cake\Collection\CollectionInterface::toArray() unfoldsource public
unfold( callable $transformer null )
Реализация
Cake\Collection\CollectionInterface::unfold() zipWithsource public
zipWith( mixed $items , mixed $callable )
Реализация
Cake\Collection\CollectionInterface::zipWith() Методы, используемые из Cake\Collection\ExtractTrait
_createMatcherFiltersource protected
_createMatcherFilter( array $conditions )
Возвращает вызываемый объект, который получает значение и возвращает, соответствует ли оно определённому условию.
Параметры
- массив
$conditions - Список пар «ключ-значение» условий для сопоставления, где ключ — путь к свойству для получения из текущего элемента, а значение — значение, с которым сравнивается элемент.
Возвращает
callableвызываемый объект
_extractsource protected
_extract( array|ArrayAccess $data , array $path )
Возвращает столбец из $data, который можно извлечь, итерируя по именам столбцов, содержащихся в $path. Возвращает массивы для элементов, представленных с помощью {*}
Параметры
- массив или ArrayAccess
$data - Данные.
- массив
$path - Путь для извлечения.
Возвращает
mixedсмешанный тип
_propertyExtractorsource protected
_propertyExtractor( string|callable $callback )
Возвращает вызываемый объект, который можно использовать для извлечения свойства или столбца из массива или объекта на основе пути, разделённого точками.
Параметры
- строка или вызываемый объект
$callback - Путь к столбцу, разделённый точками, для следования, чтобы можно было вернуть последний, или вызываемый объект, который позаботится об этом.
Возвращает
callableвызываемый объект
_simpleExtractsource protected
_simpleExtract( array|ArrayAccess $data , array $path )
Возвращает столбец из $data, который можно извлечь, итерируя по именам столбцов, содержащихся в $path
Параметры
- массив или ArrayAccess
$data - Данные.
- массив
$path - Путь для извлечения.
Возвращает
mixedсмешанный тип
Краткое описание свойств
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.ORM.ResultSet.html