Spec-Zone.ru › CakePHP 3.2

Класс ResultSet

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

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

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

  • $_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( )

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

Возвращает

массив

_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 Больше не используется. Преобразование типов выполняется на уровне оператора

_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( )

Перематывает ResultSet.

Часть интерфейса 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( )

Обработчик обратной совместимости для unwrap()

Устарело

Возвращает

Iterator

append()source public

append( $items )

buffered()source public

buffered( )

Возвращает

Cake\Collection\Iterator\BufferedIterator

chunk()source public

chunk( $chunkSize )

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

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 )

min()source public

min( $callback , $type SORT_NUMERIC )

nest()source public

nest( $idPath , $parentPath )

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

unfold()source public

unfold( callable $transformer null )

unwrap()source public

unwrap( )

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

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

$_containMapsource

protected массив

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

[]

$_countsource

protected целое число

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

$_currentsource

protected массив

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

$_defaultAliassource

protected строка

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

$_defaultTablesource

protected Cake\ORM\Table

Таблица по умолчанию

$_driversource

protected Cake\Database\Driver

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

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

$_entityClasssource

protected строка

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

END_OF_DOCUMENT_MARKER

$_hydratesource

protected boolean

Выполнять ли гидрацию результатов в объекты

true

$_indexsource

protected integer

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

$_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

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

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

[]

$_useBufferingsource

protected boolean

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

true

© 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.2/class-Cake.ORM.ResultSet.html

Spec-Zone.ru

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