Spec-Zone.ru › CakePHP 3.4

Класс ResultSet

Представляет результаты, полученные после выполнения запроса к определённой таблице. Этот объект отвечает за правильное вложение ключей результатов, полученных из запроса, приведение каждого поля к соответствующему типу и выполнение дополнительных запросов, необходимых для ленивой загрузки внешних ассоциаций.

Cake\ORM\ResultSet реализует Cake\Datasource\ResultSetInterface использует Cake\Collection\CollectionTrait
Пространство имён: Cake\ORM
Расположение: ORM/ResultSet.php

Краткое описание свойств

  • $_autoFields protected
    boolean
    Отслеживает значение свойства $_autoFields объекта $query, переданного в конструктор.
  • $_containMap protected
    array
    Список ассоциаций, которые должны быть загружены с немедленной подгрузкой.
  • $_count protected
    integer
    Содержит количество записей в этом наборе результатов
  • $_current protected
    array
    Последняя извлечённая запись из оператора
  • $_defaultAlias protected
    string
    Псевдоним таблицы по умолчанию
  • $_defaultTable protected
    Cake\ORM\Table
    Экземпляр таблицы по умолчанию
  • $_driver protected
    Cake\Database\Driver
    Объект драйвера базы данных.
  • $_entityClass protected
    string
    Полное пространство имён класса, используемого для гидратации результатов
  • $_hydrate protected
    boolean
    Необходимо ли гидратировать результаты в объекты
  • $_index protected
    integer
    Указывает на номер следующей записи, которая должна быть извлечена
  • $_map protected
    array

    Карта полей, извлечённых из оператора, с указанием их типа и таблицы, к которой они относятся

  • $_matchingMap protected
    array

    Список ассоциаций, которые должны быть размещены под ключом _matchingData результата.

  • $_matchingMapColumns protected
    array

    Список соответствующих ассоциаций и ключей столбцов, ожидаемых от каждой из них.

  • $_query protected
    Cake\ORM\Query
    Исходный запрос, из которого были сгенерированы результаты
  • $_results protected
    array|ArrayAccess
    Результаты, которые были извлечены или гидратированы в результаты.
  • $_statement protected
    Cake\Database\StatementInterface
    Оператор базы данных, содержащий результаты
  • $_types protected
    array
    Кэш типов для преобразователей типов.
  • $_useBuffering protected
    boolean
    Буферизовать ли извлекаемые из оператора результаты

Краткое описание методов

  • __construct() public
    Конструктор
  • __debugInfo() public

    Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

  • _calculateAssociationMap() protected

    Вычисляет список ассоциаций, которые должны быть загружены с немедленной подгрузкой при извлечении каждой записи

  • _calculateColumnMap() protected

    Создаёт карту ключей строк из запроса select, которая может использоваться для более быстрого гидратирования вложенных наборов результатов.

  • _calculateTypeMap() protected

    Создаёт карту классов преобразователей типов для каждого из столбцов, которые должен извлечь этот объект.

  • _castValues() protected

    Приводит все значения из строки, взятой из таблицы, к соответствующему типу PHP.

  • _fetchResult() protected

    Вспомогательная функция для извлечения следующего результата из оператора или из загруженных результатов.

  • _getTypes() protected

    Возвращает классы типа для каждого из переданных полей, принадлежащих таблице.

  • _groupResult() protected
    Правильно вкладывает ключи результатов, включая те, которые получены из ассоциаций
  • count() public
    Возвращает количество строк в наборе результатов.
  • current() public
    Возвращает текущую запись в итераторе результата
  • first() public
    Получить первую запись из набора результатов.
  • key() public
    Возвращает ключ текущей записи в итераторе
  • next() public
    Перемещает указатель итератора к следующей записи
  • rewind() public
    Перематывает ResultSet.
  • serialize() public
    Сериализует ResultSet.
  • unserialize() public
    Десериализует ResultSet.
  • 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( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

_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

_calculateTypeMap( )

Создаёт карту классов преобразователей типов для каждого из столбцов, которые должен извлечь этот объект.

Устарело

3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператора
END_OF_DOCUMENT_MARKER

_castValues()source protected

_castValues( string $alias , array $values )

Преобразует все значения из строки, полученной из таблицы, в соответствующий тип PHP.

Устаревший

3.2.0 Больше не используется. Преобразование типов выполняется на уровне оператора

Параметры

строка $alias
Псевдоним объекта таблицы
массив $values
Значения для преобразования

Возвращает

массив

_fetchResult()source protected

_fetchResult( )

Вспомогательная функция для извлечения следующего результата из оператора или из заданных результатов.

Возвращает

смешанный тип

_getTypes()source protected

_getTypes( Cake\ORM\Table $table , array $fields )

Возвращает классы типов для каждого из переданных полей, принадлежащих таблице.

Параметры

Cake\ORM\Table $table
Таблица, из которой нужно получить схему
массив $fields
Список полей для использования в схеме.

Возвращает

массив

_groupResult()source protected

_groupResult( mixed $row )

Правильно вложенные ключи результатов, включая те, которые поступают из ассоциаций.

Параметры

смешанный тип $row
Массив, содержащий столбцы и значения, или ложь, если результатов нет

Возвращает

массив
Результаты

count()source public

count( )

Возвращает количество строк в наборе результатов.

Часть интерфейса Countable.

Возвращает

целое число

Реализация

Countable::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.

Возвращает

булево значение

Реализация

Iterator::valid()

Методы, используемые из Cake\Collection\CollectionTrait

_unwrap()source public

_unwrap( )

append()source public

append( $items )

avg()source public

avg( $matcher null )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

cartesianProduct()source public

cartesianProduct( callable $operation null , callable $filter null )

Возвращает

Cake\Collection\CollectionInterface

chunk()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\FilterIterator
END_OF_DOCUMENT_MARKER

firstMatch()source public

firstMatch( array $conditions )

groupBy()source public

groupBy( $callback )

indexBy()source public

indexBy( $callback )

insert()source public

insert( $path , $values )

Возвращает

Cake\Collection\Iterator\InsertIterator

isEmpty()source public

isEmpty( )

jsonSerialize()source public

jsonSerialize( )

last()source public

last( )

listNested()source public

listNested( $dir 'desc' , $nestingKey 'children' )

Возвращает

Cake\Collection\Iterator\TreeIterator

map()source public

map( callable $c )

Возвращает

Cake\Collection\Iterator\ReplaceIterator

match()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' )

optimizeUnwrap()source protected

optimizeUnwrap( )

Распаковывает этот итератор и возвращает самый простой перебираемый объект, который может использоваться для извлечения данных.

Возвращает

Перебираемый объект|массив

reduce()source public

reduce( callable $c , $zero null )

reject()source public

reject( callable $c )

Возвращает

Cake\Collection\Iterator\FilterIterator

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\StoppableIterator

sumOf()source public

sumOf( $matcher null )

take()source public

take( $size 1 , $from 0 )

through()source public

through( callable $handler )

toArray()source public

toArray( $preserveKeys true )

toList()source public

toList( )

transpose()source public

transpose( )

Возвращает

Cake\Collection\CollectionInterface

unfold()source public

unfold( callable $transformer null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

Подробное описание свойств

$_autoFieldssource

protected boolean

Отслеживает значение свойства $_autoFields объекта $query, переданного в конструктор.

$_containMapsource

protected array

Список ассоциаций, которые должны быть загружены с помощью eager loading.

[]
END_OF_DOCUMENT_MARKER

$_countsource

protected целое число

Содержит количество записей в этом наборе результатов

$_currentsource

protected массив

Последняя извлечённая запись из оператора

$_defaultAliassource

protected строка

По умолчанию псевдоним таблицы

$_defaultTablesource

protected Cake\ORM\Table

Экземпляр таблицы по умолчанию

$_driversource

protected Cake\Database\Driver

Объект драйвера базы данных.

Кэшируется в свойстве, чтобы избежать многократных вызовов одной и той же функции.

$_entityClasssource

protected строка

Полное с пространством имён имя класса для гидратации результатов

$_hydratesource

protected логическое значение

Нужно ли гидратировать результаты в объекты

true

$_indexsource

protected целое число

Указывает номер следующей записи, которую нужно извлечь

$_mapsource

protected массив

Карта полей, извлечённых из оператора, с их типом и таблицей, к которой они относятся

[]

$_matchingMapsource

protected массив

Список ассоциаций, которые должны быть размещены под ключом _matchingData результата.

[]

$_matchingMapColumnssource

protected массив

Список сопоставляемых ассоциаций и ключевых столбцов, ожидаемых от каждой из них.

[]

$_querysource

protected Cake\ORM\Query

Исходный запрос, из которого были сгенерированы результаты

Устарело

3.1.6 Из-за утечки памяти это свойство больше нельзя использовать

$_resultssource

protected массив|ArrayAccess

Результаты, которые были извлечены или гидратированы в результаты.

[]

$_statementsource

protected Cake\Database\StatementInterface

Оператор базы данных, содержащий результаты

$_typessource

protected массив

Кэш типов для преобразователей типов.

Преобразователи индексируются по псевдониму и имени столбца.

[]

$_useBufferingsource

protected логическое значение

Буферизовать ли результаты, извлечённые из оператора

true

© 2005–2017 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.4/class-Cake.ORM.ResultSet.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API