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

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== RSForm ======
работа с компонентом RSForm


===== Расположение =====
''media/com_rsform/js/script.js''


===== Методы =====
==== init ====
rsform.**init**.call(//context//)

Инициализирует формы внутри контейнера

^аргумент^Описание^Тип^По-умолчанию^
|context|Родительский элемент для инициализации форм|объект JQuery| |
^Возвращает|null|null| |


===== События =====
События привязываются с помощью метода ''on'', библиотеки JQuery.


==== rsform_done ====
//context//.on('**rsform_done**.//form_id//', //handler//)

//context//.on('**rsform_done**', //handler//)

Событие возникающее при ответе об успешном отправке формы rsform

^Аргумент^Описание^Тип^По-умолчанию^
|context|объект JQuery(document)|объект JQuery(document) обязательный| |
|form_id|id формы, если не указано - любая форма|int обязательный|
|handler|Функция обработчик|function обязательный| |

=== функция handler ===
function(//task//,//request//)

^Аргумент^Описание^Тип^
|this|объект JQuery(document)|объект JQuery(document)|
|form_id|id формы|int|
|request|Данные запроса|object|
|response|Данные ответа|object|

<code javascript>
$(document).on('rsform_done.2',function(form_id,request,response){
   console.log(form_id); //id формы
   console.log(request); //данные запроса к серверу
   console.log(response); //данные ответа от сервера
});
</code>

==== rsform_invalid ====
//context//.on('**rsform_invalid**.//form_id//', //handler//)

//context//.on('**rsform_invalid**', //handler//)

Событие возникающее при ошибке валидации формы rsform

^Аргумент^Описание^Тип^По-умолчанию^
|context|объект JQuery(document)|объект JQuery(document) обязательный| |
|form_id|id формы, если не указано - любая форма|int обязательный|
|handler|Функция обработчик|function обязательный| |

=== функция handler ===
function(//task//,//request//)

^Аргумент^Описание^Тип^
|this|объект JQuery(document)|объект JQuery(document)|
|form_id|id формы|int|
|request|Данные запроса|object|
|response|Данные ответа|object|

<code javascript>
$(document).on('rsform_invalid.2',function(form_id,request,response){
   console.log(form_id); //id формы
   console.log(request); //данные запроса к серверу
   console.log(response); //данные ответа от сервера
});
</code>

==== rsform_request ====
//context//.on('**rsform_request**.//form_id//', //handler//)

//context//.on('**rsform_request**', //handler//)

Событие возникающее при отправке данных на сервер c помощью rsform

^Аргумент^Описание^Тип^По-умолчанию^
|context|объект JQuery(document)|объект JQuery(document) обязательный| |
|form_id|id формы, если не указано - любая форма|int обязательный|
|handler|Функция обработчик|function обязательный| |

=== функция handler ===
function(//task//,//request//)

^Аргумент^Описание^Тип^
|this|объект JQuery(document)|объект JQuery(document)|
|form_id|id формы|int|
|request|Данные запроса|object|

<code javascript>
//событие возникает при отправке формы с id 2
$(document).on('rsform_request.2',function(form_id,request){
   console.log(form_id); //id формы
   console.log(request); //запрос к серверу
});
</code>

==== rsform_show ====
//context//.on('**rsform_show**.//form_id//', //handler//)

//context//.on('**rsform_show**', //handler//)

Событие возникающее при получении формы rsform

^Аргумент^Описание^Тип^По-умолчанию^
|context|объект JQuery(document)|объект JQuery(document) обязательный| |
|form_id|id формы, если не указано - любая форма|int обязательный|
|handler|Функция обработчик|function обязательный| |

=== функция handler ===
function(//task//,//request//)

^Аргумент^Описание^Тип^
|this|объект JQuery(document)|объект JQuery(document)|
|form_id|id формы|int|
|request|Данные запроса|object|
|response|Данные ответа|object|

<code javascript>
$(document).on('rsform_show.2',function(form_id,request,response){
   console.log(form_id); //id формы
   console.log(request); //данные запроса к серверу
   console.log(response); //данные ответа от сервера
});
</code>
Документация

Инструменты пользователя

Инструменты сайта

Инструменты страницы
