Описание xAjax
Написав    Середа, 12 вересня 2007, 02:47    PDF Друк e-mail
Розробник
Знания xAjax состоит не только в умении написать страницу, которая будет рботать без перезагрузки, но и в умении настраивать и изменять много параметров, которые могут кардинально изменить работу xAjax.
1.Глобальные Константы
 
XAJAX_DEFAULT_CHAR_ENCODING string (по умолчанию "utf-8")
Используется как в классах xajax так и xajaxResponse. Вы можете сами задать значение этой константы.

XAJAX_GET int (по умолчанию 0)
Показывает что используется метод GET HTTP запроса, используемый в xajax

XAJAX_POST int (по умолчанию 1)
Метод запроса используемый в xajax HTTP POST

2.Методы Объекта
xajax (string $sRequestURL="", string $sWrapperPrefix="xajax_", string $sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, boolean $bDebug=false)
Конструктор. Вы можете сразу установить нужные вам значения в конструкторе или же после посредством методов.
Параметры:

$sRequestURL – тип string по умолчанию текущий URL браузера;
$sWrapperPrefix – тип string по умолчанию "xajax_";
$sEncoding – тип string по умолчанию равно глобальной константе; XAJAX_DEFAULT_CHAR_ENCODING, которая описана выше

$bDebug Mode тип boolean – по умолчанию false

setRequestURI (string $sRequestURL)
Устанавливает URI к которому будет сделан запрос.
Параметры:

$sRequestURL это URL (м.б. абсолютным или относительным) в PHP скрипта, который должен быть запрошен объектом xajax
Применение:
$xajax->setRequestURL
("http://www.site.ru");
Метод : debugOn ()
Установить вывод отладочных сообщений (Javascript alerts) для запроса xajax.

Метод : debugOff ()
Скрыть вывод отладочных сообщений (Javascript alerts) для запроса xajax (установлено по умолчанию).

Метод : statusMessagesOn ()
Включает вывод сообщений в строку состояния браузера xajax.

Метод : statusMessagesOff ()
Отключает вывод сообщений в строку состояния браузера xajax (установлено по умолчанию).

Метод :
waitCursorOn ()
Включает ожидание показа курсора браузером (установлено по умолчанию).

Метод :
waitCursorOff ()
Отключает ожидание показа курсора браузером.

Метод : exitAllowedOn ()
Включает прерывание процесса xajax после того как запрос был выслан и ответ был получен браузером (установлено по умолчанию).

Метод : exitAllowedOff ()
Отключает прерывание процесса xajax после того как запрос был выслан и ответ был получен браузером

Метод : errorHandlerOn ()
Включает обработку ошибок системой после того как произошла ошибка в ходе приема запроса и отправки ответа сервером. (Javascript alert.)

Метод : errorHandlerOff ()
Отключает обработку полученных ошибок xajax - ом (установлено по умолчанию).

Метод :
setLogFile (string $sFilename)
Определяет логфайл, в который будет записана ошибки при исполнении запроса xajax . Если вы не вызываете этот метод, то логфайл писаться не будет.
Применение:

$xajax->setLogFile("/xajax_logs/errors.log");
Метод : setWrapperPrefix ($sPrefix)
Устанавливает префикс который будет добавлен к функциям Javascript`а (по умолчанию "xajax_").

Метод :
setCharEncoding (string $sEncoding)
Устанавливает кодировку для вывода HTML основанный на переменной $sEncoding, которая является строкой содержащий набор сиволов, определяющих кодировку. Обычно вы не нуждаетесь в применении этого метода, т.к. кодировка устанавливается автоматически, на основе глобальной константы XAJAX_DEFAULT_CHAR_ENCODING.
Применение:

$xajax->setCharEncoding("windows-1251");
// или:
$xajax->setCharEncoding("utf-8");
// и т.д.

Метод : registerFunction (mixed $mFunction, string $sRequestType=XAJAX_POST)
Регистрация PHP функции или метода для того чтобы она могла быть вызвана через xajax в вашем Javascript`е. Если вы хотите зарегистрировать статический метод, введите следующий массив.

array("myFunctionName", "myClass", "myMethod")


Для метода экземпляров класса, используйте объектныю переменную в качестве второго аргумента (В РНР4 проверьте что перед переменной поставлен знак &)

Замечание: имя функции, которую вы вызываете через Javascript, называйте так чтобы она имела уникальное имя и не конфликтовала с другими функциями.

$mFunction это строка, содержащая имя функции или вызываемый массив объектов

$sRequestType Тип запроса (XAJAX_GET/XAJAX_POST) который будет использоваться функцией. По умолчанию XAJAX_POST.
Применение:

$xajax->registerFunction("myFunction");
// или:
$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));


Метод : registerExternalFunction (mixed $mFunction, string $sIncludeFile, string $sRequestType=XAJAX_POST)
Зарегистрировать PHP функцию, которая может вызываться из xajax и расположена в другом файле. Если функция запрошена внешний файл будет включен в описание, перед тем как будет вызвана функция.


$mFunction строка, содержащая имя функции или вызываемый массив объектов (см. registerFunction() для более полной информации по вызываемому массиву объектов)

$sIncludeFile строка содержащая путь и имя включаемого файла

$sRequestType Тип запроса (XAJAX_GET/XAJAX_POST) использованный для этой функции. По умолчаню XAJAX_POST.
Применение:

$xajax->registerExternalFunction("myFunction", "myFunction.inc.php", XAJAX_POST);


Метод :
registerCatchAllFunction (mixed $mFunction)
Регистрирует функцию PHP которая будет вызвана если xajax не может найти функцию вызываемую посредством Javascript. Потому что это технически невозможно когда используются функции «оболочки», метод действует только когда вызывается напрямую метод Javascript xajax.call(). Используйте эту возможность для обработки неописанных ситуации. $mFunction строка содержащая имя функции или вызываемый массив объектов (см. registerFunction() для более полной информации по вызываемому массиву объектов)
Применение:

$xajax->registerCatchAllFunction("myCatchAllFunction");


Метод :
registerPreFunction (mixed $mFunction)
Регистрирует функцию PHP для исполнения перед тем как xajax исполнит запрашиваемую функцию. xajax будет автоматически добавлять запрос функции на возвращенный ответ «предфункции» для того чтобы собрать из них один ответ. Другая возможность это не ждать ответа, но будет возвращатся массив, первый элемент где первый элемент является false (boolean) и второй является ответом. В этом случае ответ от «предфункции» будет возвращен в браузер без вызова функции запрошенной xajax.

$mFunction строка содержащая имя функции или вызываемый массив объектов (см. registerFunction() для более полной информации по вызываемому массиву объектов)
Применение:

$xajax->registerPreFunction("myPreFunction");


Метод :
canProcessRequests ()
Возвращает true если xajax может обработать запрос, иначе false. Вы можете использовать это для того чтобы узнать прошел запрос или нет.

Метод : getRequestMode ()
Возвращает текущий вид (XAJAX_GET или XAJAX_POST), или -1 если не определен.

Метод :
processRequests ()
Это основной движок для коммуникации в xajax. Движок обрабатывает все входящие запросы xajax, вызывает соответствующие РНР функции (или методы class/object) и выводит XML ответы назад в Javascript обработчик ответов. Если ваш запрашиваемый URI отличается от URI вашей страницы то это функция должна быть вызвана перед выводом заголовков или HTML.

Метод :
printJavascript (string $sJsURI="", string $sJsFile=NULL, string $sJsFullFilename=NULL)
xajax печатает Javascript и код в вашу страницу, который является результатом вывода метода getJavascript(). Он вызывается только между тегами в вашей HTML странице. Помните, если вы хотите получить только результат этой используйте другой метод - getJavascript().

$sJsURI относительный адрес папки где установлен xajax. Для PHP файла находящегося в "http://www.myserver.com/myfolder/mypage.php" и xajax, который был установлен в "http://www.myserver.com/anotherfolder",

$sJsURI имеет значение "/anotherfolder". По умолчанию предпологается что xajax находится в той же папке что и ваш PHP файл.

$sJsFile относительный путь к папке/файлам движка xajax Javascript, расположенного в инсталляционной папке. По умолчанию xajax_js/xajax.js.

$sJsFullFilename может быть установлен абсолютный путь к файлу xajax.js. Этот аргумент нужно использовать, только если вы переместили папку xajax_js .
Применение:
...

printJavascript(); ?>

.. 
Метод : getJavascript (string $sJsURI="", string $sJsFile=NULL, string $sJsFullFilename=NULL)
Возвращает код xajax javascript, который должен быть добавлен в вашу HTML страницу между тегами . Аргументы функции такие же как и в методе printJavascript().
Применение:

getJavascript(); ?>

...
Останнє оновлення ( Середа, 12 вересня 2007, 08:19 )
 

Відвідування

mod_vvisit_countermod_vvisit_countermod_vvisit_countermod_vvisit_countermod_vvisit_countermod_vvisit_counter
mod_vvisit_counterСьогодні75
mod_vvisit_counterВчора187
mod_vvisit_counterЗа цей тиждень697
mod_vvisit_counterЗа минулий тиждень1438
mod_vvisit_counterЦього місяця4051
mod_vvisit_counterПопереднього місяця7601
mod_vvisit_counterВсього641899

Кількість користувачів: 4
Ваш IP: 54.236.234.60
,
Сьогодні: груд. 19, 2018