Документация
Автоматически сгенерированная документация по коду системы с разбиением на разделы и примеры.
| Меню | Документация | Подразделы | |||||||
Structure.Kernel.QSMini./classes/qsminikernel.phpКласс миниядра Quick Start. Миниядро доступно почти везде. Основной набор функций:
ПодразделыVarDblink Идентификатор связи с БД. VarQuerylog Список запросов к БД. QSMiniKernel Конструктор. Выполняет инициализацию БД и базовую подгрузку сервисов. Query Выполняет запрос к БД с использованием DBAL. LoadSingle Выбирает одну строку из возвращаемого результата в форме ассоциативного массива. LoadAll Возвращает все строки результата, как массив ассоциативных массивов. dbGetLatestId Возвращает последний вставленный ID. По идее, должна работать только для MySQL dbGetById Прикладная функция, вытаскивающая запись с данным ID. dbConstructSetArray Прикладная функция, конструирующая SQL-запрос после SET. insertInto Прикладная функция. Вставляет данные ассоциативного массива data в таблицу table. GetMicroTime Возвращает время с точностью до миллисекунд. Используется для измерения производительности. IncludeBuffered Запустить определенный PHP-файл и возвратить его вывод. GetConfigValue Возвращает опции, заданные в конфигурации. GetResourceValue Возвращает перевод строки для определенного языка. CookiesInQSMini Функции для работы с COOKIES. FormOpen function FormOpen($method = “ ", $tag = “ ", $formMethod = “post”, $formname=" ", $formMore=" ") Открывает форму с адекватной адресацией.
FormClose function FormClose() Возвращает сгенерированный конец формы. QSMiniAction function Action($action, $params, $forceLinkTracking = 0) Возвращает результат работы экшна.
QSMiniMethod function Method($handler,$method) Возвращает результат работы экшна.
LoadUser function LoadUser($name, $password = 0) Возвратить запись пользователя, если она есть.
GetUsername function GetUserName() Возвратить имя пользователя (опционально конвертирование IP-адресов в хосты). GetUser function GetUser() Возвращает пользователя, если он залогинен. SetUser function SetUser($user, $setcookie=1) Запоминает параметры пользователя внутри сессии.
LogUserIn function LogUserIn($user) Логинит пользователя.
LogoutUser function LogoutUser() Логаутит юзера. IsAdmin function IsAdmin() Возвращает true, если данный пользователь – администратор. CheckACL function CheckACL($user, $acl_list, $copy_to_this_acl = false, $debug=0) Проверяет права доступа.
QSMiniRun Запускает обработку. Рекомендуется переопределить.
GRV Синоним для GetResourceValue. srvLoadAll function srvLoadAll() Подгружает таблицу сервисов из базы данных и кэширует её. Дальнейшие запросы на проверку, инсталлирован ли определенный сервис идут уже к прекэшированной таблице. Префильтрует её в соответствии с видимостью сервисов. Эта функция автоматически вызывается при инициализации класса и в ручных вызовах нуждается редко. srvIsAllowed Возвращает true, если данный сервис разрешен администратором для данного сайта. srvForceLoadAll Форсированно переподгружает таблицу сервисов из БД. Практически не требуется. см. также LoadAll. srvIsInstalled Функция проверяет, инсталлирован ли определенный сервис. Для этого она загружает всю таблицу сервисов и прямым просмотром ищет наличие конретного.
IsServiceInstalled Синоним для srvIsInstalled. Лучше не употреблять. srvRunFile Запускает для определенного сериса определенный обработчик. Обработчиком в сервисе называется файл без расширения, располагающийся в подпапке сервиса (директория extensions) в подпапке run.
srvAllRunFile Запускает для определенный обработчик для ВСЕХ сервисов. Обработчиком в сервисе называется файл без расширения, располагающийся в подпапке сервиса (директория extensions) в подпапке run. R2.0 Берет данные из кэша в папке classes/cache_events. Для добавления обработчика нужно удалить соответствующий файл в этой папке.
IsService Синоним для srvIsInstalled. @deprecated srvRunFileContent Возвращет вывод определенного обработчика для определенного сериса. Обработчиком в сервисе называется файл без расширения, располагающийся в подпапке сервиса (директория extensions) в подпапке run.
srvClearCacheEvents Очищает кэш для событий. utilClearFolder function utilClearFolder($docpath,$findstr) Очищает папку от файлов, в которых содержится $findstr.
symAlnum Процедура проверки корректности ввода данных. Возвращает True, если в качестве параметра подана строка только из английских больших/маленьких букв или цифр. symSome Процедура проверки корректности ввода данных. Возвращает True, если строка состоит только из символов, входящих в шаблон (второй параметр). symPageTag function symPageTag($str) Процедура проверки корректности ввода данных. Возвращает True, если в качестве параметра подана строка, которая может являться именем страницы WW.
amfResultOk function amfResultOk($data) Для совместимости с протоколом Xmini 1.1 надо обернуть данные в этой функции. amfResultError function amfResultError($data) Для совместимости с протоколом Xmini 1.1 надо обернуть данные в этой функции. amfResultOkSessionCache function amfResultOkSessionCache($data,$cachestring) Если нужно прекешировать данные на клиенте, можно вернуть данные, обернутые в этой функции. Cachestring – параметр вызываемой функции. Пока поддаются кешированию только функции с одним аргументом. xmSWFHandlerCachePath function xmSWFHandlerCachePath($file) Возвращает путь к сервису с учетом даты/времени. Дает возможность прекешировать сервисы на стороне клиента, но своевременно их обновлять. getRootPath function getRootPath() Возвращает корневой путь. Необходима для универсальной работы с файлами.
|
|