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

НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> FT - Электронная библиотека >> Функции модуля (__call)📄 Скачать в DOCX

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

Имя функции	Описание	Параметры
AppendFromFile	Функция добавляет файл в ЭБ и прописывает на него ссылку в ЭК Подробнее...  Создает запись FT из исходного файла и при необходимости связывает ее с библиографической записью.	Тип Параметр По умолчанию Описание Database $db '' БД в которой находится запись на издание Record $r '' Запись на издание String $fname '' Путь к файлу для добавления String $sourceText '' Текстовое описание полного текста (для ссылки) String $docType '' Тип документа. Если указано, то это значение будет записано в соответствующее 951^H
ConvertDOCToPDF	Функция конвертирует исходный документ полного текста в формате DOC в формат PDF/A. Подробнее...  Преобразует документ Word, прикрепленный к записи FT, в PDF для просмотра.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ConvertPPTToPDF	Функция конвертирует исходный документ полного текста в формате PPT в формат PDF/A. Подробнее...  Преобразует документ PowerPoint, прикрепленный к записи FT, в PDF для просмотра.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ConvertXLSToPDF	Функция конвертирует исходный документ полного текста в формате XLS в формат PDF/A. Подробнее...  Преобразует документ Excel, прикрепленный к записи FT, в PDF для просмотра.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
CreateCoverFromImage	Функция гтовит файлы обложек из изображения-источника Подробнее...  Создает изображения обложки из исходного изображения, прикрепленного к записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT String $sourcename '' Имя файла (Jpeg) из которого будут сделаны обложки
DetectEncode	Функция пытается определить кодировку переданного текста и при необходимости сконвертировать его в кодировку UTF-8 Подробнее...  Определяет и нормализует кодировку текста для обработки в FT.	Тип Параметр По умолчанию Описание String $text '' Текст для преобразования в кодировку UTF-8
ExtractOneImageFromPDF	FT::ExtractOneImageFromPDF(): извлечение страницы PDF в изображение Подробнее...  Преобразует выбранную страницу PDF в отдельный файл изображения; поддерживает PNG, JPG, GIF и BMP, а также ограничение ширины и высоты результата.	Тип Параметр По умолчанию Описание string $pdfPath '' Путь к исходному PDF-файлу string $resultPath '' Путь к результирующему файлу изображения int $pageNo '1' Номер страницы PDF для извлечения; нумерация начинается с 1 string $resultFormat 'png' Формат результирующего изображения: png, jpg, gif или bmp int $maxWidth '0' Максимальная ширина изображения в пикселях; 0 - не ограничивать int $maxHeight '0' Максимальная высота изображения в пикселях; 0 - не ограничивать
ExtractText	Извлечение текста из документа Подробнее...  Извлекает текст для поиска из PDF, офисных и текстовых файлов.	Тип Параметр По умолчанию Описание i $f 'l' e t $s 'r' i $ '' u $F 'l' l
FFmpegAudioConvert	Конвертация аудио через FFmpeg Подробнее...  Запускает синхронную или асинхронную конвертацию аудио через FFmpeg.	Тип Параметр По умолчанию Описание string $inputFile '' Исходный аудиофайл string $outputFile '' Целевой аудиофайл FFmpegAudioOptions $options 'null' Параметры конвертации аудио boolean $async 'false' Запустить конвертацию асинхронно integer $pid 'null' Выходной идентификатор процесса для асинхронного режима string $logFile '' Необязательный файл журнала FFmpeg
FFmpegVideoConvert	Конвертация видео через FFmpeg Подробнее...  Запускает синхронную или асинхронную конвертацию видео через FFmpeg.	Тип Параметр По умолчанию Описание string $inputFile '' Исходный видеофайл string $outputFile '' Целевой видеофайл FFmpegVideoOptions $options 'null' Параметры конвертации видео boolean $async 'false' Запустить конвертацию асинхронно integer $pid 'null' Выходной идентификатор процесса для асинхронного режима string $logFile '' Необязательный файл журнала FFmpeg
GetCatDbByFT	Функция возвращает базу данных (объект типа Database) в которой содержится запись электронного каталога для указанной записи на полный текст либо null в случае возникновения шибки Подробнее...  Возвращает имя каталожной базы данных, связанной с записью FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
GetCatRecordByFT	Функция возвращает запись (объект типа Record) электронного каталога для указанной записи на полный текст либо null в случае возникновения шибки Подробнее...  Возвращает каталожную запись, связанную с записью FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
GetConvertedPdf	Функция скачивает. При соответствующих настройках проставляет отметку о книговыдаче для читателя Подробнее...  Отправляет преобразованный PDF для записи FT и при включенной настройке фиксирует статистику просмотра.	Отсутствуют
GetFFMPEG	Функция возвращает объект FFMpeg Подробнее...  Возвращает экземпляр FFmpeg или конфигурацию исполняемых файлов для обработки медиа в FT.	Отсутствуют
GetFFMPEGCfg	Функция возвращает объект конфигурации FFMpeg Подробнее...  Возвращает пути к FFmpeg/FFprobe и параметры запуска по умолчанию.	Отсутствуют
GetFFMPEGProbe	Функция возвращает объект FFProbe Подробнее...  Возвращает доступ к FFprobe для анализа метаданных медиафайлов.	Отсутствуют
GetPossibleResolutionsV	Функция возвращает массив доступных разрешений видео Подробнее...  Возвращает возможные разрешения видео для конвертации в FT.	Отсутствуют
GetSourceVideoDimension	Функция возвращает разрешение видео для записи полного текста Подробнее...  Считывает размеры исходного видео, прикрепленного к записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
Manage		Не описаны
MarkdownToDocx	Конвертация Markdown в DOCX Подробнее...  Преобразует Markdown-текст в DOCX через Pandoc с необязательным шаблоном и путем ресурсов.	Тип Параметр По умолчанию Описание string $markdownText '' Исходный текст Markdown string $referenceDocFile '' Необязательный DOCX-шаблон string $outputDocxFile '' Целевой DOCX-файл PandocOptions $options 'null' Параметры Pandoc string $fromFormat 'markdown' Формат входного Markdown string $resourcePath '' Путь поиска ресурсов и изображений
PandocConvert	Запуск конвертации Pandoc Подробнее...  Преобразует файл между документными форматами с помощью поставляемого Pandoc.	Тип Параметр По умолчанию Описание string $inputFile '' Исходный файл string $outputFile '' Целевой файл string $fromFormat '' Необязательный исходный формат string $toFormat '' Необязательный целевой формат PandocOptions $options 'null' Параметры Pandoc
PrepareViewer	Функция запускает подготовку вьювера в соответствии с типом документа Подробнее...  Подготавливает запись FT к просмотру в соответствии с типом документа.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerAudio	Функция ставит задачи на подготовку файлов для вьювера аудиодокументов Подробнее...  Подготавливает аудиофайлы записи FT для воспроизведения в браузере.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerBinary	Функция запускает подготовку вьювера для бинарного документа Подробнее...  Подготавливает бинарные файлы записи FT для скачивания или просмотра.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerImage	Функция запускает подготовку вьювера для изображения Подробнее...  Подготавливает изображения, обложки и варианты просмотра для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerNI	Функция запускает подготовку вьювера в соответствии с типом документа Подробнее...  Помечает запись FT как не требующую подготовки просмотрщика.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerPaged	Функция запускает подготовку вьювера для многостраничного документа Подробнее...  Подготавливает постраничные документы для просмотра по страницам.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerPagedNI	Функция запускает подготовку вьювера для многостраничного документа Подробнее...  Подготавливает постраничные документы без извлечения изображений, если конвертация не требуется.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
PrepareViewerVideo	Функция ставит задачи на подготовку файлов для вьювера видеодокументов Подробнее...  Подготавливает видеофайлы записи FT для воспроизведения в браузере.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
SearchInText	Поиск в тексте FT Подробнее...  Ищет по извлеченному тексту страниц и возвращает фрагменты с подсветкой найденного.	Тип Параметр По умолчанию Описание string|array $query '' Поисковый запрос или список запросов string $sid '' SID записи FT
SendYandexRequest	Отправка запроса к API Яндекса Подробнее...  Отправляет авторизованный запрос к API распознавания речи Яндекса.	Тип Параметр По умолчанию Описание string $url '' URL запроса array $request 'null' Необязательное тело запроса
SetErr	Функция устанавливает сообщение об ошибке Подробнее...  Сохраняет сообщение об ошибке обработки FT.	Тип Параметр По умолчанию Описание String $msg '' Текст сообщения об ошибке
SetLanguage_ru	Загрузка русских языковых строк FT Подробнее...  Инициализирует русские локализованные строки модуля FT.	Не описаны
SetupModuleConfigure	Настройка модуля FT Подробнее...  Применяет права и действия настройки по умолчанию для модуля FT.	Тип Параметр По умолчанию Описание o $c 'u' n n $i 't' e $0 '' e $S 't' u
ShowFT	Функция выбирает соответствующий просмотрщик и запускает его. При соответствующих настройках проставляет отметку о книговыдаче для читателя Подробнее...  Отображает запись FT через просмотрщик, выбранный по типу документа.	Отсутствуют
ShowFTAudio	Функция отображает просмотр аудиодокумента Подробнее...  Отображает аудиопросмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTBinary	Функция отображает просмотр бинарного документа Подробнее...  Отображает блок просмотра или скачивания бинарного файла записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTImage	Функция отображает просмотр изображения Подробнее...  Отображает просмотрщик изображений для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTPaged	Показ постраничного просмотрщика FT Подробнее...  Отображает настроенный постраничный просмотрщик документа для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTPagedGUNBKK	Функция отображает просмотр многостраничного документа на мобильных устройствах Подробнее...  Отображает постраничный просмотрщик GUNBKK для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTPagedMobile	Функция отображает просмотр многостраничного документа на мобильных устройствах Подробнее...  Отображает мобильный постраничный просмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTPagedStPageFlip	Функция отображает просмотр многостраничного документа на мобильных устройствах Подробнее...  Отображает постраничный просмотрщик StPageFlip для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTPagedVanila	Просмотр полного текста Подробнее...  Отображает стандартный постраничный просмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTProcessing	Функция отображает информацию о том что обработка документа еще не завершена Подробнее...  Отображает состояние обработки записи FT, которая еще подготавливается.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTVideo	Функция отображает просмотр видеодокумента Подробнее...  Отображает видеопросмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTVideoMobile	Функция отображает просмотр видеодокумента на мобильном устройстве Подробнее...  Отображает мобильный видеопросмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
ShowFTVideoVanila	Vanilla-видеопросмотрщик на Bootstrap 5 Подробнее...  Отображает стандартный видеопросмотрщик для записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись типа FT
TranscribeByGoogle	Транскрибация аудио через Google Подробнее...  Запускает распознавание речи Google для аудиофайла, прикрепленного к записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись FT string $filein '' Имя входного аудио sid-файла
TranscribeByWhisperLocal	Транскрибация аудио через локальный Whisper Подробнее...  Запускает локальную транскрибацию Whisper для аудио- или видеофайла, прикрепленного к записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись FT string $filein '' Имя входного sid-файла
TranscribeByYandex	Транскрибация аудио через Яндекс Подробнее...  Запускает распознавание речи Яндекса для аудиофайла, прикрепленного к записи FT.	Тип Параметр По умолчанию Описание Record $r '' Запись FT string $filein '' Имя входного аудио sid-файла