Документация для разработчиков
Темная тема

Класс CDBResult

Описание и свойства класса

CDBResult - класс результата выполнения запроса.

Содержит в себе методы для постраничной навигации и работы с результатом запроса. Автоматически создаётся как результат работы метода CDatabase::Query.

Свойства класса

Свойство Описание
result Дескриптор результата.
arResult Результат в виде массива (доступен только после CDBResult::NavStart). Данное свойство содержит неформатированные данные, например, дата для свойства типа "дата/время" элемента инфоблока. Для работы с объектом рекомендуется использовать CDBresult::Fetch, CDBresult::GetNext.
NavRecordCount Количество записей (доступен только после CDBResult::NavStart).
NavPageCount Количество страниц (доступен только после CDBResult::NavStart).
NavPageNomer Номер текущей страницы постраничной навигации (доступен только после NavStart).
NavPageSize Размер страницы (доступен только после CDBResult::NavStart).
bFirstPrintNavРавен "true" если метод CDBResult::NavPrint был вызван один раз (доступен только после CDBResult::NavStart).
bShowAll Разрешено ли показывать ссылку "Все" в постраничной навигации ("true"|"false") (доступен только после CDBResult::NavStart).
NavShowAll Равен "true", если в данный момент показываются все записи выборки, а не постранично (т.е. была нажата ссылка "Все") (доступен только после CDBResult::NavStart).
NavNum Порядковый номер постраничной навигации использованной на данной странице (доступен только после CDBResult::NavStart).
nStartPage Равен "true", если в данный момент открыта первая страница в постраничной навигации (доступен только после CDBResult::NavStart).
nEndPage Равен "true", если в данный момент открыта последняя страница в постраничной навигации (доступен только после CDBResult::NavStart).

Список методов

Методы класса

Метод Описание С версии
Fetch Делает выборку значений полей в массив.
NavNext Возвращает массив значений полей.3.0.10
NavPrint Выводит ссылки для постраничной навигации.3.0.10
NavStart Разбивает результат выборки на страницы.
NavStringForCache Возвращает уникальную строку идентифицирующую состояние постраничной навигации (номер текущей страницы, нажата ли ссылка "Все").3.2.1
IsNavPrint Определяет, все ли записи умещаются в одну страницу при постраничной навигации.3.0.10
GetNext Возвращает массив значений полей приведенный в HTML-безопасный вид.3.0.10
ExtractFields Создает глобальные переменные с именами соответствующими именам полей.3.0.10
FieldName Возвращает название поля по его номеру.
FieldsCount Возвращает количество полей результата выборки.
SelectedRowsCount Возвращает количество записей, которые вернул SELECT.
AffectedRowsCount Возвращает количество записей, измененных операцией INSERT, UPDATE или DELETE.
InitFromArray Инициализирует объект класса CDBResult значениями из массива.3.1.8
GetPageNavString 5.1.7
GetPageNavStringEx Возвращает панель постраничной навигации в HTML виде.6.0.2


© «Битрикс», 2001-2024, «1С-Битрикс», 2024