Функции

Селекты

select

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: select(table: ''; cycle: ; hash: ; field: ''; where: '' = ; order: '' asc)

Возвращает одно значение из поля field: таблицы table:.

Обязательные параметры

• table — name-параметр таблица, из которой берутся значения.

• field — name-параметр поле в таблице table:.

Необязательные параметры

• cycle — определяет цикл, если таблица table: является расчетной в цикле.

  • Может передаваться как одно или список чисел.
  • Параметр отсутствует, если таблица table: находится в дереве.

• hash — строка, hash таблицы для обращения к временной таблице.

• where — name-параметр условие выбора строки в строчной части. where: 'field' = value — левая часть определяет поле сравнения в таблице table:, а правая — значение сравнения.

  • Множественный параметр — если указано несколько параметров where:, то выборка осуществляется на пересечении их условий.
  • Параметр может отсутствовать, если поле не содержит строк (расположено вне строчной части таблицы). Если параметр отсутствует для выборки из поля строчной части, то результатом работы функции будет являться одно первое значение в соответствии с сортировкой, заданной в order:.
  • Возможны любые операторы сравнения.
  • Может передаваться как число, строка, дата или булевое значение
  • Может быть как одним значением, так и списком. В зависимости от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Если по условиям выбираются значения из нескольких строк, то результатом работы функции будет являться первое значение в соответствии с сортировкой, заданной в order:.
  • Если по условиям не выбирается ни одной строки, то результатом работы функции будет являться пустота.

Поля типов Селект (множественный), Селект-дерево (множественный) и Данные могут выбираться с оператором сравнения ==. В этом случае ищется полное совпадение, а не пересечение значения поля с заданным в where: значением. Поиск по содержимому поле Данные в простых таблицах может по-разному себя вести в зависимости от того, сохранено число-значение как строка или как число.

Если в were: передать значение *ALL*, то этот where: будет выключен! Это можно сделать через отдельную строку, например:

=: select(table: 'table_name'; field: 'field_name'; where: 'search_field' = $if)
if: if(condition: #connected_field = ""; then: "*ALL*"; else: #connected_field)

Список из одного значения ["*ALL*"] будет обработан так же как и "*ALL*".

• order — name-параметр поле в таблице table:, по которому будет осуществляться сортировка.

  • Множественный параметр — если указано несколько параметров order:, то сортировка будет осуществлена последовательно.
  • Если параметр отсутствует, то сортировка будет произведена в произвольном порядке.
  • asc — по возрастанию.
  • desc — по убыванию.

• sfield — name-параметр поле типа Селект или Селект-дерево, для которого нужно выбрать и вернуть отображаемое значение, а не основание. sfield используется вместо параметра field!

• tfield — множественный, name-параметр поле, использующееся для расчета значений селектов в запрошенных в sfield: полях.

• offset — число пропуск указанного количества элементов в порядке определенном в order:.

Пример:

orders (cycle_id: 1)

example: select(table: 'orders'; cycle: 1; field: 'id'; where: 'order_number' = 100)

// Результат: 3

selectList

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: selectList(table: ''; cycle: ; hash: ; field: ''; where: '' = ; order: '' asc)

Возвращает список значений из строк поля field: таблицы table: в соответствии с сортировкой заданной в order:.

Обязательные параметры

• table — name-параметр таблица, из которой берутся значения.

• field — name-параметр поле в таблице table:.

Необязательные параметры

• cycle — определяет цикл, если таблица table: является расчетной в цикле.

  • Может передаваться только как одно или список чисел.
  • Параметр отсутствует, если таблица table: находится в дереве

• hash — строка, hash таблицы для получения данных из временных таблиц.

• where — name-параметр условие выбора строки в строчной части. Левая часть определяет поле сравнения в таблице table:, а правая — значение сравнения.

  • Множественный параметр — если указано несколько параметров where:, то выборка осуществляется на пересечении их условий.
  • Выборка из полей вне строчной части невозможна.
  • Возможны любые операторы сравнения.
  • Может передаваться как число, строка, дата или булево значение.
  • Может быть как одним значением, так и списком. В зависимости от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Если по условиям выбираются значения только из одной строки, то результатом работы функции будет являться список с одним значением.
  • Если по условиям не выбирается ни одной стоки, то результатом работы функции будет являться пустой список.

Если в were: передать значение *ALL*, то этот where: будет выключен! Это можно сделать через отдельную строку, например:

=: selectList(table: 'table_name'; field: 'field_name'; where: 'search_field' = $if)
if: if(condition: #connected_field = ""; then: "*ALL*"; else: #connected_field)

Список из одного значения ["*ALL*"] будет обработан так же как и "*ALL*".

• order — name-параметр поле в таблице table:, по которому будет осуществляться сортировка.

  • Множественный параметр — если указано несколько параметров order:, то сортировка будет осуществлена последовательно.
  • Если параметр отсутствует, то сортировка будет произведена в произвольном порядке.
  • asc — по возрастанию
  • desc — по убыванию

• sfield — name-параметр поле типа Селект или Селект-дерево, для которого нужно выбрать и вернуть отображаемое значение, а не основание. sfield используется вместо параметра field!

• tfield — множественный, name-параметр поле, использующееся для расчета значений селектов в запрошенных в sfield: полях.

• limit — число, ограничивает список указанным количеством элементов.

  • Если передать в качестве значение параметра 0 или "", то он будет отключен!

• offset — число пропуск указанного количества элементов в соответствии с сортировкой order:.

Пример:

orders

example: selectlist(table: 'orders'; field: 'id'; where: 'order_number' >= 99)

// Результат: [2,3]

selectRowListForSelect

Доступен в секциях: Код селекта.

=: selectRowListForSelect(table: ''; cycle: ; bfield: 'id'; field: ''; order: '' asc; where: '' = ; section: ''; preview: '')

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

Обязательные параметры

• table — name-параметр таблица из которой берутся значения.

• field — name-параметр поле в таблице table: из которого берется отображение.

Необязательные параметры

• cycle — число, определяет цикл, если таблица table: является расчетной в цикле.

  • Может передаваться только как одно или список чисел.
  • Параметр отсутствует, если таблица table: находится в дереве.

• hash — строка, hash таблицы для получения данных из временных таблиц.

• where — name-параметр условие выбора строки в строчной части. Левая часть определяет поле сравнения в таблице table:, а правая — значение сравнения.

  • Множественный параметр — если указано несколько параметров where:, то выборка осуществляется на пересечении их условий, применяемых слева направо.
  • Выборка возможна только из строчной части таблицы.
  • Возможны любые операторы сравнения.
  • Может передаваться как число, строка, дата или булево значение
  • Может быть как одним значением, так и списком. В зависимости от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Если по условиям не выбирается ни одной строки, то результатом работы функции будет являться пустой список.

Если в were: передать значение *ALL*, то этот where: будет выключен! Это можно сделать через отдельную строку, например:

=: selectRowListForSelect(table: 'table_name'; field: 'field_name'; where: 'search_field' = $if)
if: if(condition: #connected_field = ""; then: "*ALL*"; else: #connected_field)

Список из одного значения ["*ALL*"] будет обработан так же как и "*ALL*".

• order — name-параметр поле в таблице table:, по которому будет осуществляться сортировка.

  • Множественный параметр — если указано несколько параметров order:, то сортировка будет осуществлена последовательно.
  • Если параметр отсутствует, то сортировка будет произведена в произвольном порядке.
  • asc — по возрастанию.
  • desc — по убыванию.

• section — name-параметр, поле в таблице table:, по которому будут сгруппированы значения.

  • name-параметр
  • Поле указанное в section: должно содержать одинарные значения.
  • Если поле указанное в section: является селектом, то автоматически будут использованы его отображения, а не основания.

• preview — множественный, name-параметр множественный параметр, поля данные которых выводятся в панель по клику правой кнопки мыши или при выборе значения.

• bfield — name-параметр поля, выводящегося в параметр "value" итогового rowList.

  • При пустом bfield: в качестве ключа используется id.

• previewscode — код для формирования дополнительных превью, получает параметр $#val, содержащий bfield селекта. Должен возвращать rowlist формата [{title: "", value: "", name: ""}].

  • Выполняется из окружения той таблицы в которой находится Селект, но получает только значения нестрочных полей и id строки, плюс $#ntn и $#nti.
  • В отличии от функций контекстной панели работает в развернутом на редактирование селекте.

Пример 1:

clients

example1: selectRowListForSelect(table: 'clients'; field: 'client'; order: 'client' asc)

//Результат: 
//[
//{"value": 1, "is_del": false, "title":"Alexey"},
//{"value": 3, "is_del": false, "title":"Boris"}
//{"value": 2, "is_del": false, "title":"Pavel"}
//]

Пример 2:

tax_payments_types

example2: selectRowListForSelect(table: 'tax_payments_types'; field: 'value'; bfield: 'key';  where: 'key' < 3; order: 'key' asc)

// Результат: 
// [
// {"value": 0, "is_del": false, "title":"Общая система налогообложения"},
// {"value": 1, "is_del": false, "title":"Упрощенная система налогообложения (Доход)"}
// {"value": 2, "is_del": false, "title":"Упрощенная система налогообложения (Доход минус Расход)"}
// ]

selectRowListForTree

Доступен в секциях: Код селекта.

=: selectRowListForTree(table: ''; cycle: ; field: ''; order: '' asc; where: '' = ; parent: ''; disabled: ; roots: )

Возвращает список ассоциативных массивов формата:

{
  "value": 35,
  "is_del": false,
  "title": "Производство",
  "parent": 1
}

Используется для подготовки данных поля Селект-дерево.

Обязательные параметры

• table — name-параметр таблица, из которой берутся значения.

• field — name-параметр поле в таблице table:.

• parent — name-параметр, поле содержащее значение bfield родительского элемента или null, если это элемент верхнего уровня.

Необязательные параметры

• cycle — число, одно или список, определяет цикл, если таблица table: является расчетной в цикле.

• hash — строка, для временных таблиц hash таблицы.

• where — name-параметр, множественный, ограничение на выборку вида 'field_name' = value аналогично selectList.

• order — name-параметр, множественный, поле, по которому будет осуществляться сортировка, и порядок в виде 'field_name' asc для сортировки по возрастанию и 'field_name' desc для сортировки по убыванию.

• disabled — числовой список, запрещенные к выбору, но отображаемые в дереве элементы.

• bfield — name-параметр поле в таблице table: которое будет взято в качество основания. По умолчанию id.

• roots - — числовой список, элементы, которые необходимо поставить первым уровнем дерева. В случае, использования, дерево строится от них, указывая в качестве их родителя null.

example: selectRowListForTree(table: 'tree'; field: 'title'; parent: 'parent_id')

// Результат: [{"value":35,"is_del":false,"title":"Производство","parent":null},{"value":45,"is_del":true,"title":"Закупка материалов и склад","parent":"35"} ]

selectTreeChildren

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: selectTreeChildren(table: ''; cycle: ; hash: ; id: ; parent: '')

Возвращает список из id, дочерних по отношению к указанному в параметре id:, а также дочерних к дочерним. Уровень вложенности не ограничен.

Обязательные параметры

• table — name-параметр таблица, из которой берутся значения.

• id — число, строка в которой содержится элемент, у которого ищутся дочерние строки.

• parent — name-параметр, поле содержащее id родительских элементов.

Необязательные параметры

• cycle — число, id цикла, если таблица table: является расчетной в цикле.

• hash — строка, hash таблицы для получения данных из временных таблиц.

• bfield — name-параметр поле в таблице table:. По умолчанию 'id'

Пример:

tree

example: selectTreeChildren(table: 'tree'; id: 1; parent: 'parent_id')

// Результат: [2, 3]

selectRow

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: selectRow(table: ''; cycle: ; hash: ; fields: ; field: ''; field: ''; where: '' = ; order: '' asc)

Возвращает ассоциативный массив с основаниями в виде name полей указанных в field: и отображениями в виде их значений. Если поля находятся в строчной части, то из первой строки строчной части в соответствии с условиями выборки where: и сортировкой order:. Если поля из нестрочных частей, where: и order: не применяются.

Обязательные параметры

• table — name-параметр таблица, из которой берутся значения.

Необязательные параметры

• field — множественный, name-параметр поле в таблице table:.

  Поддерживается вариант задания ключа для выбираемого поля: fied: 'some_field' as "new_name"

• cycle — определяет цикл, если таблица table: является расчетной в цикле.

  • Может передаваться только как одно или список чисел.
  • Параметр отсутствует, если таблица table: находится в дереве.

• hash — строка, hash таблицы для получения данных из временных таблиц.

• where — name-параметр условие выбора строки в строчной части. Левая часть определяет поле сравнения в таблице table:, а правая — значение сравнения.

  • Множественный параметр — если указано несколько параметров where:, то выборка осуществляется на пересечении их условий, применяемых слева направо.
  • Возможны любые операторы сравнения.
  • Может передаваться как число, строка, дата или булево значение
  • Может быть как одним значением, так и списком. В зависимости от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Если по условиям выбираются значения из нескольких строк, то результатом работы функции будет являться ассоциативный массив из первой строки в соответствии с сортировкой заданной в order:.
  • Если по условиям не выбирается ни одной строки, то результатом работы функции будет являться пустой список.

Если в were: передать значение *ALL*, то этот where: будет выключен! Это можно сделать через отдельную строку, например:

=: selectRow(table: 'table_name'; field: 'field_name'; where: 'search_field' = $if)
if: if(condition: #connected_field = ""; then: "*ALL*"; else: #connected_field)

Список из одного значения ["*ALL*"] будет обработан так же как и "*ALL*".

• order — name-параметр поле в таблице table:, по которому будет осуществляться сортировка.

  • Множественный параметр — если указано несколько параметров order:, то сортировка будет осуществлена последовательно.
  • Если параметр отсутствует, то сортировка будет произведена в произвольном порядке.
  • asc — по возрастанию.
  • desc — по убыванию.

• sfield — множественный, name-параметр поле типа Селект или Селект-дерево, для которого нужно выбрать и вернуть отображаемое значение, а не основание. sfield используется вместо параметра field!

  Поддерживается вариант задания ключа для выбираемого поля: sfied: 'some_field' as "new_name". При таком использовании возможна выборка и значения и отображения поля одновременно: fied: 'some_field' as "f_value"; sfied: 'some_field' as "f_title".

• tfield — множественный, name-параметр поле, использующееся для расчета значений селектов в запрошенных в sfield: полях.

• fields — список полей field:.

  Можно передать строковое значение из списка в виде fields: "*ALL*":

  • *ALL* — все поля строчной части.
  • *HEADER* — все поля хедера.
  • *FOOTER* — все поля футера.

• sfields — список полей sfield:.

• offset — число пропуск указанного количества элементов в соответствии с сортировкой order:.

Пример:

clients

example: selectrow(table: 'clients'; field: 'client'; field: 'sum'; order: 'id' desc)

// Результат: {"client": "Boris", "sum": 30}

selectRowList

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: selectRowList(table: ''; cycle: ; hash: ; fields: ; field: ''; field: ''; where: '' = ; order: '' asc)

Возвращает список ассоциативных массивов.

Обязательные параметры

• table — name-параметр name таблицы, из которой берутся данные.

Необязательные параметры

• field — множественный, name-параметр поле в таблице table:.

  Поддерживается вариант задания ключа для выбираемого поля: fied: 'some_field' as "new_name"

• cycle — число, одно или список, определяет цикл, если таблица table: является расчетной в цикле.

• hash — строка, hash таблицы для получения данных из временных таблиц.

• where — name-параметр, множественный, ограничение на выборку вида 'field_name' = "value".

• order — name-параметр, множественный, поле, по которому будет осуществляться сортировка, и порядок в виде 'field_name' asc для сортировки по возрастанию и 'field_name' desc для сортировки по убыванию.

• tfield — name-параметр множественный, поле, использующееся для расчета значений селектов в запрошенных в sfield: полях.

• sfield — name-параметр множественный, поле типа Селект или Селект-дерево, для которого нужно выбрать и вернуть отображаемое значение, а не основание. sfield используется вместо параметра field!

  Поддерживается вариант задания ключа для выбираемого поля: sfied: 'some_field' as "new_name". При таком использовании возможна выборка и значения и отображения поля одновременно: fied: 'some_field' as "f_value"; sfied: 'some_field' as "f_title".

• fields — список полей field:.

  Можно передать строковое значение из списка в виде fields: "*ALL*":

  • *ALL* — все поля строчной части.
  • *HEADER* — все поля хедера.
  • *FOOTER* — все поля футера.

• sfields — список полей sfield:.

• limit — число, ограничивает список указанным количеством элементов.

  • Если передать в качестве значение параметра 0 или "" то он будет отключен!

• offset — число пропуск указанного количества элементов.

Пример:

clients

example: selectrowlist(table: 'clients'; field: 'client'; field: 'sum'; where: 'id' > 1; order: 'id' desc)

// Результат: 
// [
// {"client": "Boris", "sum": 30},
// {"client": "Pavel", "sum": 20},
// ]

selectUnreadComments

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: selectUnreadComments(users: json`[4,5,8]`; table: ''; field: ''; id: )

Возвращает информацию о непрочитанных комментариях из поля комментарии.

Результатом работы будет rowlist со строкой на каждого пользователя указанного в users:

• Пользователь обозначен в user;

• Количество непрочитанных комментов в num.

• сами комменты (непрочитанные) в comments.

Обязательные параметры

• field — name-параметр поле в таблице table:.

• table — name-параметр name таблицы из которой берутся данные.

• users — список id пользователей, по которым нужно получить данные о комментариях.

Необязательные параметры

• cycle — число, определяет цикл, если таблица table: является расчетной в цикле.

• id — id строки, если запрос идет к строчной части.

Даты

nowDate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: nowDate(format: "Y-m-d H:i")

Возвращает текущую дату в указанном формате.

Может быть заменен на быстрые переменные — $#nd, $#ndt и $#ndts.

Необязательные параметры

• format — определяет формат в котором выводится дата, например Y-m-d H:i

  • Если параметр format: отсутствует, то результатом будет строка формата Y-m-d H:i.
  • ВНИМАНИЕ! ПОЛЕ ДАТА ХРАНИТ ЗНАЧЕНИЕ В ФОРМАТЕ Y-m-d H:i и Y-m-d.
  • ДЛЯ КОРРЕКТНОЙ РАБОТЫ СРАВНЕНИЙ ОБЕ ЧАСТИ НЕРАВЕНСТВА ДОЛЖНЫ БЫТЬ В АНАЛОГИЧНОМ ФОМАТЕ!

  • Может быть указан как одна строка в которой в результате работы функции будут произведены замены:

  • Символы формата даты

    • d — День месяца, 2 цифры с ведущим нулём от 01 до 31
    • D — Текстовое представление дня недели, 3 символа от Mon до Sun (не рекомендуется использовать тк для этого есть функция dateWeekDay)
    • j — День месяца без ведущего нуля от 1 до 31
    • N — Порядковый номер дня недели от 1 (понедельник) до 7 (воскресенье)
    • z – Порядковый номер дня в году от 0 до 365
    • W — Порядковый номер недели года.
    • m — Порядковый номер месяца с ведущим нулём от 01 до 12
    • M — Сокращенное наименование месяца, 3 символа от Jan до Dec (не рекомендуется использовать тк для этого есть функция Х)
    • n — Порядковый номер месяца без ведущего нуля от 1 до 12
    • t — Количество дней в указанном месяце от 28 до 31
    • L — Признак високосного года 1, если год високосный, иначе 0.
    • Y — Порядковый номер года, 4 цифры. Примеры: 1999, 2003
    • y — Номер года, 2 цифры. Примеры: 99, 03
    • H — Часы в 24-часовом формате с ведущим нулём от 00 до 23
    • i — Минуты с ведущим нулём от 00 до 59
    • s — Секунды с ведущим нулём от 00 до 59

example1: nowdate()

// Результат: "2018-01-15 20:48" 

example2: nowdate(format: "Y-m-d")

// Результат: "2018-01-15" 

example3: nowdate(format: "H:i")

// Результат: "20:48" 

example4: nowdate(format: "d.m.Y")

// Результат: "15.01.2018" 

example5: nowdate(format: "d.m.Y (H:00)")

// Результат: "15.01.2018 (20:00)" 

example6: nowdate(format: "z")

// Результат: "15"

dateDiff

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: dateDiff(date: ; date: ; unit: "day|year|month|hour|minute")

Возвращает число, равное разнице между date и date выраженное в единице unit. Если вторая дата раньше первой — функция вернет отрицательное значение. Разница между датами возвращается в виде дробного значения.

Обязательные параметры

• date — обязательно должно быть указано два параметра.

  • Могут быть переданы как одна строка.

  • Передаваемые значения должны соответствовать одному из форматов:

    • Y-m-d
    • Y-m-d H:i

  • Если один из параметров указан с H:i, а другой без — то для сравнения параметру с отсутствующим H:i присваивается 00:00

  • Может быть передан в unix timestamp как число.

• unit — параметр, определяющий, в какой величине отображается разница.

  • Передается как одна строка и может принимать одно из значений:
    • year — года
    • month — месяцы
    • day — дни
    • hour — часы
    • minute — минуты
  • Параметр может отсутствовать, в этом случае его значению присваивается day.

example: dateDiff(date: $date1; date: $date2; unit: "day")
    date1: "2017-07-01"
    date2: "2017-07-02 10:42"

// Результат: "1.4458333333333"

dateAdd

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: dateAdd(date: ; days: ; hours: ; minutes: ; months: ; years: ; format: "Y-m-d H:i"; lang: )

Прибавляет к дате дни, часы и минуты и возвращает новую дату (позже заданной) в виде одной строки. Указание дней, часов и минут с отрицательным знаком приведет к вычитанию их из стартовой даты. Будет возвращена дата раньше стартовой.

Если при добавлении месяцев получается отсутствующая дата, то избыток дней переносится на следующий месяц.

Обязательные параметры

• date — дата, к которой будет прибавляться значение.

  • Передается как как одна строка.

  • Передаваемое значение должно соответствовать одному из форматов:

    • Y-m-d
    • Y-m-d H:i

  • Если передана без H:i, а прибавляются часы и минуты, то присваивается 00:00.

  • Может быть передан в unix timestamp как число.

Необязательные параметры

• format — определяет формат в котором выводится дата, например "Y-m-d H:i"

  ВНИМАНИЕ! ПОЛЕ ДАТА ХРАНИТ ЗНАЧЕНИЕ В ФОРМАТЕ "Y-m-d H:i" и "Y-m-d".

  ДЛЯ КОРРЕКТНОЙ РАБОТЫ СРАВНЕНИЙ ОБЕ ЧАСТИ НЕРАВЕНСТВА ДОЛЖНЫ БЫТЬ В АНАЛОГИЧНОМ ФОМАТЕ!

  • Если параметр format: отсутствует, то результатом будет строка формата "Y-m-d H:i".

  • Может быть указан как одна строка в которой в результате работы функции будут произведены замены:

  • Символы формата даты

    • d — День месяца, 2 цифры с ведущим нулём от 01 до 31.
    • D — Текстовое представление дня недели, 3 символа от Mon до Sun.
    • j— День месяца без ведущего нуля от 1 до 31.
    • N — Порядковый номер дня недели от 1 (понедельник) до 7 (воскресенье).
    • z – Порядковый номер дня в году от 0 до 365.
    • W — Порядковый номер недели года.
    • m — Порядковый номер месяца с ведущим нулём от 01 до 12.
    • M — Сокращенное наименование месяца, 3 символа от Jan до Dec.
    • n — Порядковый номер месяца без ведущего нуля от 1 до 12.
    • t — Количество дней в указанном месяце от 28 до 31.
    • L — Признак високосного года 1, если год високосный, иначе 0.
    • Y — Порядковый номер года, 4 цифры. Примеры: 1999, 2003.
    • y — Номер года, 2 цифры. Примеры: 99, 03.
    • H — Часы в 24-часовом формате с ведущим нулём от 00 до 23.
    • i — Минуты с ведущим нулём от 00 до 59.
    • s — Секунды с ведущим нулём от 00 до 59.
    • F — Полное наименование месяца.
    • l (lowercase L) — Полное наименование дня недели.

• days — одно целое число, количество дней.

• hours — одно целое число, количество часов.

• minutes — одно целое число, количество минут.

• months — одно целое число, количество месяцев.

• years — одно целое число, количество лет.

• lang — строка, если не указан, то вывод идет в языковом пакете PHP на сервере. Если указан, то на указанном языке. Поддерживаемые языки:

  • ru — русский.

example: dateAdd(date: "2017-10-01 10:00"; days: 1; hours: 2; minutes: 20)

// Результат: "2017-10-02 12:20"

dateFormat

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: dateFormat(date: ; format: "d.m.Y H:i"; lang: )

Возвращает преобразованную дату как одну строку. Если в date передан list или rowList то на выходе будет аналогичный list/rowList с всеми подходящими заменами.

Обязательные параметры

• date — преобразуемая дата.

  • Передается как как строка.

  • Передаваемое значение должно соответствовать одному из форматов:

    • Y-m-d
    • Y-m-d H:i

  • Если передана без H:i, а преобразуется в формат с H:i — присваивается 00:00.

  • Может быть передан в unix timestamp как число.

• format — определяет формат в котором выводится дата, например "Y-m-d H:i"

  ВНИМАНИЕ! ПОЛЕ ДАТА ХРАНИТ ЗНАЧЕНИЕ В ФОРМАТЕ Y-m-d H:i и Y-m-d.

  ДЛЯ КОРРЕКТНОЙ РАБОТЫ СРАВНЕНИЙ ОБЕ ЧАСТИ НЕРАВЕНСТВА ДОЛЖНЫ БЫТЬ В АНАЛОГИЧНОМ ФОМАТЕ!

  • Если параметр format: отсутствует, то результатом будет строка формата "Y-m-d H:i".

  • Может быть указан как строка в которой в результате работы функции будут произведены замены:

  • Символы формата даты

    • d — День месяца, 2 цифры с ведущим нулём от 01 до 31.
    • D — Текстовое представление дня недели, 3 символа от Mon до Sun.
    • j — День месяца без ведущего нуля от 1 до 31.
    • N — Порядковый номер дня недели от 1 (понедельник) до 7 (воскресенье).
    • z – Порядковый номер дня в году от 0 до 365.
    • W — Порядковый номер недели года.
    • m — Порядковый номер месяца с ведущим нулём от 01 до 12.
    • M — Сокращенное наименование месяца, 3 символа от Jan до Dec.
    • n — Порядковый номер месяца без ведущего нуля от 1 до 12.
    • t — Количество дней в указанном месяце от 28 до 31.
    • L — Признак високосного года 1, если год високосный, иначе 0.
    • Y — Порядковый номер года, 4 цифры. Примеры: 1999, 2003.
    • y — Номер года, 2 цифры. Примеры: 99, 03.
    • H — Часы в 24-часовом формате с ведущим нулём от 00 до 23.
    • i — Минуты с ведущим нулём от 00 до 59.
    • s — Секунды с ведущим нулём от 00 до 59.
    • F — Полное наименование месяца.
    • l (lowercase L) — Полное наименование дня недели.
    • U — Дата в timestamp.

Необязательные параметры

• lang — строка, если не указан, то вывод идет в языковом пакете PHP на сервере. Если указан, то на указанном языке. Поддерживаемые языки:

  • ru — русский.

Следующие параметры применяются если в date используется list/rowList:

• keys — для rowList, список ключей, в которых будет произведена замена. Если не указан, то замена производится во всех ключах.

• recursive — по умолчанию true или list в котором указаны уровни замены 0 — верхний, 1 — следующий вложенный и так далее, для случаев, когда нужно заменить на определенном уровне волженности.

• replace — может содержать или одинарный элемент или тройственный:

  • "single-part" — на это значение будут заменены null и "".

  • "three-part" = "value" — в этом случае он сверяет значение и заменяет только при соответствии. Имеет приоритет перед форматированием даты.

example: dateFormat(date: "01.07.2017"; format: "d.m")

// Результат: "01.07"

example2: dateFormat(date: "01.07.2017"; format: "F"; lang: "ru")

// Результат: "июль"

example3: dateFormat(date: "26.03.2021"; format: "l"; lang: "ru")

// Результат: "Пятница"

= : dateFormat(date: $rowlist; format: "d.Y"; keys: json`["format"]`)

rowlist: rowListCreate(field: "format" = $list; field: "out" = $list)
    ~list: listCreate(item: "2023-01-01"; item: "2023-01-02"; item: "2023-01-03")

// Результат:
//[
//  {
//    "out": "2023-01-01",
//    "format": "01.2023"
//  },
//  {
//    "out": "2023-01-02",
//    "format": "02.2023"
//  },
//  {
//    "out": "2023-01-03",
//    "format": "03.2023"
//  }
//]

dateIntervals

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: dateIntervals(date: $#nd; num: 10; type: "hour|day|week|month"; datetime: false)

Возвращает rowList содержащий ключи start и end

Обязательные параметры

• num — число интервалов для генерации.

• type — указывается тип интервала:

  • "hour" — час
  • "day" — день
  • "week" — неделя
  • "month" — месяц

• date — дата к которой будет прибавлятся значение.

  • Передается как как одна строка.

  • Передаваемое значение должно соответствовать одному из форматов:

    • Y-m-d
    • Y-m-d H:i
    • Может быть передан в unix timestamp как число.

Необязательные параметры

• format — определяет формат в котором выводится дополнительные форматированные даты в ключи startf и endf.

  • Может быть указан как одна строка в которой в результате работы функции будут произведены замены:

  • Символы формата даты

    • d — День месяца, 2 цифры с ведущим нулём от 01 до 31
    • D — Текстовое представление дня недели, 3 символа от Mon до Sun (не рекомендуется использовать тк для этого есть функция dateWeekDay)
    • j— День месяца без ведущего нуля от 1 до 31
    • N — Порядковый номер дня недели от 1 (понедельник) до 7 (воскресенье)
    • z – Порядковый номер дня в году от 0 до 365
    • W — Порядковый номер недели года.
    • m — Порядковый номер месяца с ведущим нулём от 01 до 12
    • M — Сокращенное наименование месяца, 3 символа от Jan до Dec (не рекомендуется использовать тк для этого есть функция Х)
    • n — Порядковый номер месяца без ведущего нуля от 1 до 12
    • t — Количество дней в указанном месяце от 28 до 31
    • L — Признак високосного года 1, если год високосный, иначе 0.
    • Y — Порядковый номер года, 4 цифры. Примеры: 1999, 2003
    • y — Номер года, 2 цифры. Примеры: 99, 03
    • H — Часы в 24-часовом формате с ведущим нулём от 00 до 23
    • i — Минуты с ведущим нулём от 00 до 59
    • s — Секунды с ведущим нулём от 00 до 59

• datetime — true если в ключи start и end необходимо вывести Y-m-d H:i

• weekdaystart — указать день начала недели для week интервалов в трехбуквенном eng формате:

  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
  • sun

Математические

round

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: round(num: ; type: ; step: ; decimals: )

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

Возвращает одно число

Обязательные параметры

• num — одно число для округления.

Необязательные параметры

• type — одна строка, направление округления.

  • up — округление вверх
  • down — округление вниз
  • При отсутствии — математически

• step — одно число, шаг округления.

• decimals — одно целое число, количество знаков после запятой у результата работы функции.

example: round(num: $limit; type: "up"; step: 0.25; decimals: 2)
    limit: 3.56

// Результат: 3.75

modul

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: modul(num: )

Возвращает одно число, абсолютное значение (модуль) числа, переданного в num:.

Обязательные параметры

• num — одно число.

example: modul(num: -3)

// Результат: 3

numRand

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: numRand(min: ; max: )

Возвращает одно число псевдослучайное значение в диапазоне от min: (или 0) до max: (или максимально возможного в вашей версии PHP случайного числа).

Необязательные параметры

• min — одно число, минимальная граница диапазона для случайного числа.

  • При отсутствии 0

• max — одно число, максимальная граница диапазона для случайного числа.

  • При отсутствии максимальное для платформы.

example: numRand(min: 0; max: 20)

// Результат: 4

numTransform

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: numTransform(data: )

Внутри totum все данные это строка, но внешние системы иногда хотят конкретно числа. Эта функция преобразует строки в числа.

Если в data передан list или rowList то на выходе будет аналогичный list/rowList с всеми подходящими заменами.

Обязательные параметры

• data — строка для преобразования в число.

Следующие параметры применяются если в data используется list/rowList:

• keys — для rowList, список ключей, в которых будет произведена замена. Если не указан, то замена производится во всех ключах.

• recursive — по умолчанию true или list в котором указаны уровни замены 0 — верхний, 1 — следующий вложенный и так далее, для случаев, когда нужно заменить на определенном уровне волженности.

ПРИМЕРЫ

example: numTransform(data: $transform)
    transform: "5.87"
//Результат: 

= : numTransform(data: $rowlist; keys: json`["format"]`)

rowlist: rowListCreate(field: "format" = $list; field: "out" = $list)
    ~list: listCreate(item: "10500"; item: "10600"; item: "10700")

// Результат:
//[
//  {
//    "format": 10500,
//    "out": "10500"
//  },
//  {
//    "format": 10600,
//    "out": "10600"
//  },
//  {
//    "format": 10700,
//    "out": "10700"
//  }
//]

Текстовые строки

strAdd

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strAdd(str: ; str: )

Возвращает строку, из последовательно соединенных указанных строк. Конкатенация строк.

Обязательные параметры

• str — одна строка или число, множественный параметр, определяющий части соединяемых строк.

example: strAdd(str: "Приятного использования "; str: "TOTUM")

// Результат: "Приятного использования TOTUM"

Для этой функции есть сахар str:

str: str`"#" + $#nfv ++ "—" ++ #field`

// Результат: #34 — закрыт

• + — склеивает без пробела.
• ++ — склеивает, добавляя пробел.

strReplace

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strReplace(str: ; from: ; to: )

Ищет в str: все прямые вхождения from: и заменяет их на to:. Возвращает одну строку.

Обязательные параметры

• str — одна строка или число в которой будут производиться замены.

• from — список или одна строка, соответствие, которое будет заменяться.

  • Будут заменены все найденные вхождения.
  • Если передается как список, то последовательно будут осуществлены замены всех элементов списка.

• to — список или одна строка на которую будет произведена замена.

  • Если from: передается как список, то to тоже может быть передан как список, тогда замены будут произведены в соответствии с совпадениями элементов списков.

example1: strreplace(str: "Двигатели R3 и R5 в режиме зажигания"; from: "3"; to: "4")

// Результат: "Двигатели R4 и R5 в режиме зажигания"

example2: strreplace(str: "Двигатели R3 и R5 в режиме зажигания"; from: "R"; to: "M")

// Результат: "Двигатели M3 и M5 в режиме зажигания"

example3: strreplace(str: "Двигатели R3 и M5 в режиме зажигания"; from: $from; to: $to)
    from: listcreate(item: "R3"; item: "M5")
    to: listcreate(item: "S2"; item: "T7")

// Результат: "Двигатели S2 и T7 в режиме зажигания"

strRegMatches

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strRegMatches(str: ; template: ; matches: "matches"; flags: "u")

Возвращает true или false — совпадение с шаблоном.

Обязательные параметры

• str — одна строка или число строка/текст для анализа.

• template — одна строка шаблон PCRE (perl-совместимых регулярных выражений). !БЕЗ ОГРАНИЧИТЕЛЕЙ (delimiters) /png/ —› png

Необязательные параметры

• matches — одна строка наименование переменной, которой будут присвоены найденные совпадения

  • В переменную будет передан список.
  • С нулевым индексом в списке будет полное совпадение с шаблоном.
  • С последующими — совпадение со выражениями, взятыми в скобки.

• flags — PCRE-флаги. По умолчанию, передается u- utf-8 режим.

example: if(condition: $reg = true; then: $#matches; else: "Совпадение не найдено")
reg: strRegMatches(str: "Сашина машина шуршит шинами"; template: "\s+(шина[^\s]*)"; matches: "matches"; flags: "u")

// Результат: [" шинами","шинами"]

strRegAllMatches

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strRegAllMatches(str: ; template: ; matches: "matches"; flags: "u")

Возвращает true если в str: есть одно или больше совпадение с шаблоном, если нет то false.

Обязательные параметры

• str — одна строка или число строка/текст для анализа.

• template — одна строка шаблон PCRE (perl-совместимых регулярных выражений). !БЕЗ ОГРАНИЧИТЕЛЕЙ (delimiters) /png/ —› png

Необязательные параметры

• matches — одна строка наименование переменной, которой будут присвоены найденные совпадения

  • В переменную будет передан список списков.
  • В список с индексом 0 будут переданы полные совпадения с шаблоном
  • В последующие — совпадения с выражениями, взятыми в скобки.

• flags — PCRE-флаги. По умолчанию, передается u- utf-8 режим.

Пример:

Разбить текст на строки и найти первое слово в каждой строке

str Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diem nonummy nibh euismod tincidunt ut lacreet dolore magna aliguam erat volutpat. Ut wisis enim ad minim veniam, quis nostrud exerci tution ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.

example: if(condition: $reg = true; then: $#matches; else: "Совпадение не найдено")
    reg: strRegAllMatches(str: #str; template: '\s*([^\n ]+)[^\n]+(?:\n|$)'; matches: "matches"; flags: "mu")

//  Результат: [
//  [
//    "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diem \n",
//    "nonummy nibh euismod tincidunt ut lacreet dolore magna aliguam erat volutpat. \n",
//    "Ut wisis enim ad minim veniam, quis nostrud exerci tution ullamcorper suscipit \n",
//    "lobortis nisl ut aliquip ex ea commodo consequat."
//  ],
//  [
//    "Lorem",
//    "nonummy",
//    "Ut",
//    "lobortis"
//  ]
//  ]

numFormat

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: numFormat(num: ; decimals: ; decsep: ","; thousandssep: " "; unittype: )

Превращает число в строку оформленную по шаблону. Если в num передан list или rowList то на выходе будет аналогичный list/rowList с всеми подходящими заменами.

Если из внешней системы приходит число в экспонентной записи 2,3е+15 то оно переводится в формат тотума функцией numFormat.

Максимальный размер числа обрабатываемого numFormat до точки — 17 разрядов. При превышении на 64-разрядной машине итоговый результат будет случайным числом.

Обязательные параметры

• num — число, которое будет преобразовано в строку.

Необязательные параметры

• decimals — число, количество знаков после запятой.

• decsep — строка, разделитель десятичных знаков.

• thousandssep — строка, разделитель тысяч.

• unittype — строка, постфикс.

• prefix — строка, префикс.

Следующие параметры применяются если в num используется list/rowList:

• keys — для rowList, список ключей, в которых будет произведена замена. Если не указан, то замена производится во всех ключах.

• recursive — по умолчанию true или list в котором указаны уровни замены 0 — верхний, 1 — следующий вложенный и так далее, для случаев, когда нужно заменить на определенном уровне волженности.

• replace — может содержать или одинарный элемент или тройственный:

  • "single-part" — на это значение будут заменены null и "".

  • "three-part" = "value" — в этом случае он сверяет значение и заменяет только при соответствии. Имеет приоритет перед форматированием даты.

example: numFormat(num: $num; decimals: 1; decsep: ","; thousandssep: " "; unittype: " r.")

num: 10000.34 

// Результат: "10 000,34 r."

= : numFormat(num: $rowlist; thousandssep: ","; unittype: " €"; keys: json`["format"]`)

rowlist: rowListCreate(field: "format" = $list; field: "out" = $list)
    ~list: listCreate(item: "10500"; item: "10600"; item: "10700")

// Результат:
//[
//  {
//    "out": "10500",
//    "format": "10,500 €"
//  },
//  {
//    "out": "10600",
//    "format": "10,600 €"
//  },
//  {
//    "out": "10700",
//    "format": "10,700 €"
//  }
//]

strRandom

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strRandom(length: 5; numbers: "true|false|12345"; letters: "false|true|abcdABCD"; symbols: "false|true|!@#$%^&")

Возвращает строку длинной length, составленную из перечисленных символов.

Обязательные параметры

• length — число, длина результирующей строки.

Необязательные параметры

• numbers — одна строка, описывающая использование чисел.

  • false — не использовать числа.
  • true — использовать все числа.
  • 12345 — использовать только числа 12345.

• letters — одна строка, описывающая использование букв.

  • false — не использовать буквы.
  • true — использовать все буквы английского алфавита.
  • abcdABCD — использовать только указанные буквы.

• symbols — одна строка, описывающая использование символов.

  • false — не использовать символы.
  • true — использовать символы !@#$%^&*()_+=-%,.;:
  • !@#$%^& — использовать только указанные символы.

example: strRandom(length: 5; numbers: "true"; letters: "true"; symbols: "true")

// Результат: "z4yF9"

strEncrypt

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strEncrypt(str: )

Возвращает зашифрованную строку.

Для работы необходимо в корне установки создать файл Crypto.key (автоматически генерируется при установке со случайным содержимым) в котором набрать ключ, которым будет шифроваться строка. Файл необходимо создавать от того-же пользователя linux от которого работает Totum.

Внимание: что бы дешифровать записанные данные потребуется идентичный ключ. Скопируйте его если переносите данные на другой сервер!

Обязательные параметры

• str — одна строка или число.

strDecrypt

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strDecrypt(str: )

Возвращает расшифрованную строку.

Для работы необходимо в корне установки создать файл Crypto.key в котором набрать ключ (создается автоматически при установке), которым будет шифроваться строка. Файл необходимо создавать от того-же пользователя linux от которого работает Totum.

Расшифровка возможна только с Ключом, примененным при шифровании.

Обязательные параметры

• str — шифрованная функцией strEncrypt строка`

strUrlEncode

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strUrlEncode(str: )

Возвращает url-кодированную строку.

Обязательные параметры

• str — одна строка или число

strUrlDecode

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strUrlDecode(str: )

Возвращает декодированную строку.

При получении данных в remotes применять не требуется — при получении url-кодированной строки в get в remotes она декодируется автоматически.

Обязательные параметры

• str — одна строка или число

strBaseEncode

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strBaseEncode(str: )

Возвращает строку кодированную в base64.

Обязательные параметры

• str — одна строка или число для кодирования.

example: strBaseEncode(str: "строка для кодирования")

// Результат: 0YHRgtGA0L7QutCwINC00LvRjyDQutC+0LTQuNGA0L7QstCw0L3QuNGP

strBaseDecode

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strBaseDecode(str: )

Возвращает раскодированную base64 строку или false.

Внимание! В результате раскодирования может быть получена строка с не utf-8 символами, которая не сможет быть сохранена как значение поля и при такой попытке будет отдана ошибка базы данных!

Обязательные параметры

• str — одна строка или число в base64 для декодирования.

example: strBaseDecode(str: "0YHRgtGA0L7QutCwINC00LvRjyDQutC+0LTQuNGA0L7QstCw0L3QuNGP")

// Результат: строка для кодирования

strLength

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strLength(str: )

Возвращает число — длину str.

Обязательные параметры

• str — одна строка или число для определения длины.

example: strLength(str: "Totum")

// Результат: 5

strRepeat

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strRepeat(str: ; num: )

Возвращает строку из str:, повторенного num: раз.

Обязательные параметры

• num — одно число, количество раз повторения.

• str — одна строка или число для повторения.

example: strRepeat(str: "-"; num: 5)

// Результат: "-----"

strSplit

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strSplit(str: ; separator: )

Возвращает список из строк — str: разбитое по separator:.

Обязательные параметры

• str — одна строка из которой будет формироваться список.

Необязательные параметры

• separator — одна строка, разделитель.

• limit — максимальное число элементов в возвращаемом списке.

Пример:

str Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diem nonummy nibh euismod tincidunt ut lacreet dolore magna aliguam erat volutpat. Ut wisis enim ad minim veniam, quis nostrud exerci tution ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat.

example: strSplit(str: #str; separator: $#nl)

// Результат: 
//  [
//  "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diem ",
//  "  nonummy nibh euismod tincidunt ut lacreet dolore magna aliguam erat volutpat. ",
//  "  Ut wisis enim ad minim veniam, quis nostrud exerci tution ullamcorper suscipit ",
//  "  lobortis nisl ut aliquip ex ea commodo consequat."
//  ]

strTransform

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strTransform(str: ; to: "upper|lower|capitalize")

Возвращает измененную строку.

Обязательные параметры

• str — строку для изменения.

• to — строку, одно из трех значений.

  • upper — сделать все буквы заглавными.
  • lower — сделать все буквы строчными.
  • capitalize — сделать каждую первую букву слова заглавной.

example: strTransform(str: "elon musk"; to: "capitalize")

// Результат: Elon Musk

textByTemplate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: textByTemplate(template: ; text: ; data: $data)

Возвращает html.

Обязательные параметры

• data — ассоциативных массивов с данными для заполнения шаблона.

Необязательные параметры

• template — одна строка, name шаблона в таблице Шаблоны печати.

• text — одна строка шаблон (используется если template отсутствует).

Пример:

example1: textByTemplate(template: "kp"; data: $data)
    data: rowCreate(field: "title" = "Title"; field: "text" = "Text"; field: "footer" = "Footer")

// Результат: "<style>.title{font-size: 20px;}.text-main{font-size: 14px}.text-footer{padding-top: 20px; font-size: 14px}</style><body><div class="title">  Title</div><div class="text-main">  Text</div><div class="text-footer">  Footer</div></body>"

example2: textByTemplate(text: $template; data: $data)
    data: rowCreate(field: "title" = "Title"; field: "text" = "Text"; field: "footer" = "Footer")

 ```template:html
 <div>Some text with {title}, {text} and {footer}</div>
 ```

strMd5

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strMd5(str: )

Возвращает строку в виде md5-хеша.

Обязательные параметры

• str - одна строка или число для хеширования.

example: strMd5(str: "0")

// Результат: "15e79710ef30825afe1dc5c4d3fb5849"

strGz

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strGz(str: )

Возвращает gz-упакованную строку str:.

Обязательные параметры

• str — одна строка или число для упаковки.

example: set(table: 'testsimp'; field: 'file' = $fileList)
    fileList: listCreate(item: $fileRow)
        fileRow: rowCreate(field: "filestring" = $gz; field: "name" = "text.txt.gz")
            gz: strGz(str: "Test row")

// В ячейке file таблицы testsimp — файл text.txt.gz

strUnGz

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strUnGz(str: )

Возвращает распакованную gz-строку str: или false, если строку декодировать не удалось.

Обязательные параметры

• str — gz-строка для распаковки.

example: strUnGz(str: $fileContent)
    fileContent: fileGetContent(file: #gzfile[0]["file"])
// Результат: распакованный текст из файла

strPart

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strPart(str: ; offset: ; length: )

Возвращает часть от переданной в него строки.

Обязательные параметры

• str — строка или число.

Необязательные параметры

• length — число, сколько символов взять в результат.

  Если задать отрицательное число, то конец строки будет отсчитан с конца слова.

• offset — число, смещение выборки (на сколько элементов сдвинуть начало).

  Если задать отрицательное число, то старт будет взят от конца строки.

ПРИМЕРЫ

example_1: strPart(str: "7718767895"; length: 4; offset: 4)

//Результат: "7678"

example_2: strPart(str: "-string-"; length: -1; offset: 1)

//Результат: "string"

strTrim

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: strTrim(str: )

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

Обязательные параметры

• str — одна строка или число

Списки

listCreate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listCreate(item: )

Создает список из элементов.

Необязательный множественный параметр

• item — элементы, из которых создается список. Количество параметров определяет количество элементов в списке.

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

example1: listCreate(item: 1; item: 2; item: 4; item: "")

// Результат: [1,2,4,""]

example2: listCreate(item: "Alex"; item: "Sam"; item: "Mike")

// Результат: ["Alex","Sam","Mike"]

example3: listCreate()

// Результат: []

listMax

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listMax(list: ; default: )

Возвращает максимальное значение списка. Результатом работы является одно значение, за исключением случая, когда возвращается значение, указанное в параметре default.

Обязательные параметры

• list — список чисел, строк, дат, в которых ищется максимальное значение.

  • Если передан ряд чисел, то они будут обрабатываться как числа даже если переданы как строки.

Необязательные параметры

• default — значение возвращаемое функцией при передаче в list: пустого списка.

  • Задается как одинарное значение или список из чисел, строк, дат или булевого значения.
  • При отсутствии параметра при передаче в list: пустого списка функция вернет ОШБК!

example1: listmax(list: $list1)
    list1: listCreate(item: 35; item: 78; item: 13)

// Результат: 78

example2: listmax(list: $list2)
    list2: listCreate(item: "11"; item: "12"; item: "2")

// Результат: 12

example3: listmax(list: $list3)
    list3: listCreate()

// Результат: "ERR!"

example4: listmax(list: $list4; default: 0)
    list4: listCreate()

// Результат: 0

listMin

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listMin(list: ; default: )

Возвращает минимальное значение списка. Результатом работы является одно значение, за исключением случая, когда возвращается значение, указанное в параметре default.

Обязательные параметры

• list — список чисел, строк, дат в котором ищется максимальное значение.

  • Если передан ряд чисел, то они будут обрабатываться как числа даже если переданы как строки.

Необязательные параметры

• default — значение, возвращаемое функцией при передаче в list: пустого списка.

  • Задается как одинарное значение или список из чисел, строк, дат или булевого значения.
  • При отсутствии параметра при передаче в list: пустого списка функция вернет ОШБК!.

example1: listMin(list: $list1)
    list1: listCreate(item: 35; item: 78; item: 13)

// Результат: 13

example2: listMin(list: $list2)
    list2: listCreate(item: "11"; item: "12"; item: "2")

// Результат: 2

example3: listMin(list: $list3)
    list3: listCreate()

// Результат: "ERR!"

example4: listmax(list: $list4; default: 0)
    list4: listCreate()

// Результат: 0

listSum

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listSum(list: )

Возвращает одно число, сумму значения списка list:.

Все элементы списка должны быть числовыми значениями.

Обязательные параметры

• list — список чисел значения которого суммируются.

example: listsum(list: $list)
    list: listCreate(item: 10; item: 5; item: 5)

// Результат: 20

listCount

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listCount(list: )

Возвращает одно число, количество элементов списка list:.

Обязательные параметры

• list — список, элементы которого подсчитываются.

  • Элементы list могут быть одинарными значениями, списками чисел, строк, дат и булевых значений.

example1: listcount(list: $list1)
    list1: listCreate(item: "Alex"; item: "Sam"; item: "Mike")

// Результат: 3

example2: listcount(list: $list2)
    list2: listCreate(item: 5; item: 10; item: 5)

// Результат: 3

listUniq

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listUniq(list: )

Возвращает список уникальных элементов списка list:.

Обязательные параметры

• list — список, в котором осуществляется поиск уникальных элементов: чисел, строк, дат или булевых значений.

example: listuniq(list: $list)
list: listCreate(item: "Alex"; item: "Sam"; item: "Alex")

// Результат: ["Alex","Sam"]

listItem

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listItem(list: ; item: )

Возвращает одно значение из списка list: под номером item:. Нумерация элементов списка начинается с 0 (ноля).

Может быть заменено на обращение $list[item_number]. Подробнее про обращение к элементу списка.

Обязательные параметры

• list — список, элемент которого выбирается.

  • Задается как числа, строки, даты или булевые значения.
  • Может состоять из одинарных значений или списков.

• item — одно число, номер элемента списка.

  • Нумерация элементов списка начинается с 0 (ноль).

example: listitem(list: $list2; item: 1)
    list2: listCreate(item: "Alex"; item: "Sam"; item: "Alex")

// Результат: "Sam"

example2: $list2_2[1]
    list2_2: listCreate(item: "Alex"; item: "Sam"; item: "Alex")

// Результат: "Sam"

listJoin

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listJoin(list: ; str: )

Возвращает объединенные в строку значения списка или ассоциированного массива. str: — строка, которая вставляется между элементами (клей).

Обязательные параметры

• list — список или ассоциированный массив, которые будут трансформироваться в строку.

Необязательные параметры

• str — одна строка или число использующаяся как клей.

example: listJoin(list: $list; str: "-")
    list: listCreate(item: 1; item: 2; item: 3)

// Результат: "1-2-3"

listCross

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listCross(list: ; list: )

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

Обязательные параметры

• list — списки чисел, строк, дат или булевых значений в которых будут искаться пересечения, множественный параметр.

example: listcross(list: $list1; list: $list2; list: $list3)
    list1: listCreate(item: 1; item: 1; item: 2; item: 3)
    list2: listCreate(item: 1; item: 2; item: 3)
    list3: listCreate(item: 1; item: 2)

// Результат: [1, 1, 2]

listAdd

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listAdd(list: ; list: ; item: )

Складывает списки в указанном порядке и возвращает список. Может быть задано любое количество списков, которые будут сложены вместе. Значения в списках могут повторяться.

Обязательные множественные параметры

• list — совмещаемые списки, множественный параметр.

  • Задается как список чисел, строк, дат или булевых значений.
  • Списки складываются в указанном порядке.

Необязательные множественные параметры

• item — одно значение, которое может быть добавлено в список, множественный параметр.

  • Задается как число, строка, дата или булевое значение.
  • Значения добавляются в конец списка в указанном порядке.

example: listadd(list: $list1; list: $list2; item: 5)
    list1: listCreate(item: 1; item: 2; item: 3)
    list2: listCreate(item: 2; item: 3)

// Результат: [1,2,3,2,3,5]

listMinus

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listMinus(list: ; list: ; item: )

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

Обязательные множественные параметры

Необходимо, чтобы присутствовало минимум два параметра, первый из которых list:.

• list — список чисел, строк, дат или булевых значений, множественный параметр.

Необязательные множественные параметры

• item — значение, которое будет исключено из списка, множественный параметр.

  • Задается как одно число, строка, датой или булево значение

example: listminus(list: $list1; list: $list2; item: 2)
    list1: listCreate(item: 1; item: 2; item: 2; item: 3; item: 4)
    list2: listCreate(item: 3; item: 4; item: 5)

// Результат: [1]

listCut

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listCut(list: ; cut: "first|last"; num: 1)

Возвращает список, уменьшенный на num: элементов с начала или с конца.

Обязательные параметры

• list — список чисел, строк, дат для сокращения.

• cut — строка, сторона, с которой будут удалены элементы.

  • first — с начала.
  • last — c конца.

Необязательные параметры

• num — число, количество удаляемых элементов, по умолчанию — 1.

  • Если при параметре cut: "first" передать -1 останется последнее значение списка.

example: listCut(list: $list; cut: "first"; num: 1)
    list: listCreate(item: 1; item: 2)

// Результат: [2]

//Получить номер последнего ключа в списке

= : listCut(list: $keys; cut: "first"; num: -1)
    keys: rowKeys(row: $list)
        list: listCreate(item: "10500"; item: "10600"; item: "10700")

// Результат: [2]

listSection

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listSection(list: ; item: )

Возвращает список из значений указанного в item: ключа на основе ассоциированного массива.

Может быть заменен на обращение вида $rowList[[key]]. Подробнее смотрите обращение к секции.

Обязательные параметры

• list — ассоциированный массив или список из которого будет браться колонка.

• item — ключ, значения которого отбираются, для списков ключ числовой.

Пример 1:

tree

example1: listSection(list: $rowList; item: "id")
    rowList: selectRowList(table: 'tree'; field: 'id'; field: 'title'; order: 'id' asc)

// Результат: [1, 2, 3, 32]

Пример 2:

example2: listSection(list: $listList; item: 1)
    listList: json`[[1,2,3],[4,5,6]]`

// Результат: [2,5]

Так как listSection используется достаточно часто, то в синтаксисе предусмотрено быстрое обращение к секции через $name[[section]]:

example3: $listList[[1]]
    listList2: json`[[1,2,3],[4,5,6]]`

// Результат: [2,5]

listFilter

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listFilter(list: $list; key: "key|value|item" ><!= ; item: ""; regexp: ; skip: ; matches: )

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

Если в list передан список, результатом работы является новый список, у которого нумерация ключей идет с 0, для ассоциативного массива ключи сохраняются.

Обязательные параметры

• list — список или ассоциативный массив, в котором осуществляется фильтрация.

• key — выражение из типа сравниваемого элемента, оператора сравнения и значения для сравнения, множественный параметр в синтаксисе key: "item_name" ><!= "VALUE" num.

  • key — фильтрация строк по list-ключам.
  • value — фильтрация строк по значению.
  • item — для списков ассоциативных массивов, фильтрация строк по значению в колонке определенной в item:.

  Возможно использование параметра в таком синтаксисе:

  =: listFilter(list: $list; key: "item_name" ><!= "VALUE")
  
  // эта запись аналогична
  // =: listFilter(list: $list; key: "item" ><!= "VALUE"; item: "item_name")
  

  Также в этом случае может быть использован третий элемент str или num для определения типа данных в item_name:

  
  =: listFilter(list: $list; key: "item_name" >= "40" str)
  
  // в этом случае данные в item_name будет обработано как строки
  
  

  Также в таком синтаксисе key является множественным параметром — результат фильтрации по пересечению граничных условий.

Необязательные параметры

• item — в случае, когда сравниваемым элементом в key: выбран item — сюда нужно передать ключ этого item.

• regexp — true или набор флагов, в случае, когда правая часть key: представляет из себя регулярное выражение. По умолчанию флаг выставляется в u.

• skip — true, если в key: используется item и в фильтруемых подмассивах он может отсутствовать, то пропускать элементы, в которых его не существует. В противном случае функция завершится ошибкой.

• matches — название переменной, в которую будет записан список из совпадений выбранных строк.

• savekeys — по умалчанию отфильтрованный список имеет собственную нумерацию ключей, но если передать true — будут сохранены оригинальные ключи.

example1: listFilter(list: $list; key: "item" = "tree"; item: "t")
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 1)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 2)

// Результат:
// [
//  {
//    "i": 2,
//    "t": "tree"
//  }
// ]

example2: listFilter(list: $list; key: "t" = "tree")
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 1)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 2)

// Результат:
// [
//  {
//    "i": 2,
//    "t": "tree"
//  }
// ]

example3: listFilter(list: $list; key: "i" < "2" str)
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 10)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 50)

// Результат:
// [
//  {
//    "i": 10,
//    "t": "pen"
//  }
// ]

listSearch

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listSearch(list: $list; key: "value|item" ><!= ; item: "")

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

Обязательные параметры

• list — список или ассоциированный массив или список ассоциированных массивов.

  • Если это список, то результатом будет список числовых ключей.
  • Если это ассоциированный массив, то результатом будет список строковых ключей.
  • Если это список ассоциированных массивов, то результатом будет список числовых ключей.

• key — выражение вида "тип элемента" ><!= "значение элемента", определяющее диапазон выбора, множественный параметр в синтаксисе key: "item_name" ><!= "VALUE" str.

  • value — поиск осуществляется по всему значению.

    • Если это список ассоциированных массивов, то = будет искать пересечения в ассоциированных массивах, а == полное соответствие без учета порядка.

  • item — поиск осуществляется по вложенному значению для списка ассоциированных массивов.

  Возможно использование параметра в таком синтаксисе:

  =: listSearch(list: $list; key: "item_name" ><!= "VALUE" str)
  
  // эта запись аналогична
  // =: listSearch(list: $list; key: "item" ><!= "VALUE"; item: "item_name")
  // item_name_2 будут отсортированы по типу string
  
  

  Также в таком синтаксисе key является множественным параметром — результат поиска по пересечению граничных условий.

  Дополнительно можно указать элемент str или num в key для указания типа сортировки

Необязательные параметры

• item — в случае, когда сравниваемым элементом в key: выбран item — сюда нужно передать название этого item.

Если лист содержит элемент без ключа item будет возвращена ошибка!

example1: listSearch(list: $list; key: "item" = "tree"; item: "t")
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 1)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 2)

// Результат: [1]

example2: listSearch(list: $list; key: "t" = "tree")
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 1)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 2)

// Результат: [1]

example3: listSearch(list: $list; key: "i" < "2" str)
    list: listCreate(item: $row_1; item: $row_2)
        row_1: rowCreate(field: "t" = "pen"; field: "i" = 10)
        row_2: rowCreate(field: "t" = "tree"; field: "i" = 5)

// Результат: [0]

listSort

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listSort(list: ; type: "number|string|regular"; direction: "asc|desc"; key: "key|value|item"; item: "")

Возвращает сортированный list.

Внимание: сортировка спецсимволов в PHP (listSort) и PostgreSQL (параметры order в select-функциях) РАЗЛИЧНА! Полное сравнение в этом случае будет возвращать false. Для полной работоспособности в таких случаях не выполняйте order в select, а добавляйте еще один listSort.

Обязательные параметры

• list — список или ассоциативный массив для сортировки.

  Если в list передан список, результатом работы является новый список, у которого нумерация ключей идет с 0, для ассоциативного массива ключи сохраняются.

Необязательные параметры

• type — строка, тип, к которому приводятся сортируемые элементы при сравнении.

  • number — число.
  • string — строка.
  • regular — без приведения. Результат непредсказуем при разнородном содержимом.
  • nat — сортировка по числу после одинакового префикса n15, n16, n17, ...

  Эта настройка глобальна — те применяется ко всем key использованным в функции.

  Вместо нее можно использовать четвертый элемент str или num в key для указания типа сортировки:

  
  =: listSort(list: $list; key: "item_name_1" asc num; key: "item_name_2" desc str)
  
  // item_name_1 будут отсортированы по типу number
  // item_name_2 будут отсортированы по типу string
  // asc num и num asc будут работать аналогично
  
  

• direction — строка, направление сортировки.

  • asc — по возрастанию (по умолчанию).
  • desc — по убыванию.

• key — выражение из типа сравниваемого элемента, оператора сравнения и значения для сравнения.

  • key — сортировка строк по list-ключам.
  • value — сортировка строк по значению.
  • item — для списков ассоциативных массивов, сортировка строк по значению в колонке определенной в item:.

  Возможно использование параметра в таком синтаксисе:

  =: listSort(list: $list; key: "item_name_1" asc; key: "item_name_2" desc)
  
  // item_name_1 и item_name_2 будут отсортированы по типу regular
  // если задать type то он будет применен ко всем key
  // если задать direction то он будет применен ко всем key без указанного направления
  

  Также в таком синтаксисе key является множественным параметром — результат сортировки по последовательному применению слева-направо.

example1: listSort(list: $list; type: "string"; direction: "asc")
    list: listCreate(item: 1; item: 2; item: 11; item: 21)

// Результат: [1,11,2,21]

example2: listSort(list: $list; key: "numbers" desc num)
    rowlist: rowListCreate(field: "numbers" = $list_numbers; field: "name" = $list_name)
        list_numbers: listCreate(item: 1; item: 2; item: 11; item: 21)
        list_name: listCreate(item: "Alex"; item: "Mike"; item: "Sam"; item: "Dany")

// Результат: [{"numbers":"21","name":"Dany"},{"numbers":"11","name":"Sam"},{"numbers":"2","name":"Mike"},{"numbers":"1","name":"Alex"}]

listMath

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listMath(list: ; num: ; list: ; operator: )

Возвращает list, все элементы которого были изменены в соответствии с operator: и num:.

Обязательные параметры

• list — список или ассоциированный массив, исходник.

• num — число для арифметического действия.

  или

• list — список или ассоциированный массив (в зависимости от формата первого list), для попарного арифметического действия. Количество элементов в list должно быть одинаковое (для ассоциированных массивов одинаковый набор ключей).

• operator — строка, математический оператор.

  • + — прибавить
  • - — отнять
  • * — умножить
  • / — разделить

example1: listMath(list: $list; num: 3; operator: "*")
    list: listCreate(item: 1; item: 2; item: 11; item: 21)

// Результат: [ 3, 6, 33, 63]

example2: listMath(list: $list1; list: $list2; operator: "*")
    list1: listCreate(item: 1; item: 2; item: 11; item: 21)
    list2: listCreate(item: 1; item: 2; item: 1; item: 1)

// Результат: [ 1, 4, 11, 21]

listTrain

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listTrain(list: )

Возвращает список из соединенных последовательно списков вложенных в списки.

Обязательные параметры

• list — список списков.

example: listTrain(list: $lists)
    lists: json`[[1,2],[3,4],[5,6]]`
//Результат: [1,2,3,4,5,6]

listRepeat

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listRepeat(item: ; num: )

Возвращает лист из повторенного num: раз элемента item:.

Обязательные параметры

• num — число, количество повторений элемента item:.

• item — значение любого типа.

example: listRepeat(item: $row; num: 2)
    row: rowCreate(field: "test" = 1)

// Результат: [
//  {
//    "test": 1
//  },
//  {
//    "test": 1
//  }
// ]

listNumberRange

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listNumberRange(min: ; max: ; step: 1)

Возвращает список из чисел в заданном диапазоне, идущих с шагом step:

Необязательные параметры

• min — число от.

• max — число до (конечное значение в интервал не входит).

• step — число, шаг.

  • Если step: > 0 — в порядке от min: включительно до max: исключительно.
  • Если step: < 0 — в порядке от max: включительно до min: исключительно.
  • Если step: = 0 — ERR!

example1: listNumberRange(min: 1; max: 3; step: 0.5)

// Результат: [1,1.5,2,2.5]

example2: listNumberRange(min: 1; max: 3; step: -0.5)

// Результат: [3,2.5,2,1.5]

listCheck

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listCheck(list: )

Возвращает true если в list передан список или row или rowlist. Возвращает false только в случае если передано одно значение!

Обязательные параметры

• list — значение для проверки

listReplace

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: listReplace(list: ; action: "item" = $val; action: $val; key: "key"; value: "value")

Последовательно перебирает список. Может использоваться для:

• создания списка/ассоциативного массивa на основе исходного с заменой значений.

• создания списка ассоциативных массивов/ассоциативного массивa/ассоциативных массивов на основе исходного с заменой отдельных элементов вложенных массивов.

• выполнения действий на основе исходного списка/ассоциативного массивa.

ВНИМАНИЕ! Функция не использует рекурсию и вы можете воспользоваться ею при получении ошибки переполнения стека.

Обязательные параметры

• list — список, список ассоциативных массивов или ассоциативный массив.

• action — множественный параметр, выполняемое действие:

  • action: $act —

    • в итоговый список/ассоциативный массивa добавит значение.
    • в коде действия выполнит действие если act и вернет результат функции-действия.

  • action: "key" = $act —

    • во вложенном ассоциативном массиве добавит или перезапишет значения с "key" ключом.

Необязательные параметры

• value — строка, переменная в которую будет передано значение в случае списка и row в списка ассоциативных массивов.

• key — строка, переменная в которую будет передан порядковый номер обрабатываемого элемента — значения или row.

replace: listReplace(list: $rowlist; action: "date" = $weekDay; action: "max_temp" = $max_temp; value: "val")
    rowlist: rowListCreate(field: "date" = $list_date)
        list_date: listCreate(item: "2020-09-10"; item: "2020-09-11"; item: "2020-09-12")
    weekDay: dateFormat(date: $#val[date]; format: "l"; lang: "ru")
    max_temp: listMax(list: $day_temp; default: "")
        day_temp: selectList(table: 'temp'; field: 'temp'; where: 'date' = $#val[date])

// Перебирает список ассоциированных массивов в колонке date которого хранятся даты.
// Последовательно в каждой строке перезаписывает date на текстовое обозначение дня недели.
// Последовательно в каждой строке добавляет ключ max_temp вычисляя максимальную температуру в этот день на основе данных, взятых на каждой итерации из таблицы temp по значению ключа date в этой строке.

replace_act: listReplace(list: $list_date_act; action: $recalc; value: "val_act")
    list_date_act: listCreate(item: "2020-09-10"; item: "2020-09-11"; item: "2020-09-12")
    recalc: recalculate(table: $#ntn; where: 'date' = $#val_act)

// Выполняемый в коде действия последовательно пересчитает строки текущей таблицы в которой date равно датам из list_date_act.

Дополнительные пояснения

listReplace проще чем все думают. Он обрабатывает указанный в параметре list список от начала до конца. Если зашел список 5 значений на выходе будет список из 5 значений.

Каким образом меняются значения. Они меняются в параметрах action.

Если на входе у нас список [1,5,16,4] (например это какие-то id и нам нужно им найти соответсвующие имена), то будет так: action: $value и в строке value уже будет поиск этого артикула для каждой строчки.

Пример:

=: listReplace(list: json`[1,5,16,4]`; action: $val; value: "row")
        val: select(table: 'test_projects'; field: 'nr_name'; where: 'id' = ?)

Я пока оставил в сравнении where вопросительный знак, что бы пояснить параметр value. Дело в том, что когда мы в строке val выполняем поиск, то нам надо сравнивать со стартовым значением, которое у нас есть в обрабатываемом списке. Это значение передается в переменную, название которой мы задаем в параметре value. Почему мы ее задаем сами, потому что у нас в одном коде может быть 10 разных listReplace и у них должны быть разные переменные. Переменная вызывается как обычно $#value_name. В моем примере $#row.

Я назвал ее row тк в реальности в эту переменную по очереди приходят значения каждой обрабатываемой строки в том порядке, в котором они в списке источнике в параметре list.

В моем примере на шаге 2 (нумерация начинается с 0): $#row = 16.

А что будет, если у нас на входе не list а rowlist. В этом случае там будет вся строка, например: {"name":"Alex","id":10}

Тогда если у нас на входе list сравнение будет where: 'id' = $#row, а если обрабатываем rowlist то where: 'id' = $#row[id] (надо указать из какой колонки rowlist взять сравнение).

Пример для list:

=: listReplace(list: json`[1,5,16,4]`; action: $val; value: "row")
        val: select(table: 'test_projects'; field: 'nr_name'; where: 'id' = $#row)

Теперь посмотрим что такое action: "item" = $val — эта штука для обработки rowlist. Те когда у нас на входе rowlist и мы хотим заменить значение только в одной его колонке или добавить новую колонку то вот тогда используется этот вариант.

Пример c rowlist:

=: listReplace(list: #some_rowlist; action: "second_name" = $val; value: "row")
        val: select(table: 'test_projects'; field: 'nr_name'; where: 'id' = $#row[id])

В этом примере он мне в каждой строке моего rowlist добавит колонку second_name: {"name":"Alex","id":10; "second_name":"Some found name"} этот second_name он ищет для каждой строки по ключу id.

Получается что action: $val — это замена всего значения строки на новое, а action: "second_name" = $val это изменение одной колонки или добавление новой. Второе понятно работает только если на входе rowlist.

Если же на входе rowlist то можно несколько action: "item_1" = $val_1; action: "item_2" = $val_2.

А можно ли для входящего list несколько action: $val. Можно, но только в кодах-действия, потому что в кодах действия это будут выполняемые действия. Если просто в код, то это получается абсурд, тк вы последующим action перезаписываете предыдущий.

Что такое key. Если в value передается значение обрабатываемой на шаге строки, то в key передается ее номер (нумерация списков начинается с 0). Для списка [1,5,16,4] при обработке строки со значением 16 в переменной в key будет ... 2.

Зачем это нужно? Дело в том, что в list можно скормить не только list и rowlist, но и row.

Например у нас есть такой row: {"490":"Alex","520":"Mike","530":"John"} и мы хотим для всех у кого ключи больше 500 добавить * (например это количество баллов системы лояльности):

=: listReplace(list: json`{"490":"Alex","520":"Mike","530":"John"}`; action: $val; key: "key"; value: "value")
        val: if(condition: $#key > 500; then: str`$#value ++ "*"`; else: $#value)

Обратите внимание, что новое значение присваивается на каждом шаге — listReplace ничего не пропускает, но если нам не нужно менять значение на шаге, то мы можем новое присвоить без изменения из $#value!

Вот и все!

Строки

rowCreate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowCreate(field: "" = )

Возвращает ассоциативный массив с основаниями в виде name полей, указанных в field: и значениями указанными после =.

Необязательный множественный параметр

• field — множественный параметр, элементы, из которых создается массив. Количество параметров field: определяет количество элементов в массиве.

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

example: rowCreate(field: 'name' = "Alexey"; field: 'age' = 35)

//Результат: {"name": "Alexey", "age": 35}

rowListCreate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowListCreate(field: "" = $list)

Возвращает список ассоциативных массивов с ключами в виде name полей указанных в field: значениями указанными после =. Строки создаются в порядке сортировки списков передаваемых в field:.

Обязательные параметры

• field — множественный параметр, элементы, из которых создается список ассоциативных массивов. Количество параметров field: определяет количество элементов в массиве.

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

example: rowlistCreate(field: 'name' = $names; field: 'age' = $ages)
    names: listCreate(item: "Alexey"; item: "Pavel")
    ages: listCreate(item: 32; item: 35)

// Результат: 
// [
// {"name": "Alexey", "age": 32},
// {"name": "Pavel", "age": 35}
// ]

rowCreateByLists

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowCreateByLists(keys: $keysList; values: $valuesList)

Возвращает ассоциативный массив или false.

Обязательные параметры

• keys — список, содержащий строки или числа, которые станут ключами для массива.

• values — список, содержащий любые данные, которые станут значениями.

Размеры листов keys: и values: должны совпадать.

example: rowCreateByLists(keys: $keysList; values: $valuesList)
    keysList: listCreate(item: "min"; item: "middle"; item: "max")
    valuesList: listCreate(item: "cherry"; item: "apple"; item: "watermellon")

// Результат: {"min":"cherry", "middle": "apple", "max": "watermellon"}

rowAdd

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowAdd(row: ; row: ; field: "" = )

Возвращает ассоциативный массив, дополненный и исправленный последующими row: и field:.

Обязательные параметры

• row — ассоциативный массив, который будет дополняться или изменяться.

  • Множественный параметр, если указано несколько, то массивы будут сложены в указанном порядке.

Необязательные параметры

• field — элементы, которые будут добавлены в конец массива в указанном порядке. Первым элементом выражения являются основания field: "base" = $value.

  • $value может задаваться как одинарные значения и списки чисел, строк, дат и булевых значений.
  • Порядок элементов в массиве будет соответствовать тому порядку, в котором они указаны в функции.
  • Множественный параметр, если указано несколько, то элементы будут добавлены в указанном порядке.

• path — список с ключами, который показывает в какое место row-структуры нужно вставить данные.

• replace — true. Используется только совместно с path, для того чтобы заменить значение ключа полностью, а не добавлять значения.

example: rowAdd(row: $row1; field: "test2" = "2"; field: "test3" = "3")
    row1: rowCreate(field: "test1" = "1"; field: "test2"="1")

// Результат: 
// {
//  "test1": "1",
//  "test2": "2",
//  "test3": "3"
// }

// example_data
// {
//  "data": [
//    {
//      "num": "some num 1",
//      "value": "some value 1",
//      "product": {}
//    },
//    {
//      "num": "some num 1",
//      "value": "some value 1",
//      "product": {}
//    }
//  ]
// }

example2: rowAdd(row: #example_data; field: "test2" = "2"; field: "test3" = "3"; path: $list)

    list: listCreate(item: "data"; item: 0; item: "product")

// {
//   "data": [
//     {
//       "num": "some num 1",
//       "value": "some value 1",
//       "product": {
//          "test2": "2",
//          "test3": "3"
//        }
//     },
//     {
//       "num": "some num 1",
//       "value": "some value 1",
//       "product": {}
//     }
//   ]
// }

rowListAdd

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowListAdd(rowlist: ; rowlist: ; field: "" = ; field: "" = )

Возвращает список ассоциативных массивов, дополненный и исправленный последующими rowList: и field:.

Обязательные параметры

• rowlist — списки ассоциативных массивов, которые будут сложены, множественный параметр.

  • Добавляются или заменяются колонки.
  • Количество элементов в списках должно быть одинаковым и соответствующим по порядку.
  • Если количество элементов в списках разное, то недостающие элементы будут пустотой.

Необязательные параметры

• field — колонки, которые будут добавлены в массив в указанном порядке. В двойных кавычках указываются основания field: "base" = $value. Множественный параметр.

  • Может задаваться как одинарные значения и списки чисел, строк, дат и булевых значений.
  • Порядок элементов в массиве будет соответствовать тому порядку, в котором они указаны в функции.
  • Если правым параметром является не список — добавляется одинаковое значение во все строки списка.

example: rowListAdd(rowlist: $rowList1; rowlist: $rowList2; field: "test" = 1; field: "testlist" = $valListl; field: "test2" = 0)
    rowList1: jsonExtract(text: '[{"test1":1,"test2":1}, {"test1":2,"test2":2}, {"test1":3,"test2":3}]')
    rowList2: jsonExtract(text: '[{"test10":10}, {"test10":20}, {"test10":30}]')
    valListl: jsonExtract(text: '[5, 6, 7]')

// Результат: [
//  {
//    "test": 1,
//    "test1": 1,
//    "test2": 0,
//    "test10": 10,
//    "testlist": 5
//  },
//  {
//    "test": 1,
//    "test1": 2,
//    "test2": 0,
//    "test10": 20,
//    "testlist": 6
//  },
//  {
//    "test": 1,
//    "test1": 3,
//    "test2": 0,
//    "test10": 30,
//    "testlist": 7
//  }
// ]

rowKeys

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowKeys(row: )

Возвращает список из ключей ассоциативного массива.

Обязательные параметры

• row — ассоциативный массив, по которому будут взяты ключи.

example: rowKeys(row: $row)
    row: rowCreate(field: "test1" = "1"; field: "test2" = "1")

// Результат: [
//  "test1",
//  "test2"
// ]

rowValues

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowValues(row: )

Возвращает значения переданного ассоциативного массива.

Обязательные параметры

• row — ассоциативный массив по которому будут взяты значения.

example: rowValues(row: $row)
    row: rowCreate(field: "test1" = "1"; field: "test2" = "1")

// Результат: 
// [
//  "1",
//  "1"
// ]

rowKeysReplace

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowKeysReplace(row: ; from: ; to: ; recursive: false)

Возвращает ассоциативный массив c ключами замененными с from: на to:.

Обязательные параметры

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

• from — одна или список строк которые будут искаться в ключах массива.

• to — одна или список строк на которые будут заменены совпадения из from: в ключах массива.

• Если во from: и to: передаются списки, то замены будут произведены попарно.

Необязательные параметры

• recursive — проверять вложенные ключи для списков ассоциированных массивов.

  • true — искать внутри.
  • false — не искать (по умолчанию).
  • "3" — искать внутри на указанном уровне. В том числе можно передать как список. Уровни нумеруются от 0 — верхний, первое вложение — 1 итд.

example: rowKeysReplace(row: $rowList; from: "a"; to: "c"; recursive: true)
    rowList: jsonExtract(text: '[{"a": 1, "b": 2}, {"a": 4, "d": 4}]')

// Результат: [{"c": 1,"b": 2},{"c": 4,"d": 4}]

rowKeysRemove

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: rowKeysRemove(row: ; key: ; keys: ; recursive: false)

Возвращает ассоциированный массив с удаленными ключами (колонками) key: или keys:.

Обязательные параметры

• row — исходный список или ассоциированный массив.

Необязательные параметры

• key — строк, name-ключа (колонки) которую нужно удалить, множественный параметр.

• keys — список строк name-ключей (колонок), которые нужно удалить.

• recursive — проверять вложенные ключи для списков ассоциированных массивов.

  • true — искать внутри.
  • false — не искать (по умолчанию).
  • "3" — искать внутри на указанном уровне. В том числе можно передать как список. Уровни нумеруются от 0 — верхний, первое вложение — 1 итд.

example: rowKeysRemove(row: $rowList; key: "a"; recursive: true)
    rowList: jsonExtract(text: '[{"a": 1, "b": 2}, {"a": 4, "d": 4}]')

// Результат: [{"b": 2},{"d": 4}]

Логика

if

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: if(condition: ; then: ; else: )

Возвращает при верном условии condition: значение секции then:, в противном случае — значение секции else: либо null, если она не задана.

Обязательные параметры

• condition — условие срабатывания вида "значение 1" = "значение 2".

  • Множественный параметр.
  • Выполняется последовательно.
  • Если одно из condition: выполнилось в false, то ни последующие, ни then: рассчитаны не будут.
  • Обе части могут передаваться как: число, строка, дата или булево значение.
  • Обе части могут быть как одним значением, так и списком. В зависимости от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Возможны все операторы сравнения.

Необязательные параметры

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

• then — значение, либо ссылка на строку или параметр, которые будут рассчитаны в случае, если все condition: выполнились в true.

• else — значение, либо ссылка на строку или параметр, которые будут рассчитаны в случае, если хотя бы один condition: выполнился в false.

example1: if(condition: $test1 = 1; condition: $test11 = 2; then: true; else: false)
    test1: 1
    test11: 3
// Результат: false 

example2: if(condition: $p1_2 < $p2_2; condition: $p2_2 < $p3_2; then: "Start"; else: "Stop")
p1_2: 10
p2_2: 20
p3_2: 30

// Результат: "Start"

example3: if(condition: $p1_3 > $p2_3; then: true)
p1_3: 10
p2_3: 20

// Результат: ""

while

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: while(preaction: ; condition: ; limit: ; action: ; postaction: ; iterator: )

Выполняет действия action:, если выполняются условия condition: с количеством повторений limit:, изменяя iterator: на +1 в каждой итерации. Возвращает значение последнего preaction|action|postaction в зависимости от их наличия в функции.

Необязательные параметры

• preaction — значение строки кода, действие, выполняемое в любом случае до обработки секций condition и обработки итераций.

  • Множественный параметр — если указано несколько параметров, то они будут выполнены в той последовательности, в которой указаны в функции.
  • Последний preaction помимо действия или вместе с ним (зависит от [функции действия][24]) возвращает значение, если нет последующих action, postaction или они не выполнены по условиям condition.

• limit — число, максимальное количество итераций, если condition в каждой итерации проходят в true.

• condition — условие срабатывания вида "значение 1" = "значение 2".

  • Множественный параметр.
  • Выполняется последовательно.
  • Если одно из condition: выполнилось в false, то последующие condition, action, а также последующие операции не будут выполнены.
  • Обе части могут передаваться как: число, строка, дата или булево значение.
  • Обе части могут быть как одним значением, так и списком. В зависимости от этого и от этого могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Возможны все операторы сравнения.

• action — значение строки кода, выполняемое действие внутри итерации. Повторяется в каждой итерации.

  • Множественный параметр — если указано несколько параметров, то они будут выполнены в той последовательности, в которой указаны в функции.
  • Последний action помимо действия или вместе с ним (зависит от [функции действия][24]) возвращает значение.

• postaction — значение строки кода, выполняется после всех итераций. При условии, что выполнен хотя бы один action!

  • Множественный параметр — если указано несколько параметров, то они будут выполнены в той последовательности, в которой указаны в функции.
  • Последний action помимо действия или вместе с ним (зависит от [функции действия][24]) возвращает значение.

• iterator — счетчик номера итерации.

  • Нумерация итераций начинается с 0 (ноля).
  • Задается как одна строка и обозначает название итератора для возможности обращения к нему как к переменной внутри кода. Назначайте разные переменные если используете несколько while с итераторами в одной секции кода.
  • При отсутствии нет возможности обращения к значению итератора.

example: while(action: $set1; action: $set2)
    set1: set(table: 'table1'; field: 'field1' = 1)
    set2: set(table: 'table2'; field: 'field2' = 2)

// Результат: Присвоит полям field1 и field2 в таблицах table1 и table2 значения 1 и 2 соответственно.

var

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: var(name: ""; value: ; default: )

Сохраняет и отдает значение переменной внутри секции кода конкретного поля.

Обязательные параметры

• name — одна строка, имя переменной по которому идет обращение к данным.

  • Необходимо следить, чтобы в пределах одной секции кода name: не повторялись и не пересекались со значениями других переменных внутри кода.

Необязательные параметры

• value — значение, присваиваемое переменной и возвращаемое функцией.

  • Может передаваться как: число, строка, дата или булево значение
  • Может быть как одним значением, так и списком.
  • Если отсутствует, то переменная возвращает последнее записанное значение.

• default — один раз за исполнение секции кода присваивает значение переменной в том случае если при обращении к ней она не определена.

  • Может передаваться как: число, строка, дата или булево значение
  • Может быть как одним значением, так и списком.

example1: while(action: $set; limit: 30; iterator: "iter1")
set: var(name: "count"; value: $plus)
plus: listAdd(list: $var; item: $i)
var: var(name: "count"; default: $#lc)
i: dateAdd(date: $#nd; days: $days)
days: $#iter1 * -1

example2: while(preaction: $zero2; action: $set2; limit: 30; iterator: "iter2")
zero2: var(name: "count"; value: $#lc)
set2: var(name: "count"; value: $plus2)
plus2: listAdd(list: $#count; item: $i2)
i2: dateAdd(date: $#nd; days: $days2)
days2: $#iter2 * -1

example3: $while{var: "count" = $#lc}
while: while(action: $set3; limit: 30; iterator: "iter3")
set3: var(name: "count"; value: $plus3)
plus3: listAdd(list: $#count; item: $i3)
i3: dateAdd(date: $#nd; days: $days3)
days3: $#iter3 * -1

В логике Тотума вместо циклов существенно более эффективно использовать рекурсии или функцию listReplace, обрабатывающую списки построчно.

globVar

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: globVar(name: ""; value: ; default: ; date: ; block: )

Сохраняет и отдает значение переменной глобально независимо от транзакций. Короткое обращение @$name_glob_var

Запись происходит вне транзакционной модели, в тот момент, когда вызывается функция с передачей name и value.

Обязательные параметры

• name — одна строка, имя переменной по которому идет обращение к данным.

Необязательные параметры

• value — значение, присваиваемое переменной и возвращаемое функцией.

  • Если отсутствует, то переменная возвращает последнее записанное значение или null.
  • Актуализирует date переменной

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

  • Выставляет date переменной, если ее не было.

• date — работает при любом наборе необязательных параметров

  • true - функция возвращает структуру вида {"date": "2024-07-19 13:19:47","secpart": "303308","value": "some value"}

• block — число в секундах или false. Используется только если нет value, только при запросе переменной. Позволяет установить блокировку запроса для другого процесса, который будет ждать пока истечет блокировка.

  Предназначено для использования в конкурентных процессах, проверяющих и изменяющих значение переменной. Например если false то устанавливаем true и по завершении процесса меняем на false. Если true, то ничего не делаем. В момент проверки и записи true может вклиниться конкурирующий процесс и записать true, таким образом будут исполняться два процесса, хотя второй должен был быть отклонен.

  Чтобы этого избежать, при запросе значения устанавливается блокировка, которая снимается по истечении указанного времени, либо при записи переменной или запросе ее значения с передачей block: false.

  Блокировка на чтение работает только для запросов устанавливающих или снимающих блокировку через параметр block. При получении переменной @$name_glob_var ее значение будет возвращено сразу.

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

Рекомендуется использовать вместе с tryCatch — в этом случае в catch записывается обнуление переменной или установку ее в стартовое значение, которое произойдет если транзакция будет отменена.

procVar

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: procVar(name: ""; value: ; default: )

Сохраняет и отдает значение переменной в процессе php. Короткое обращение $@name_proc_var

Обязательные параметры

• name — одна строка, имя переменной по которому идет обращение к данным.

Необязательные параметры

• value — значение, присваиваемое переменной и возвращаемое функцией.

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

exec

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: exec(code: ; var: "" = ; var: "" = ; ssh: )

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

Обязательные параметры

• code — код для выполнения в синтаксисе Totum.

  • Может передаваться только как одна строка содержащая код в синтаксисе Totum.
  • Исполняемый код выполняется как код той секции, из которой вызывается.

  Может быть передан в таком синтаксисе:

  =: exec(code: $code)
  
  ```code:totum
  
  =: set(table: 'table'; field: 'field' = $value)
  
  value: "some_value"
  
  ```
  

  В этом случае код внутри блока code обрабатывается как текст и его $ и $# не пересекаются с кодом текущего поля. :totum означает подсветить как код тотума.

  В code: возможно передать name другого поля в текущей таблице, тогда код будет взят из него из соответствующего типа кода. При вызове из кода — код, при вызове из кода-действия — код-действия, итд... В этом случае если кликнуть на "name" будет показана кнопка, открывающая на редактирование целевой код во всплывающем окне.

  Также в code можно использовать обращение @table.field или @table.field.key_field[key]. В этом случае если кликнуть на @... будет показана кнопка открывающая на редактирование целевой код во всплывающем окне.

Необязательные параметры

• var — определение переменной и ее значения для передачи в код определенный в code:.

  • Может передаваться как: число, строка, дата или булево значение.
  • Может быть как одним значением, так и списком.
  • Множественный параметр (можно передать несколько переменных).
  • Необходимо следить, чтобы в пределах одной секции кода var: не повторялись и не пересекались со значениями других переменных внутри кода.
  • Обращение к переменным из кода определенного в code: идет через обращение к переменным внутри кода.

• ssh — true, если нужно отделить действие в отдельный процесс и вывести из текущей цепочки. Использование должно быть разрешено в Conf.php.

  • Отделенные процессы не перезапускаются по ошибке одновременного доступа.
  • Все отделенные процессы будут выполнятся параллельно, что ведет к одновременной загрузке всех доступных процессорных ядер.

example: exec(code: @table.h_code_text.name[some_code]; var: "varname" = 10)

// h_code_text 
// "=: 10 + $#varname"

// Результат: 20

errorException

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: errorException(text: )

Прерывает выполнение всей цепочки кодов и экшенов, отменяя все совершенные изменения.

Если цепочка отлавливает исключения через функцию tryCatch, то выполнение продолжится с блока Catch: этой функции.

Указанное в text: сообщение попадет в переменную с названием, заданным параметром error: вызова функции tryCatch.

Обязательные параметры

• text —число или строка, описание ошибки для пользователя.

example: if(condition: $#nfv="Недопустимое значение"; then: $error)
    error: errorException(text: "Вы ввели недопустимое значение. Ничего не сохранилось.")

// Результат: Если код выполнялся в рамках веб-сессии, пользователю выведется сообщение об ошибке с текстом: "Вы ввели недопустимое значение. Ничего не сохранилось." и указанием названия таблицы, в которой размещался код. 
// Если код выполнялся  api-скриптом, ему вернется сообщение об ошибке в формате этого api. 
// Крон получит exeption и может отправить письмо об ошибке администратору. 

tryCatch

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: tryCatch(try: ; catch: ; error: "exception")

Выполняет try:. Если при выполнении try: произошла ошибка, откатывающая транзакцию, выполняет catch: и передает в переменную error текст ошибки.

Обязательные параметры

• try — значение строки кода, основной код.

• catch — значение строки кода, который выполняется в случае возникновения любой ошибки в try:.

Необязательные параметры

• error — одна строка переменная, в которую будет передан текст ошибки в случае ошибки.

example1: tryCatch(try: $test1; catch: 2; error: "exception")
    test1: 1

// Результат: 1

example: tryCatch(try: $test2; catch: $#exception; error: "exception")
    test2: errorExeption(text: "test")

// Результат: test

Имеет сахар вида:

=name_row_for_catch: 

name_row_for_catch: 

Запись такого вида означает, что это tryCatch где в catch: указана строка кода name_row_for_catch и error: "exception".

Рекомендуется использовать вместе с глобальными переменными, записывая в catch откат к исходным значениям в случае ошибки в try.

=catch: 1

catch: 2

// Результат: 1

=catch: errorExeption(text: "test")
    catch: $#exception 

// Результат: test

Проброс в catch при ошибке одновременного доступа гарантировано останавливает автоматический перезапуск действия!

Пересчет, вставка и изменение

reCalculate

Доступен в секциях: Код; Код действия; Код селекта; Форматирование ячейки, строки, таблицы.

=: reCalculate(table: ''; cycle: ; hash: ; where: '' = ; field: '')

Пересчитывает указанную таблицу определенную в table: в соответствии с ее единицей пересчета.

Эта функция может вызываться из любой секции кода, чтобы можно было пересчитать таблицу, из которой берутся данные перед тем, как брать данные! Эта возможность позволяет увести в бесконечный цикл любую таблицу! Инструкцию по реанимации смотреть здесь.

Обязательные параметры

• table — name-параметр name таблицы для пересчета.

Необязательные параметры

• cycle — определяет цикл, если таблица table: является расчетной в цикле.

  • Может передаваться только как одно или список чисел.
  • Параметр отсутствует, если таблица table: находится в дереве.

• hash — строка, hash таблицы для пересчета временных таблиц .

• where — name-параметр условие выбора строки в строчной части. Левая часть определяет поле сравнения в таблице table:, а правая — значение сравнения.

  • Множественный параметр — если указано несколько параметров where:, то выборка осуществляется на пересечении их условий, применяемых слева направо.
  • Возможны любые операторы сравнения.
  • Может передаваться как число, строка, дата или булево значение
  • Может быть как одним значением, так и списком. В зависимости от этого, и от того, что содержится в where: могут получаться различные комбинации сравнений: один к одному, один ко многим, многие ко многим.
  • Если по условиям для таблиц со строчными единицами пересчета не выбирается ни одной строки, то будет пересчитан только хедер.
  • Если в table: определена таблица с табличной единицей пересчета, то независимо от наличия/отсутствия параметра и результатов его работы будет пересчитана вся таблица.

Если в where: передать значение *ALL*, то этот where: будет выключен! Это можно сделать через отдельную строку, например:

=: reCalculate(table: 'table_name'; where: 'search_field' = $if)
if: if(condition: #connected_field = ""; then: "*ALL*"; else: #connected_field)

Список из одного значения ["*ALL*"] будет обработан так же как и "*ALL*".