Документация


Автоматически сгенерированная документация по коду системы с разбиением на разделы и примеры.


МенюДокументацияПодразделы
 / Extension /

Function.Extension

./_documentation/_documentation.php
Поддержка расширений (сервисов).

Подразделы

AdminExtArchive

Позволяет управлять расширениями – устанавливать, удалять, генерировать документацию.
srvAllMakeJS

Для всех сервисов рендерит обработчики MAKEJS, затем пишет их в файл «js/autoinc/autoext.js». Эта функция используется
для формирования специфичных JS при установке сервиса, скажем, с нужным языком.
srvLoadAll

function srvLoadAll()
Подгружает таблицу сервисов из базы данных и кэширует её. Дальнейшие запросы на проверку, инсталлирован ли определенный
сервис идут уже к прекэшированной таблице. Префильтрует её в соответствии с видимостью сервисов.
Эта функция автоматически вызывается при инициализации класса и в ручных вызовах нуждается редко.
srvIsAllowed

Возвращает true, если данный сервис разрешен администратором для данного сайта.
srvForceLoadAll

Форсированно переподгружает таблицу сервисов из БД. Практически не требуется.
см. также LoadAll.
srvIsInstalled

Функция проверяет, инсталлирован ли определенный сервис. Для этого она загружает всю таблицу сервисов и
прямым просмотром ищет наличие конретного.
  • name – Имя сервиса
Возвращает: boolean true, если сервис инсталлирован в системе; false в противном случае.
srvRunFile

Запускает для определенного сериса определенный обработчик. Обработчиком в сервисе называется файл без расширения,
располагающийся в подпапке сервиса (директория extensions) в подпапке run.
  • servname – Имя сервиса
  • filename – Имя обработчика
Возвращает: boolean true/false, в зависимости от того, существует ли обработчик
srvAllRunFile

Запускает для определенный обработчик для ВСЕХ сервисов. Обработчиком в сервисе называется файл без расширения,
располагающийся в подпапке сервиса (директория extensions) в подпапке run.
R2.0 Берет данные из кэша в папке classes/cache_events. Для добавления обработчика нужно удалить соответствующий файл в этой папке.
  • filename – Имя обработчика
IsService

Синоним для srvIsInstalled.
@deprecated
srvRunFileContent

Возвращет вывод определенного обработчика для определенного сериса. Обработчиком в сервисе называется файл без расширения,
располагающийся в подпапке сервиса (директория extensions) в подпапке run.
  • servname – Имя сервиса
  • filename – Имя обработчика
Возвращает: boolean true/false, в зависимости от того, существует ли обработчик
srvClearCacheEvents

Очищает кэш для событий.
srvInitKernelServices

function srvInitKernelServices ()
Инициализирует ключевые сервисы ядра: DB, Users и Access. Автоматически вызывается родителем.
Нужна для правильного конфигурирования микроядра и не может быть вынесена в конструктор.
srvFilePath

function srvFilePath()
Возвращает полный путь к данному сервису.
srvAbsolutePath

function srvAbsolutePath()
Возвращает логический адрес данного сервиса. Пример: если сервис SpawHtml является потомком ядра, возвратится Kernel/SpawHtml.
srvMainKernel

Возвращает адрес главного расширения (ядра) системы. Ядром считается обьект, у которого нет родителя.
xcbsrvLoadAll

function srvLoadAll()
Подгружает таблицу сервисов из базы данных и кэширует её. Дальнейшие запросы на проверку, инсталлирован ли определенный
сервис идут уже к прекэшированной таблице.
Эта функция автоматически вызывается при инициализации класса и в ручных вызовах нуждается редко.
srvFactory

Создает объект по имени класса-расширения, предварительно проверяя, установлен ли он.
srvFactoryNoAccess

Создает обьект класса-расширения без проверки доступа.
При повторном обращении с тем же параметром выдается тот же самый обьект, поскольку используется кэш. Т.е., любой класс-расширение является Singleton.
srvRunAll

Возвращает результат выполнения $serviceFunction для всех! доступных сервисов в виде ассоциативного массива.
srvRunOne

function srvRunOne($serviceObject,$serviceFunction, $params)
Функция запускает определенный обработчик у одного из сервисов. Например, инсталляцию можно запустить вот так: srvRunOne($serviceSpawHtml, “onInstall”, '');
onInstall

function onInstall($params)
Функция, отрабатывающая при инсталляции сервиса. По умолчанию возвращает TRUE, что означает, что сервис был успешно установлен.
Если вам нужно осуществить некоторые действия при инсталляции, перегрузите её в потомке.
onUninstall

function onUninstall($params)
Функция, отрабатывающая при дезинсталляции сервиса. По умолчанию возвращает TRUE, что означает, что сервис был успешно дезинсталлирован.
Если вам нужно осуществить некоторые действия при дезинсталляции, перегрузите её в потомке.
srvInstallService

function srvInstallService($serviceName, $params)
Функция, устанавливающая определенный сервис. В случае успеха возвращает TRUE.
srvUninstallService

function srvUninstallService($serviceName, $params)
Функция, удаляющая определенный сервис. В случае успеха возвращает TRUE.
Комментарии [0]  (показать)
Комментарии скрыты. Чтобы увидеть комментарии нажмите сюда.