Spec-Zone.ru › CakePHP 3.6

Класс 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|Cake\Datasource\RepositoryInterface
    Экземпляр таблицы по умолчанию.
  • $_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

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

  • _calculateTypeMap() protected deprecated

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

  • _castValues() protected deprecated

    Приводит все значения из строки, извлечённой из таблицы, к правильному типу 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 )

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

Параметры

Cake\ORM\Query $query
Запрос, откуда извлечь карту столбцов

_calculateTypeMap()source protected deprecated

_calculateTypeMap( )

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

Устарело

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

_castValues()source protected deprecated

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

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

Параметры

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

Возвращает

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

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

Перемотать 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( )

append()source public

append( $items )

appendItem()source public

appendItem( $item , $key = null )

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 )

countKeys()source public

countKeys( )

Возвращает

целое число

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 )

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

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

Возвращает

Traversable|array

prepend()source public

prepend( $items )

prependItem()source public

prependItem( $item , $key = null )

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

zip()source public

zip( $items )

zipWith()source public

zipWith( $items , $callable )

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

$_autoFieldssource

protected boolean

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

$_containMapsource

protected array

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

[]

$_countsource

protected integer

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

$_currentsource

protected array

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

$_defaultAliassource

protected string

Базовое имя таблицы.

$_defaultTablesource

protected Cake\ORM\Table|Cake\Datasource\RepositoryInterface

Базовый экземпляр таблицы.

$_driversource

protected Cake\Database\Driver

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

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

$_entityClasssource

protected string

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

$_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–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.6/class-Cake.ORM.ResultSet.html

Spec-Zone.ru

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