Skip to content

Commit

Permalink
Документация
Browse files Browse the repository at this point in the history
  • Loading branch information
nixel2007 committed Jan 12, 2025
1 parent f7322a6 commit 261bb56
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* <a href="#entity-read">Чтение и поиск объектов</a>
* <a href="#entity-complex-find">Поиск сущностей со сложными отборами</a>
* <a href="#entity-sort">Сортировка результатов</a>
* <a href="#entity-limit">Пропуск и смещение</a>
* <a href="#entity-delete">Удаление сущностей</a>
* <a href="#entity-active-record">Активная запись</a>
* <a href="#entity-repository">Работа через ХранилищеСущностей</a>
Expand Down Expand Up @@ -285,6 +286,28 @@
```

<a id="#entity-limit">

### Пропуск и смещение

```bsl
// Привычный Выбрать Первые Х реализуется через ОпцииПоиска
ОпцииПоиска = Новый ОпцииПоиска()
.Первые(10);
ПервыеДесятьФизлиц = МенеджерСущностей.Получить(Тип("ФизическоеЛицо"), ОпцииПоиска);
// При желании можно использовать поиск со смещением, например, для реализации постраничной загрузки.
// Всегда указывайте правила сортировки для повторяемости результата.
ОпцииПоиска = Новый ОпцииПоиска()
.Первые(10)
.Смещение(50)
.СортироватьПо("Идентификатор", НаправлениеСортировки.ПоВозрастанию);
ШестойДесятокФизлиц = МенеджерСущностей.Получить(Тип("ФизическоеЛицо"), ОпцииПоиска);
```

<a id="entity-delete" />

## Удаление сущностей
Expand Down
50 changes: 50 additions & 0 deletions docs/ОпцииПоиска.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,53 @@
Функция СортироватьПо(ИмяПоля, НаправлениеСортировки = Неопределено)
```

### ВыбираютсяПервые

```bsl
// Получить количество элементов, которые необходимо выбрать.
//
// Возвращаемое значение:
// Число - Количество элементов.
//
Функция ВыбираютсяПервые()
```

### Первые

```bsl
// Выбрать первые n элементов.
//
// Параметры:
// КоличествоЭлементов - Число - Количество элементов.
//
// Возвращаемое значение:
// ОпцииПоиска - Текущий объект.
//
Функция Первые(КоличествоЭлементов)
```

### ВыбираетсяСоСмещением

```bsl
// Получить количество элементов, которые необходимо пропустить.
//
// Возвращаемое значение:
// Число - Количество элементов.
//
Функция ВыбираетсяСоСмещением()
```

### Смещение

```bsl
// Сместить выборку на n элементов.
//
// Параметры:
// КоличествоЭлементов - Число - Количество элементов.
//
// Возвращаемое значение:
// ОпцииПоиска - Текущий объект.
//
Функция Смещение(КоличествоЭлементов)
```

26 changes: 26 additions & 0 deletions src/Классы/ОпцииПоиска.os
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,47 @@

КонецФункции

// Получить количество элементов, которые необходимо выбрать.
//
// Возвращаемое значение:
// Число - Количество элементов.
//
Функция ВыбираютсяПервые() Экспорт
Возврат Первые;
КонецФункции

// Выбрать первые n элементов.
//
// Параметры:
// КоличествоЭлементов - Число - Количество элементов.
//
// Возвращаемое значение:
// ОпцииПоиска - Текущий объект.
//
Функция Первые(КоличествоЭлементов) Экспорт

Первые = КоличествоЭлементов;

Возврат ЭтотОбъект;
КонецФункции

// Получить количество элементов, которые необходимо пропустить.
//
// Возвращаемое значение:
// Число - Количество элементов.
//
Функция ВыбираетсяСоСмещением() Экспорт
Возврат Смещение;
КонецФункции

// Сместить выборку на n элементов.
//
// Параметры:
// КоличествоЭлементов - Число - Количество элементов.
//
// Возвращаемое значение:
// ОпцииПоиска - Текущий объект.
//
Функция Смещение(КоличествоЭлементов) Экспорт

Смещение = КоличествоЭлементов;
Expand Down

0 comments on commit 261bb56

Please sign in to comment.