Функции модуля (__call)


НАЧАЛО >> Оглавление >> Описание модулей системы >> Database - Управление базами данных >> Функции модуля (__call)


Функции могут быть вызваны как UseModule("Database")->function(parameter1,parameter2,...);

Имя функцииОписаниеПараметры
CheckUnavailНе описаны
CloseНе описаны
DeleteDbFileНе описаны
DeleteRecНе описаны
DeleteRecBySrcНе описаны
DoFLCФормально-логический контроль
Подробнее... 
Функция исполняет формат, результат которого формализован и представляет собой результат формально-логического контроля (ФЛК) записи. Информация возвращается в виде массива array(retCode=>int,msgs=>array(code=>int,msg=>string)), где
  • retCode - Тип самой жесткой ошибки (порядок "жесткости" исторически сложился как 0,2,1)
  • msgs - массив сообщений об ошибках
  • code - код ошибка
  • msg - текстовое сообщение об ошибке

Форматы для ФЛК используются следующим образом:

  • форматированию подвергается контролируемый документ;
  • первый символ результата форматирования определяет результат ФЛК, а именно:
    • 0 - означает положительный результат контроля;
    • 1 - означает отрицательный результат и обнаруженные ошибки считаются непреодолимыми, т.е. подлежат обязательному устранению;
    • 2 - означает отрицательный результат, но при этом ошибки счита-ются преодолимыми, т.е. их можно не исправлять.
  • остальной результат форматирования (начиная со второго символа) в случае отрицательного контроля выдается пользователю в качестве сообщения.

ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
ObjectData$rОбязательныйЗапись
String$flcname''Имя формата формально-логического контроля
String$flcformat''ФЛК в формате ИРБИС64
DoGblForListНе описаны
DoGblForSearchНе описаны
EmptyНе описаны
FindFirstRecordПервая запись из поиска
Подробнее... 
Вызвает функцию поиска записей в провадере данных. Возвращает первую запись (объект типа Record), из соответствующих поисковому выражению Expression или код ошибки ИРБИС.
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
FindMfnListнайти список MFN
Подробнее... 
Вызвает функцию поиска записей в провадере данных. Возвращает массив, в котором элемент 0 содержит число найденых записей или код ошибки, а каждый следующий -- MFN записей из БД. Если и поисковое выражение и фильтр последовательного поиска пусты, число найденых будет равно максимальному MFN базы
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
String$SortByОбязательныйимя srw-файла, для сортировки результатов поиска
bool$AscSortDirtrueнарпавление сортировки, если false, результаты будут в обратном порядке
bool$UseCacheInSearchfalseиспользовать ли кэш при поиске? По-умолчанию выключен
String$FTExpressionОбязательныйвыражение на естественном языке для полнотекстового поиска
FindRecordsПоиск записей
Подробнее... 
Вызвает функцию поиска записей в провадере данных. Возвращает массив, в котором элемент 0 содержит число найденых записей или код ошибки, а каждый следующий -- объект типа Record. Если и поисковое выражение и фильтр последовательного поиска пусты, вернет NumMfn записей со смещением FirstMfn от первого MFN в базе, а число найденых будет равно максимальному MFN базы
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
integer$NumMfn0число возвращаемых записей, если 0, то вернет максимально возможное количество
integer$FirstMfn0смещение относительно начала списка найденых записей, если 0, вернет только число найденых записей
integer$Min0левая граница последовательного поиска
integer$Max0парвая граница последовательного поиска
String$SortByОбязательныйимя srw-файла, для сортировки результатов поиска
bool$AscSortDirtrueнарпавление сортировки, если false, результаты будут в обратном порядке
bool$UseCacheInSearchfalseиспользовать ли кэш при поиске? По-умолчанию выключен
String$FTExpressionОбязательныйвыражение на естественном языке для полнотекстового поиска
FindRecordsAndDoНе описаны
FindRecordsClearResultНе описаны
FindRecordsCountКоличество результатов поиска
Подробнее... 
Вызвает функцию поиска записей в провадере данных. Возвращает колличество записей, соответствующих поисковому выражению Expression и/или фильтру Sequence или код ошибки.
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
integer$Min0левая граница последовательного поиска
integer$Max0парвая граница последовательного поиска
FindRecordsGroupByНе описаны
FindRecordsSortByНе описаны
FindRecordsSortResultНе описаны
ForEachRecordНе описаны
Format128Не описаны
FullTextSearchПолнотекстовый поиск, команды "R" и "$" TCP/IP сервера
Подробнее... 
Вызвает функцию полнотекстового поиска в провадере данных. Возвращает массив, в котором элемент 0 содержит число найденых записей или код ошибки, элемент "records" -- массив вида
array("rec"=>Object, "fmt"=>String)
, где rec -- обект типа Record, а fmt -- результат форматирования, а элемент "ResponseList" -- список mfn_FullTextDB страниц для соответствующей по номеру записи в "records" в остальном поведение не отличается от метода SearchSrv
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
integer$NumMfn0число возвращаемых записей, если 0, то вернет максимально возможное количество
integer$FirstMfn0смещение относительно начала списка найденых записей, если 0, вернет только число найденых записей
integer$Min0левая граница последовательного поиска
integer$Max0парвая граница последовательного поиска
bool$Morphology0переключение морфологии и усечения при поиске
string$FTSPrefix'K='префикс для поиска ключевых слов по словаряю
integer$MaxWordDistance-1максимальное расстояние между словами, если -1 или пустая строка - то не работает
bool$search_plus1переключение между старым и новым типами поиска, по-умолчанию новый
GBLRecordНе описаны
GetBackLinkedНе описаны
GetDataiMnuНе описаны
GetDescriptionНе описаны
GetDirectContextПолучить ресурс БД
Подробнее... 
Возвращает контекст базы данных. Необоходима для использования функций php_irbis64.dll за пределами модуля провадйера
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
GetFasetsНе описаны
GetFileНе описаны
GetFileListНе описаны
GetIniНе описаны
GetIniValueНе описаны
GetLastFlcНе описаны
GetMaxMfnНе описаны
GetMfnPostingListНе описаны
GetMnuНе описаны
GetMnuDescByKeyНе описаны
GetNameНе описаны
GetNewНе описаны
GetPostingListНе описаны
GetProviderНе описаны
GetProviderVersionНе описаны
GetSearchConfigНе описаны
GetTermListНе описаны
GetTermListAllНе описаны
GetTermRefsНе описаны
GetWsНе описаны
GetWsOptНе описаны
HandleGBLНе описаны
ImportFromFileНе описаны
IndexНе описаны
IsReadOnlyНе описаны
IsUnavailНе описаны
NoopНе описаны
OpenНе описаны
PreparePrefSortподготовка кэша MFN для сортировки
Подробнее... 
Вызвает функцию кэширования MFN из словаря для терминов с указанным префиксом. Возвращяет результат выполнения file_put_contents() для файла кэша. Работает только с провайдером DP_Irbis64Direct
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$PrefОбязательныйпрефикс терминов для кэширования
PrintПолучить выходную форму
Подробнее... 
ТипПараметрПо умолчаниюОписание
String$Expression''Поисковое выражение на языке ISIS
String$Sequence''Выражение для последовательного поиска
Number$Start0Начальная запись. Если 0 то начиная с 1-й записи
Number$Count0Количество записей. Если 0, то до конца выборки
String$TabName''Мнемоническое имя выходной формы
String$FmtHeader''Формат заголовка
String$ModelField''Значение модельного поля 991 в виде ^Aтекст^Bтекст. Повторения поля разделяются парой символов #31#30
Number$Min0Начальный MFN. Если 0 то начиная с 1 го.
Number$Max0Конечный MFN. Если 0 то заканчивая последним.
Array$MfnListarray ( )Список отмеченных MFN. Если указан то используется именно он. Иначе используются результаты поиска.
Number$Flag0Режим отбора данных: 0 - поиск, > 0 список отмеченных, < 0 кроме отмеченных
QuickSyncНе описаны
RecFormatНе описаны
RecFormatMfnНе описаны
RecFormatMfnRangeНе описаны
RecIfUpdateНе описаны
RecIfUpdateAllНе описаны
RecReadЧтение записи
Подробнее... 
Вызвает функцию чтения одной записи по ее номеру в провадере данных. Возвращает объект типа Record или NULL, в случае ошибки чтения. Опционально, возможна блокировка запси на ввод
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
integer$mfnОбязательныйMFN, номер записи в БД
String$lockfalseфлаг блокировки
RecReadAndFormatЧтение записи с форматированием
Подробнее... 
Вызвает функцию чтения одной записи по ее номеру в провадере данных. Возвращает результат форматирования или код ошибки чтения. Опционально, возможна блокировка записи на ввод
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
integer$mfnОбязательныйMFN, номер записи в БД
String$lockОбязательныйфлаг блокировки
RecReadBackЧтение предыдущих версий записи
Подробнее... 
Вызвает функцию чтения одной записи по ее номеру в провадере данных. Возвращает объект типа Record или NULL, в случае ошибки чтения. Если третий параметр не задан, будет прочитана предыдущая версия
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
integer$mfnОбязательныйMFN, номер записи в БД
integer$back1число шагов назад по версиям
RecReadIntellectНе описаны
RecReadSrvЧтение и расформатирование одной записи, команда "C" TCP/IP сервера
Подробнее... 
Вызвает функцию чтения и расформатирования одной записи по ее номеру в провадере данных. Возвращает NULL или массив, содержащий запись в виде обекта (rec), код ошибки чтения (rec_result), код ошибки результат расформатирования (fmt_result) и результат расформатирования (fmt). Параметры lock и back исключают друг друга
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
integer$mfnОбязательныйMFN, номер записи в БД
bool$lockfalseфлаг блокировки
integer$back0число шагов назад по версиям
String$formatОбязательныйформат
RecVirtualFormatНе описаны
RecreateIndexНе описаны
SaveAndUpdateRecordНе описаны
SearchПоиск записей
Подробнее... 
Вызвает функцию поиска в провадере данных. Возвращает массив, в котором элемент 0 содержит число найденых записей, каждый следующий -- результат форматирования. Если и поисковое выражение и фильтр последовательного поиска пусты, вернет NumMfn записей со смещением FirstMfn от первого MFN в базе, а число найденых будет равно максимальному MFN базы
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
integer$NumMfn0число возвращаемых записей, если 0, то вернет максимально возможное количество
integer$FirstMfn0смещение относительно начала списка найденых записей, если 0, вернет только число найденых записей
integer$Min0левая граница последовательного поиска
integer$Max0парвая граница последовательного поиска
String$SortByОбязательныйимя srw-файла, для сортировки результатов поиска
bool$AscSortDirtrueнарпавление сортировки, если false, результаты будут в обратном порядке
bool$UseCacheInSearchfalseиспользовать ли кэш при поиске? По-умолчанию выключен
SearchSrvПоиск, команда "K" TCP/IP сервера
Подробнее... 
Вызвает функцию поиска записей в провадере данных. Возвращает массив, в котором элемент 0 содержит число найденых записей или код ошибки, а каждый следующий -- массив вида
array("rec"=>Object, "fmt"=>String)
, где rec -- обект типа Record, а fmt -- результат форматирования Если и поисковое выражение и фильтр последовательного поиска пусты, вернет NumMfn записей со смещением FirstMfn от первого MFN в базе, а число найденых будет равно максимальному MFN базы
ТипПараметрПо умолчаниюОписание
ObjectData$dbОбязательныйБД
String$ExpressionОбязательныйпоисковое выражение на языке ИРБИС
string$SequenceОбязательныйстрока на языке форматирования, условие последовательного поиска
integer$NumMfn0число возвращаемых записей, если 0, то вернет максимально возможное количество
integer$FirstMfn0смещение относительно начала списка найденых записей, если 0, вернет только число найденых записей
integer$Min0левая граница последовательного поиска
integer$Max0парвая граница последовательного поиска
String$SortByОбязательныйимя srw-файла, для сортировки результатов поиска
bool$AscSortDirtrueнарпавление сортировки, если false, результаты будут в обратном порядке
bool$UseCacheInSearchfalseиспользовать ли кэш при поиске? По-умолчанию выключен
SetArmIniНе описаны
SetDbFileНе описаны
SetDbFileMultyНе описаны
SetDbNamesLabelНе описаны
SetDescriptionНе описаны
SetNameНе описаны
SetProviderНе описаны
SetReadOnlyНе описаны
SetUnavalНе описаны
SetupModuleConfigureНе описаны
StatПолучить форму статистики
Подробнее... 
ТипПараметрПо умолчаниюОписание
String$Expression''Поисковое выражение на языке ISIS
String$Sequence''Выражение для последовательного поиска
Number$Start0Начальная запись. Если 0 то начиная с 1-й записи
Number$Count0Количество записей. Если 0, то до конца выборки
String$Stat''Список параметров расчета статистики в виде плоского текста
Number$Min0Начальный MFN. Если 0 то начиная с 1 го.
Number$Max0Конечный MFN. Если 0 то заканчивая последним.
Array$MfnListarray ( )Список отмеченных MFN. Если указан то используется именно он. Иначе используются результаты поиска.
Number$Flag0Режим отбора данных: 0 - поиск, > 0 список отмеченных, < 0 кроме отмеченных