Документация
Автоматически сгенерированная документация по коду системы с разбиением на разделы и примеры.
| Меню | Документация | Подразделы | |||||||
Structure.Kernel.XcBase./xcbase.phpКласс системы, обеспечивающий функциональность микроядра. XcBase является родителем всех классов расширений и классов ядра. Обеспечивает функциональность подключения дополнительных сервисов. ПодразделыXcBase function XcBase($parent) Конструктор. В конструкторе устанавливается родитель, базовый путь, подгружается конфигурационный файл. srvInitKernelServices function srvInitKernelServices () Инициализирует ключевые сервисы ядра: DB, Users и Access. Автоматически вызывается родителем. Нужна для правильного конфигурирования микроядра и не может быть вынесена в конструктор. srvFilePath function srvFilePath() Возвращает полный путь к данному сервису. srvAbsolutePath function srvAbsolutePath() Возвращает логический адрес данного сервиса. Пример: если сервис SpawHtml является потомком ядра, возвратится Kernel/SpawHtml. srvMainKernel Возвращает адрес главного расширения (ядра) системы. Ядром считается обьект, у которого нет родителя. xcbGetConfigValue function GetConfigValue($name) Возвращает опции, заданные в конфигурации.
xcbsrvLoadAll function srvLoadAll() Подгружает таблицу сервисов из базы данных и кэширует её. Дальнейшие запросы на проверку, инсталлирован ли определенный сервис идут уже к прекэшированной таблице. Эта функция автоматически вызывается при инициализации класса и в ручных вызовах нуждается редко. srvFactory Создает объект по имени класса-расширения, предварительно проверяя, установлен ли он. srvFactoryNoAccess Создает обьект класса-расширения без проверки доступа. При повторном обращении с тем же параметром выдается тот же самый обьект, поскольку используется кэш. Т.е., любой класс-расширение является Singleton. srvRunAll Возвращает результат выполнения $serviceFunction для всех! доступных сервисов в виде ассоциативного массива. srvRunOne function srvRunOne($serviceObject,$serviceFunction, $params) Функция запускает определенный обработчик у одного из сервисов. Например, инсталляцию можно запустить вот так: srvRunOne($serviceSpawHtml, “onInstall”, ''); debugPrint function debugPrint($txt) Функция отладочной печати в файл. По умолчанию отключена – включается раскомментированием. onInstall function onInstall($params) Функция, отрабатывающая при инсталляции сервиса. По умолчанию возвращает TRUE, что означает, что сервис был успешно установлен. Если вам нужно осуществить некоторые действия при инсталляции, перегрузите её в потомке. onUninstall function onUninstall($params) Функция, отрабатывающая при дезинсталляции сервиса. По умолчанию возвращает TRUE, что означает, что сервис был успешно дезинсталлирован. Если вам нужно осуществить некоторые действия при дезинсталляции, перегрузите её в потомке. srvInstallService function srvInstallService($serviceName, $params) Функция, устанавливающая определенный сервис. В случае успеха возвращает TRUE. srvUninstallService function srvUninstallService($serviceName, $params) Функция, удаляющая определенный сервис. В случае успеха возвращает TRUE.
|