Функции могут быть вызваны как UseModule("WorkCalendar")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| AddBusinessDuration | Добавление рабочего времени
 Подробнее...
Прибавляет к дате заданную длительность в рабочих минутах и возвращает абсолютный срок, версию календаря и trace расчета. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String|Integer|null | $start | Обязательный | Начальный момент расчета. | | Integer | $durationMinutes | 0 | Длительность в рабочих минутах. | | Array | $options | array (
) | Параметры расчета, включая maxDays. |
|
| ApplyRecordIndexes | Индексация записи WorkCalendar
Подробнее...
Нормализует ключевые поля записи WORKCALENDAR и заполняет поисковые индексы 1288 для ключа, названия, часового пояса, активности и системности. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись календаря, которую нужно подготовить к сохранению. |
|
| BuildImpactReport | Dry-run влияния изменения календаря
Подробнее...
Строит безопасный dry-run отчет о записях потребителей, которые могут потребовать пересчета после изменения версии рабочего календаря. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Новая версия календаря WorkCalendar. | | Array | $objects | array (
) | Снимки объектов потребителей с objectType, objectKey, calendarKey, calendarVersion и deadline. | | Array | $options | array (
) | Параметры отчета: affectedFrom, affectedTo, policy. |
|
| CalculateBusinessDuration | Расчет рабочего интервала
Подробнее...
Считает количество рабочих минут между двумя моментами по WorkCalendar и возвращает trace использованных рабочих окон. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String|Integer|null | $from | Обязательный | Начало периода расчета. | | String|Integer|null | $to | Обязательный | Окончание периода расчета. | | Array | $options | array (
) | Параметры расчета, включая trace. |
|
| FindNextWorkingTime | Поиск ближайшего рабочего времени
Подробнее...
Находит ближайший рабочий момент не раньше указанного времени по правилам WorkCalendar. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String|Integer|null | $moment | Обязательный | Начальный момент поиска; если не указан, используется текущее время. | | Array | $options | array (
) | Параметры поиска, включая maxDays и trace. |
|
| GetCalendarByKey | Поиск рабочего календаря по ключу
Подробнее...
Ищет рабочий календарь по стабильному ключу сначала среди записей WORKCALENDAR, затем среди системных JSON definitions модуля. | | Тип | Параметр | По умолчанию | Описание | | String | $calendarKey | '' | Стабильный ключ рабочего календаря. | | String | $dbn | '' | БД системных записей; если не указана, используется I128F. |
|
| GetSystemDefinitions | Чтение системных описаний WorkCalendar
Подробнее...
Читает JSON-файлы из каталога modules/WorkCalendar/system и возвращает календарь, holiday packs и профили без записи данных в БД. | Отсутствуют |
| GetWorkingWindows | Рабочие окна дня
Подробнее...
Возвращает рабочие интервалы календаря на конкретную дату с учетом недельного расписания, исключений, праздников и часового пояса. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String|Integer|null | $date | Обязательный | Дата или момент, для которого нужно построить рабочие окна. | | Array | $options | array (
) | Резерв для будущих режимов расчета. |
|
| HealthCheckDefinition | Диагностика WorkCalendar
Подробнее...
Выполняет HealthCheck рабочего календаря или системных JSON-описаний WorkCalendar: проверяет читаемость definitions, расписание, часовые пояса, исключения и дубли ключей. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Один календарь для проверки. Если не указан, проверяются системные JSON-описания модуля. | | Array | $options | array (
) | Дополнительные параметры диагностики. |
|
| IsWorkingTime | Проверка рабочего времени
Подробнее...
Определяет, попадает ли момент времени в рабочий интервал WorkCalendar с учетом часового пояса, недельного расписания и исключений. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String|Integer|null | $moment | Обязательный | Проверяемый момент; если не указан, используется текущее время. | | Array | $options | array (
) | Дополнительные параметры расчета. |
|
| NormalizeCalendarDefinition | Нормализация рабочего календаря
Подробнее...
Проверяет и приводит описание WorkCalendar к единому виду: ключ, название, часовой пояс, версию, недельное расписание, исключения, availability, дежурства и окна изменений. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Описание рабочего календаря в виде массива или данных из системного JSON. |
|
| RecordToCalendarDefinition | Преобразование записи WorkCalendar в definition
Подробнее...
Собирает массив описания рабочего календаря из полей записи WORKCALENDAR, включая JSON-секции расписания, исключений, availability, дежурств и окон изменений. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись типа WORKCALENDAR. |
|
| ResolveResourceAvailability | Доступность ресурса
Подробнее...
Определяет временную доступность пользователя, группы, подразделения или ресурса по availability overlays WorkCalendar и возвращает безопасное описание причины. | | Тип | Параметр | По умолчанию | Описание | | Array | $calendar | Обязательный | Описание календаря WorkCalendar. | | String | $resourceType | '*' | Тип ресурса: user, group, organisation, resource или *. | | String | $resourceKey | '*' | Ключ ресурса или *. | | String|Integer|null | $moment | Обязательный | Момент проверки доступности. | | Array | $options | array (
) | Параметры, включая showReason для вывода причины при наличии права. |
|
| ValidateCalendarDefinition | Проверка рабочего календаря
Подробнее...
Проверяет описание календаря WorkCalendar и возвращает нормализованное представление, ошибки и предупреждения без изменения данных. | | Тип | Параметр | По умолчанию | Описание | | Array | $definition | array (
) | Описание рабочего календаря, которое нужно проверить. |
|