Открыть поиск
Открыть меню
Платформа Эра. Документация
Toggle preferences menu
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

Компоненты работы с данными: различия между версиями

Материал из Платформа Эра. Документации
Дополнительные действия
Следующая правка →
ВизуальныйВики-текст
Новая страница: « Предыдущая статья курса: Базовые компоненты и логика построения сценариев Следующая статья курса: Запуск служебных сценариев Предыдущая статья курса: Базовые компоненты и логика построения сценариев Категория:Курс "Разработка приложени...»
 
Нет описания правки
Строка 1: Строка 1:
  Предыдущая статья курса: [[Базовые компоненты и логика построения сценариев]]
  Предыдущая статья курса: [[Базовые компоненты и логика построения сценариев]]


= Общая информация =
Для выполнения работы с данными и осуществления сложных операций, в платформе Эра предусмотрен специальный набор компонентов служебных сценариев.
Данные компоненты не связанны друг с другом и реализуют различные механизмы взаимодействия с модулями системы и внешними системами.
Все компоненты, помимо специфических параметров также содержат общие параметры и параметры сохранения результата, описанные в [[Базовые компоненты и логика построения сценариев|предыдущей статье курса]].
= Описания компонентов =
=== Файловая операция ===
[[Файл:Компонент Файловая операция.png|центр|безрамки|534x534пкс]]
Производит указанную операцию ввода-вывода на диске. Работает с файлами, каталогами, путями.
{| class="wikitable"
|+Свойства компонента
!Свойство
!Описание
|-
|<code>Тип объекта</code>
|Определяет тип объекта, над которым производится файловая операция.
Возможные значения:
* <code>Путь</code> (<code>path</code>,<code>1</code>) – Операции со строковым представлением пути.
* <code>Файл</code> (<code>file</code>,<code>2</code>) – Операции с файлами.
* <code>Каталог</code> (<code>folder</code>,<code>3</code>) – Операции с каталогами.
* <code>Содержимое файла</code> (<code>content</code>,<code>4</code>) – Операции с содержимым файла.
|-
|<code>Операция</code>
|Операция со строковым представлением пути.
Возможные значения:
* <code>Тип пути</code> (<code>getPathType</code>, <code>101</code>) – Возвращает категорию каталога по указанному пути.
* <code>Относительный путь</code> (<code>getRelativePath</code>, <code>102</code>) – Возвращает относительный путь, вырезая из него категорию.
* <code>Имя файла</code> (<code>getFileName</code>, <code>103</code>) – Возвращает имя файла из указанного пути.
* <code>Расширение</code> (<code>getFileExtension</code>, <code>104</code>) – Возвращает расширение файла из указанного пути.
* <code>Каталог</code> (<code>getFileDirectory</code>, <code>105</code>) – Возвращает имя каталога из указанного пути.
* <code>Построить путь</code> (<code>makePath</code>, <code>106</code>) – Возвращает путь, собранный из категории каталога и относительного пути, доступный для использования в других операциях и компонентах.
* <code>Построить путь к файлу</code> (<code>makeFilePath</code>, <code>107</code>) – Возвращает путь к файлу, собранный из трех аргументов: пути, имени файла и расширения.
|-
|<code>Операция</code>
|Операция с файлом.
Возможные значения:
* <code>Удалить</code> (<code>deleteFile</code>, <code>201</code>) – Удаляет файл.
* <code>Скопировать</code> (<code>copyFile</code>, <code>202</code>) – Копирует файл.
* <code>Переместить</code> (<code>moveFile</code>, <code>203</code>) – Перемещает файл в другой каталог.
* <code>Проверить наличие</code> (<code>fileExists</code>, <code>205</code>) – Возвращает <code>1</code>, если файл существует, иначе <code>0</code>.
* <code>Размер</code> (<code>getFileSize</code>, <code>206</code>) – Возвращает размер файла.
* <code>Хеш содержимого</code> (<code>getFileHash</code>, <code>207</code>) – Возвращает хеш содержимого файла.
* <code>Создать путь</code> (<code>ensureFolder</code>, <code>208</code>) – Создает каталог для файла по указанному пути, если он не существует.
* <code>Преобразовать в tiff</code> (<code>fileToFaxTiff</code>, <code>209</code>) – Преобразует файл в tiff, с параметрами подходящими для компонента Отправка факса  Поддерживаемые форматы для преобразования в tiff: bmp, jpg, pdf, png, tiff.
|-
|<code>Операция</code>
|Операция с каталогом.
Возможные значения:
* <code>Создать</code> (<code>makeFolder</code>, <code>301</code>) – Создает каталог, если он не существует.
* <code>Удалить</code> (<code>deleteFolder</code>, <code>302</code>) – Удаляет каталог.
* <code>Скопировать</code> (<code>copyFolder</code>, <code>303</code>) – Копирует каталог со всем содержимым.
* <code>Переместить</code> (<code>moveFolder</code>, <code>304</code>) – Перемещает каталог со всем содержимым в другой каталог.
* <code>Проверить наличие</code> (<code>folderExists</code>, <code>306</code>) – Возвращает <code>1</code>, если каталог существует, иначе <code>0</code>.
* <code>Количество файлов</code> (<code>getFolderFileCount</code>, <code>307</code>) – Возвращает количество файлов в каталоге на первом уровне.
* <code>Количество подкаталогов</code> (<code>getFolderSubfolderCount</code>, <code>308</code>) – Возвращает количество подкаталогов на первом уровне.
|-
|<code>Операция</code>
|Операция с содержимым файла.
Возможные значения:
* <code>Создать файл</code> (<code>createFile</code>, <code>401</code>) – Создает новый файл с указанным содержимым.
* <code>Записать файл</code> (<code>writeFile</code>, <code>402</code>) – Записывает новое содержимое в существующий файл.
* <code>Дописать в конец файла</code> (<code>appendFile</code>, <code>403</code>) – Добавляет содержимое в конец файла.
* <code>Считать файл</code> (<code>readFile</code>, <code>404</code>) – Возвращает содержимое файла.
Все операции с содержимым используют указанную кодировку для преобразования из строки в бинарный вид.
|-
|<code>Путь</code>
|Аргумент, содержащий путь.
|-
|<code>Отрезать расширение</code>
|Переключатель режима возврата файла без расширения.
|-
|<code>Категория каталога</code>
|Категория каталога, с использованием которой путь становится доступным для применения в операциях ввода-вывода.
Возможные значения:
* <code>SYNC_COMMON</code> (<code>1</code>) – Каталог общих данных всех доменов в синхронизирующемся между серверами каталоге.
* <code>SYNC_DOMAIN_COMMON</code> (<code>2</code>) – Каталог общих данных домена в синхронизирующемся между серверами каталоге.
* <code>SYNC_DOMAIN_DATA</code> (<code>3</code>) – Каталог данных домена в синхронизирующемся между серверами каталоге.
* <code>SYNC_SCRIPT_DATA</code> (<code>4</code>) – Каталог данных сценария в синхронизирующемся между серверами.
* <code>SITESHARE_PUBLIC</code> (<code>5</code>) – Каталог общих данных на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>SITESHARE_DOMAIN_DATA</code> (<code>6</code>) – Каталог данных домена на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>SITESHARE_SCRIPT_DATA</code> (<code>7</code>) – Каталог данных сценария на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
* <code>GLOBALSHARE_PUBLIC</code> (<code>8</code>) – Каталог общих данных на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>GLOBALSHARE_DOMAIN_DATA</code> (<code>9</code>) – Каталог данных домена на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>GLOBALSHARE_SCRIPT_DATA</code> (<code>10</code>) – Каталог данных сценария на сетевом диске глобального хранилища, доступного всем сайтам.
* <code>TEMP</code> (<code>11</code>) – Временный каталог текущего обработчика сценария. Удаляется через 5 секунд после его завершения.
|-
|<code>Относительный путь</code>
|Аргумент, содержащий относительный путь.
|-
|<code>Имя файла</code>
|Аргумент, содержащий название файла.
|-
|<code>Расширение</code>
|Аргумент, содержащий расширение файла.
|-
|<code>Путь источника</code>
|Аргумент, содержащий путь источника.
|-
|<code>Путь назначения</code>
|Аргумент, содержащий путь назначения.
|-
|<code>Хеш-функция</code>
|Хеш-функция для применения к содержимому файла.
|-
|<code>Содержимое</code>
|Аргумент с содержимым файла.
|-
|<code>Кодировка</code>
|Кодировка для применения к содержимому файла при считывании в переменную и наоборот.
Возможные значения:
* <code>Авто</code> (<code>1</code>) – Автоматическое определение.
* <code>Бинарные данные</code> (<code>binary</code>, <code>2</code>) – Считывание бинарных данных без преобразования.
* <code>utf-8</code> (<code>3</code>)
* <code>utf-16</code> (<code>4</code>)
* <code>utf-32</code> (<code>5</code>)
* <code>cp1251</code> (<code>6</code>) – Кодовая страница <code>windows-1251</code> (кириллица).
* <code>Указать название</code> (<code>byname</code>, <code>7</code>) – Указание имени кодировки.
|-
|<code>BOM</code>
|Режим считывания содержания файла с учетом префикса кодировки для UTF.
Возможные варианты:
* <code>С BOM</code> (<code>withBOM</code>, <code>1</code>).
* <code>Без BOM</code> (<code>withoutBOM</code>, <code>2</code>).
|-
|<code>Endian</code>
|Режим раскладки кодировки unicode.
Возможные варианты:
* <code>Little-Endian</code> (<code>littleEndian</code>, <code>1</code>).
* <code>Big-Endian</code> (<code>bigEndian</code>, <code>2</code>).
|-
|<code>Название кодировки</code>
|Аргумент, содержащий имя применяемой кодировки.
|}




Версия от 10:08, 24 февраля 2025

Предыдущая статья курса: Базовые компоненты и логика построения сценариев

Общая информация

Для выполнения работы с данными и осуществления сложных операций, в платформе Эра предусмотрен специальный набор компонентов служебных сценариев.

Данные компоненты не связанны друг с другом и реализуют различные механизмы взаимодействия с модулями системы и внешними системами.

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

Описания компонентов

Файловая операция

Производит указанную операцию ввода-вывода на диске. Работает с файлами, каталогами, путями.

Свойства компонента
Свойство Описание
Тип объекта Определяет тип объекта, над которым производится файловая операция.

Возможные значения:

  • Путь (path,1) – Операции со строковым представлением пути.
  • Файл (file,2) – Операции с файлами.
  • Каталог (folder,3) – Операции с каталогами.
  • Содержимое файла (content,4) – Операции с содержимым файла.
Операция Операция со строковым представлением пути.

Возможные значения:

  • Тип пути (getPathType, 101) – Возвращает категорию каталога по указанному пути.
  • Относительный путь (getRelativePath, 102) – Возвращает относительный путь, вырезая из него категорию.
  • Имя файла (getFileName, 103) – Возвращает имя файла из указанного пути.
  • Расширение (getFileExtension, 104) – Возвращает расширение файла из указанного пути.
  • Каталог (getFileDirectory, 105) – Возвращает имя каталога из указанного пути.
  • Построить путь (makePath, 106) – Возвращает путь, собранный из категории каталога и относительного пути, доступный для использования в других операциях и компонентах.
  • Построить путь к файлу (makeFilePath, 107) – Возвращает путь к файлу, собранный из трех аргументов: пути, имени файла и расширения.
Операция Операция с файлом.

Возможные значения:

  • Удалить (deleteFile, 201) – Удаляет файл.
  • Скопировать (copyFile, 202) – Копирует файл.
  • Переместить (moveFile, 203) – Перемещает файл в другой каталог.
  • Проверить наличие (fileExists, 205) – Возвращает 1, если файл существует, иначе 0.
  • Размер (getFileSize, 206) – Возвращает размер файла.
  • Хеш содержимого (getFileHash, 207) – Возвращает хеш содержимого файла.
  • Создать путь (ensureFolder, 208) – Создает каталог для файла по указанному пути, если он не существует.
  • Преобразовать в tiff (fileToFaxTiff, 209) – Преобразует файл в tiff, с параметрами подходящими для компонента Отправка факса Поддерживаемые форматы для преобразования в tiff: bmp, jpg, pdf, png, tiff.
Операция Операция с каталогом.

Возможные значения:

  • Создать (makeFolder, 301) – Создает каталог, если он не существует.
  • Удалить (deleteFolder, 302) – Удаляет каталог.
  • Скопировать (copyFolder, 303) – Копирует каталог со всем содержимым.
  • Переместить (moveFolder, 304) – Перемещает каталог со всем содержимым в другой каталог.
  • Проверить наличие (folderExists, 306) – Возвращает 1, если каталог существует, иначе 0.
  • Количество файлов (getFolderFileCount, 307) – Возвращает количество файлов в каталоге на первом уровне.
  • Количество подкаталогов (getFolderSubfolderCount, 308) – Возвращает количество подкаталогов на первом уровне.
Операция Операция с содержимым файла.

Возможные значения:

  • Создать файл (createFile, 401) – Создает новый файл с указанным содержимым.
  • Записать файл (writeFile, 402) – Записывает новое содержимое в существующий файл.
  • Дописать в конец файла (appendFile, 403) – Добавляет содержимое в конец файла.
  • Считать файл (readFile, 404) – Возвращает содержимое файла.

Все операции с содержимым используют указанную кодировку для преобразования из строки в бинарный вид.

Путь Аргумент, содержащий путь.
Отрезать расширение Переключатель режима возврата файла без расширения.
Категория каталога Категория каталога, с использованием которой путь становится доступным для применения в операциях ввода-вывода.

Возможные значения:

  • SYNC_COMMON (1) – Каталог общих данных всех доменов в синхронизирующемся между серверами каталоге.
  • SYNC_DOMAIN_COMMON (2) – Каталог общих данных домена в синхронизирующемся между серверами каталоге.
  • SYNC_DOMAIN_DATA (3) – Каталог данных домена в синхронизирующемся между серверами каталоге.
  • SYNC_SCRIPT_DATA (4) – Каталог данных сценария в синхронизирующемся между серверами.
  • SITESHARE_PUBLIC (5) – Каталог общих данных на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
  • SITESHARE_DOMAIN_DATA (6) – Каталог данных домена на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
  • SITESHARE_SCRIPT_DATA (7) – Каталог данных сценария на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
  • GLOBALSHARE_PUBLIC (8) – Каталог общих данных на сетевом диске глобального хранилища, доступного всем сайтам.
  • GLOBALSHARE_DOMAIN_DATA (9) – Каталог данных домена на сетевом диске глобального хранилища, доступного всем сайтам.
  • GLOBALSHARE_SCRIPT_DATA (10) – Каталог данных сценария на сетевом диске глобального хранилища, доступного всем сайтам.
  • TEMP (11) – Временный каталог текущего обработчика сценария. Удаляется через 5 секунд после его завершения.
Относительный путь Аргумент, содержащий относительный путь.
Имя файла Аргумент, содержащий название файла.
Расширение Аргумент, содержащий расширение файла.
Путь источника Аргумент, содержащий путь источника.
Путь назначения Аргумент, содержащий путь назначения.
Хеш-функция Хеш-функция для применения к содержимому файла.
Содержимое Аргумент с содержимым файла.
Кодировка Кодировка для применения к содержимому файла при считывании в переменную и наоборот.

Возможные значения:

  • Авто (1) – Автоматическое определение.
  • Бинарные данные (binary, 2) – Считывание бинарных данных без преобразования.
  • utf-8 (3)
  • utf-16 (4)
  • utf-32 (5)
  • cp1251 (6) – Кодовая страница windows-1251 (кириллица).
  • Указать название (byname, 7) – Указание имени кодировки.
BOM Режим считывания содержания файла с учетом префикса кодировки для UTF.

Возможные варианты:

  • С BOM (withBOM, 1).
  • Без BOM (withoutBOM, 2).
Endian Режим раскладки кодировки unicode.

Возможные варианты:

  • Little-Endian (littleEndian, 1).
  • Big-Endian (bigEndian, 2).
Название кодировки Аргумент, содержащий имя применяемой кодировки. 


Следующая статья курса: Запуск служебных сценариев

Предыдущая статья курса: Базовые компоненты и логика построения сценариев
Источник — http://wiki.era-platform.ru/index.php?title=Компоненты_работы_с_данными&oldid=965