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


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


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

Structure.Kernel.Wacko

./classes/extension.php

Наследует WackoOld.
Конструктор класса Wacko – основного класса в системе. В конструкторе
* Подгружаются библиотeки сервисов (в QSMini)
* Для всех сервисов выполняется инициализация (обработчик INIT)
* В случае, если пришел AJAX-запрос, подгружается необходимый класс и происходит предобработка переменных.
  • config – Массив из переменных конфигурации. Обычно берется из файла wakka.config.php

Function.WikiPages

Наследует WackoOld.
Конструктор класса Wacko – основного класса в системе. В конструкторе
* Подгружаются библиотeки сервисов (в QSMini)
* Для всех сервисов выполняется инициализация (обработчик INIT)
* В случае, если пришел AJAX-запрос, подгружается необходимый класс и происходит предобработка переменных.
  • config – Массив из переменных конфигурации. Обычно берется из файла wakka.config.php

Подразделы

RemoveActions

Функция удаляет экшны, инсталлированные на странице. Инсталляция экшнов иногда нужна из соображений безопасности и проводится администратором.
Эта функция вызывается автоматически при удалении страницы. Использовать её вручную нужно довольно редко
  • pgid – ID страницы
CanAction

Функция проверяет, может ли данный экшн выполняться на странице. Для этого он обращается в таблицу actions.
  • action – Идентификатор экшна (не обязательно название файла, хотя обычно – да)
  • pageid – Страница, на которой экшн должен использоваться
  • cond – Дополнительные условия в формате SQL-запроса. По умолчанию пусто.
Возвращает: dbrow Массив-запись о данном экшне, если он присустствует в БД, пусто в противном случае. В любом случае возвращает не больше одной строки.
CanThisPageAction

Функция проверяет, может ли данный экшн выполняться на данной странице. Кроме того, для администратора выводит ссылку, по которой он может установить или снять права для данного экшна на данной странице.
При таком варианте дополнительные поля записи в таблице устанавливаются автоматически, без настройки. Также возвращает TRUE при установленном $this->cur_security.
Это фича для возможности устанавливать экшн без установления прав.
  • action – Идентификатор экшна (не обязательно название файла, хотя обычно – да)
Возвращает: dbrow Массив-запись о данном экшне, если он присустствует в БД, пусто в противном случае. В любом случае возвращает не больше одной строки.
AddSimpleSpaces

Форматирует имя Вики с добавлением ПРОСТЫХ пробелов.
  • string – Вики-имя
LoadIdByTag

Форсированно (с обращением в БД) загружает ID страницы по её тегу.
UseAutoJs

Выводит теги HTML, обеспечивающие подгрузку JS-файлов из папки 'js/autoinc'.
srvAllMakeJS

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

Подгружает языковые файлы для расширений.
ajxElement

Рендерит элемент темы, располагающегося в папке "<папка темы>/elements".
  • elem – Название файла элемента без расширения
Возвращает: string Текст отрендеренного элемента
ajxElementsAllRun

Рендерит все элементы темы.
ajxPhpElement

Рендерит указанный AJAX-элемент и готовит его к отправке по запросу.
IsAjax

Проверяет, делается ли текущий запрос с использованием AJAX
Возвращает: boolean
StartVirtual

Запускает создание виртуального элемента в целях AJAX. Используется в связке с FinishVirtual.
FinishVirtual

Завершает создание виртуального элемента AJAX. Весь вывод, который происходил между StartVirtual и FinishVirtual выводится, а также,
в случае обнаружения запроса AJAX на элемент $kname, посылается в ответ.
  • kname – Имя AJAX-элемента. Если он запрашивался, то он отсылается в ответ.
ajxDynAction

Выводит в поток вывода подгружаемый AJAX-элемент экшна.
  • string – Идентификатор элемента.
  • string – Текущее содержание элемента.
  • integer – Если не 0, то время переподгрузки элемента. Может использоваться для создания часов.
Arefresh

И в случае AJAX, и в случае обычного запроса заставляет браузер обновить текущую страницу.
ajxAddJs

Заставляет выполниться фрагмент кода JS вне зависимости от того, использовался AJAX при запросе, или нет.
  • string – JS-код.
ajxHref

Формирует ссылку, по нажатию на которую делается AJAX-запрос.
  • string – URL, по которому делается запрос.
  • string – Требуемые экшн-элементы, через ';'
  • string – Текст ссылки
  • string – Необязательный параметр; ID формы, которая отсылается при запросе.
Возвращает: string HTML-код ссылки
ajxFormOpen

Открывает форму, которая отправляется AJAX-запросом.
  • string – Уникальный ID формы
  • string – Требуемые элементы темы в запросе, через ';'
  • string – Требуемые экшн-элементы в запросе, через ';'
Возвращает: string HTML-код, открывающий форму
vfrmField

Работа с виртуальными формами.
Процедура возвращает код поля для ввода информации. Для этого вызывается экшн типа
“vfrm”(тип) с параметром $this->vfrm["state”] = “field”, означающий, что необходимо сгенерировать
код поля.
  • string – Имя, по которому впоследствии можно будет получить значение поля ввода (идентификатор)
  • string – Имя типа. Может быть простым или иметь несколько параметров, типа “int” или «int low=0 high=100”
  • string – Значение, так как, возможно, мы хотим отредактировать поле.
Возвращает: string Код поля для вывода на страницу.
vfrmProcess

Работа с виртуальными формами.
Процедура возвращает значение поля с именем $name и приводит его к типу $type.
  • string – Имя типа. Может быть простым или иметь несколько параметров, типа “int” или «int low=0 high=100”
  • string – Идентификатор (имя) поля ввода.
Возвращает: string Значение переданного поля ввода соответствующего типа.
vfrmActionState

Работа с виртуальными формами.
Процедура возвращает значение, позволяющее определить, что требуется от экшна, представляющего тип данных виртуальной формы («vfrm*.php»). Если возвращается “field”, требуется код поля ввода, “process” – требуется обработка поля ввода.
Возвращает: string “field”|"process” – см. описание функции.
cntReserve

Процедура резервирует необходимое кол-во идентификаторов для последующего применения и возвращает ключ, по которому,
используя функцию cntGet, можно получить очередной идентификатор.
  • integer – Кол-во резервируемых идентификаторов
cntGet

Процедура возвращает очередной идентификатор по ключу, возвращенному функцией cntReserve. В случае превышения
числа вызовов по ключу, срабатывает die();
  • key – Ключ, возвращенный cntReserve;
cntGetOne

function cntGetOne()
Процедура возвращает один идентификатор. Этой процедурой можно пользоваться лишь в том случае, если вам потребуется в данном районе только 1 идентификатор.
NewSmarty

function NewSmarty()
Создает новый обьект Smarty.
OneButtonAction

function OneButtonAction($btnid,$btntext)
Генерирует кнопку и проверяет, нажата ли она.
Комментарии [0]  (показать)
Комментарии скрыты. Чтобы увидеть комментарии нажмите сюда.