Класс fcf.NServer.Application
Синглтон объекта приложения на сервере, доступный через объект fcf.application
Описание класса
Методы
object getPackages() - Возвращает объект содержащий пакеты загруженные в системе в виде объектов fcf.NSystem.NPackage.Package, а в качестве ключа выступает имя пакета.
fcf.Actions getSystemActions() - Возвращает объект системных действий. В отличии от fcf.actions() getSystemActions блокирует перезапуск приложения до полного завершения операций.
Методы
fcf.Context createSystemContext(string | [string] a_groups, string | [string] a_roles)
Создает объект системного контекста с заданными группами и ролями.
Аргументы:
string | [string] a_groups - Имя группы или массив групп
string | [string] a_roles - Имя роли или массив ролей
Возвращаемое значение:
fcf.Context
Объект системного контекста
fcf.NSystem.Configuration getConfiguration()
Возвращает объект конфигурации приложения
Возвращаемое значение:
fcf.NSystem.Configuration
Объект конфигурации приложения
fcf.NSystem.Cron getCron()
Возвращает объект выполнения задач по расписанию, аналог CRON
Возвращаемое значение:
fcf.NSystem.Cron
fcf.EventChannel getEventChannel()
Возвращает объект канала сообщений приложения
Возвращаемое значение:
fcf.EventChannel
object getPackages()
Возвращает объект содержащий пакеты загруженные в системе в виде объектов fcf.NSystem.NPackage.Package, а в качестве ключа выступает имя пакета.
Возвращаемое значение:
object
Объект содержащий объекты fcf.NSystem.NPackage.Package, а в качестве ключа выступает имя пакета.
fcf.NFSQL.Projections getProjections()
Возвращает объект хранящий проекции приложения
Возвращаемое значение:
fcf.NFSQL.Projections
Объект хранящий проекции приложения
fcf.NRender.Render getRender()
Возвращает объект внутреннего рендера
Возвращаемое значение:
fcf.NRender.Render
Объект внутреннего рендера
fcf.NServer.Router getRouter()
Возвращает объект маршрутизатора приложения
Возвращаемое значение:
fcf.NServer.Router
Объект маршрутизатора
fcf.NFSQL.Storage getStorage()
Возвращает объект обращения к базе данных через механизм проекций и язык FSQL
Возвращаемое значение:
fcf.NFSQL.Storage
Объект обращения к базе данных через механизм проекций и язык FSQL
fcf.Actions getSystemActions()
Возвращает объект системных действий. В отличии от fcf.actions() getSystemActions блокирует перезапуск приложения до полного завершения операций.
Возвращаемое значение:
fcf.Actions
fcf.Context getSystemContext()
Возвращает системный контекст
Возвращаемое значение:
fcf.Context
Системный контекст с правами root
mixed getSystemVariable(string a_package, string a_name)
mixed getSystemVariable(srtring a_path)
Возвращает значение системной переменной.
Аргументы:
string a_package - Имя пакета в котором хранится системная переменная
string a_name - Имя системной переменной
srtring a_path - Путь системной переменной, где имя пакета и переменной разделены двоеточием. Пример: "fcf:defaultLanguage"
Возвращаемое значение:
mixed
fcf.Actions initialize()
Выполняет инициализацию серверного приложения.
Возвращаемое значение:
fcf.Actions
Примеры
Пример 1
Пример основного файла приложения в котором применяется метод initilize()
const fcf = require("fcf");
fcf.application.initialize()
.then(async ()=>{
return fcf.application.run();
})
.catch((a_error)=>{
fcf.log.err("APPLICATION", a_error);
})
boolean isRun()
Возвращает значение флага запуска сервера - приложения
Возвращаемое значение:
boolean
fcf.Actions->mixed loadSystemVariable(string a_package, string a_name)
fcf.Actions->mixed loadSystemVariable(string a_path)
[Асинхронный метод] Возвращает текущее значение системной переменной через запрос в базе данных, минуя кэш.
Аргументы:
string a_package - Имя пакета
string a_name - Имя системной переменной
string a_path - Путь системной переменной, который включает в себя имя пакета и имя переменной разделенных символом :
Возвращаемое значение:
fcf.Actions->mixed
Возвращает объект fcf.Actions, который по завершению метода хранит результат выборки.
fcf.Actions->fcf.NRender.Template render(object a_options)
[Асинхронный метод] Выполняет рендеринг шаблона и возвращает результат в виде объекта fcf.NRender.Template
Аргументы:
object a_options - Объект содержащий параметры рендеринга:
string template - путь или псевдоним шаблона.
object args - аргументы шаблона
fcf.RouteInfo route - [default = context.route] объект маршрута
fcf.Context context - [default = fcf.getContext()] объект контекста
Возвращаемое значение:
fcf.Actions->fcf.NRender.Template
Объект результата рендеринга
Примеры
Пример 1
Пример рендеринга кнопки:
let buttonTemplate = await fcf.application.render({
template: "@controls:button",
args: { title: "Click me" }
});
fcf.Action run()
Выполняет запуск приложения
Возвращаемое значение:
fcf.Action
Примеры
Пример 1
Пример основного файла приложения в котором применяется метод run()
const fcf = require("fcf");
fcf.application.initialize()
.then(async ()=>{
return fcf.application.run();
})
.catch((a_error)=>{
fcf.log.err("APPLICATION", a_error);
})
fcf.Actions setSystemVariable(string a_package, string a_name, mixed a_value)
fcf.Actions setSystemVariable(string a_path, mixed a_value)
[Асинхронный метод] Устанавливает значение существующей системной переменной. Системные переменные создаются через конфигурационный параметр systemVariables
Аргументы:
string a_package - Имя пакета
string a_name - Имя системной переменной
mixed a_value - Новое значение системной переменной
string a_path - Путь системной переменной, который включает в себя имя пакета и имя переменной разделенных символом :
Возвращаемое значение:
fcf.Actions